E-Mobility Financial Models¶
Welcome to the E-Mobility Financial Models repository. This project provides financial modeling and analysis tools for e-mobility subscription services.
Overview¶
This repository contains: - Python-first financial model logic as the source of truth - English-first model documentation and analysis reports during development - Excel outputs for viewing and stakeholder handoff (not primary calculation engine) - An analysis-first methodology for understanding both ecosystem economics and participant-level profitability pools
Quick Start¶
-
Install dependencies:
pip install -r requirements.txt -
Build documentation:
python -m mkdocs build --clean python -m mkdocs serve -
Run and test model logic:
pytest models/tests/ -
Generate optional Excel output artifacts:
python scripts/transform_data.py input.xlsx output.xlsx python scripts/generate_report.py data.xlsx report.xlsx
Project Structure¶
emob-financial-models/
|-- data/ # Input data files (gitignored for large files)
|-- docs/ # English model docs and reports
|-- models/ # Python model logic (source of truth)
|-- reports/ # Generated reports
|-- scripts/ # Utilities and artifact generation tools
`-- requirements.txt # Python dependencies
Documentation¶
Full documentation is available at ovesorg.github.io/emob-financial-models
Start Here¶
Small notes: progressive architecture decisions are tracked in Architecture Decision Records; stable lookup material lives under Reference.