How songalobung/covenant works
Covenant is a country-agnostic sovereign credit risk and restructuring engine, exposed through a CLI and Python package. Users supply country, creditor, debt, and event data plus a scenario; the runtime validates and loads inputs, constructs features, estimates distress, haircut, and resolution outcomes, simulates losses and bond values, and produces Markdown or Excel reports. The graph preserves the README’s modeling and reporting capabilities; some CLI-to-model wiring is documented, while unsampled implementation details are not inferred.
Main entry points: cli.py Covenant CLI · simulate.py Monte Carlo engine · distress.py Distress model · loaders.py Data loaders
Components 13
Data inputs
- Data schemas
src/sovdistress/schemas.py - Data loaders
src/sovdistress/loaders.py - Model priors
config/priors.yaml
Risk models
- Feature engineering
src/sovdistress/features.py - Distress model
src/sovdistress/distress.py - Haircut model
src/sovdistress/haircut.py - Resolution model
src/sovdistress/resolution.py
Simulation
- Monte Carlo engine
src/sovdistress/simulate.py - Scenario analysis
src/sovdistress/simulate.py
Reporting
- Markdown reports
src/sovdistress/report.py - Excel reports
src/sovdistress/excel_report.py
Other components
- Analyst
- Covenant CLI
src/sovdistress/cli.py
Connections 18
- Analyst → Covenant CLI: runs commands
README.md - Covenant CLI → Data loaders: loads datasets
src/sovdistress/cli.py - Data loaders → Data schemas: validates data
src/sovdistress/loaders.py - Covenant CLI → Feature engineering: builds features
src/sovdistress/cli.py - Distress model → Feature engineering: fits from
src/sovdistress/distress.py - Covenant CLI → Distress model: scores risk
src/sovdistress/cli.py - Covenant CLI → Haircut model: estimates loss
README.md - Covenant CLI → Resolution model: estimates duration
README.md - Monte Carlo engine → Distress model: samples probability
src/sovdistress/simulate.py - Monte Carlo engine → Haircut model: samples haircuts
src/sovdistress/simulate.py - Monte Carlo engine → Resolution model: samples duration
src/sovdistress/simulate.py - Covenant CLI → Monte Carlo engine: runs simulation
src/sovdistress/cli.py - Scenario analysis → Monte Carlo engine: simulates cases
src/sovdistress/simulate.py - Covenant CLI → Scenario analysis: compares scenarios
src/sovdistress/cli.py - Covenant CLI → Markdown reports: generates report
src/sovdistress/cli.py - Covenant CLI → Excel reports: exports workbook
README.md - Monte Carlo engine → Markdown reports: provides metrics
- Monte Carlo engine → Excel reports: provides metrics