How songalobung/parity works
Parity is a command-line and Python toolkit for estimating frontier-market FX risk and translating local-currency deal cash flows into hard-currency return distributions. The main workflow loads deal and macro inputs, builds risk features, estimates devaluation hazard, simulates FX paths, applies repatriation and cash-flow frictions, and reports returns; scenario comparisons and hedging are additional analytical branches. Internal links reflect the sampled excerpts and SOURCE INDEX; documented pipeline links cite the README, and no unsampled implementation details are assumed.
Main entry points: fxpaths.py FX path simulator · loaders.py Data loaders · devaluation.py Devaluation hazard · cli.py Parity CLI
Components 15
Inputs and validation
- Input schemas
src/parity/schemas.py - Data loaders
src/parity/loaders.py
FX risk modeling
- Macro features
src/parity/features.py - Devaluation hazard
src/parity/devaluation.py - Jump magnitude
src/parity/magnitude.py - FX path simulator
src/parity/fxpaths.py
Deal analytics
- Deal conversion
src/parity/deal.py - Hedging analytics
src/parity/hedging.py - Scenario switchboard
src/parity/scenarios.py
User interface and reports
- Parity CLI
src/parity/cli.py - IC reports
src/parity/report.py
Other components
- Analyst
- Deal and market data
- Model priors
config/priors.yaml - Scenario definitions
config/scenarios.yaml
Connections 17
- Analyst → Parity CLI: runs analyses
README.md - Deal and market data → Data loaders: loads inputs
README.md - Data loaders → Input schemas: validates against
src/parity/loaders.py - Data loaders → Macro features: supplies panel
README.md - Model priors → Devaluation hazard: sets coefficients
src/parity/devaluation.py - Macro features → Devaluation hazard: provides predictors
README.md - Devaluation hazard → FX path simulator: sets hazard
src/parity/fxpaths.py - Jump magnitude → FX path simulator: sets jump sizes
src/parity/fxpaths.py - Model priors → FX path simulator: sets simulation defaults
src/parity/fxpaths.py - FX path simulator → Deal conversion: provides FX paths
src/parity/deal.py - Scenario definitions → Scenario switchboard: configures scenarios
README.md - Scenario switchboard → FX path simulator: runs simulations
src/parity/scenarios.py - Deal conversion → Hedging analytics: compares hedged returns
README.md - Deal and market data → Hedging analytics: may include forwards
README.md - Analyst → Parity CLI: requests reports
README.md - Parity CLI → IC reports: generates deliverables
README.md - IC reports → Analyst: delivers return analysis
README.md