Skip to content

Model Building

Prerequisites

  • Python 3.11+
  • pip

Installation

  1. Clone the repository: 

    git clone https://github.com/ovesorg/emob-financial-models.git
cd emob-financial-models

  2. Install Python dependencies: 

    pip install -r requirements.txt

Preferred Workflow

Start with model and analysis work, not spreadsheet editing:

  1. Read the Models overview for the modeling doctrine.
  2. Read the Analysis overview for the analysis scope.
  3. Treat workbook generation as optional output, not as the primary workflow.
  4. See the Toolchain Refactor Plan for the target architecture.

Building Documentation

# Clean rebuild
python -m mkdocs build --clean

# Serve locally
python -m mkdocs serve

Visit http://127.0.0.1:8000 to view the documentation.

Legacy Excel Utilities

Phase 1: Iterative Data Transformation

These utilities are legacy transitional tools and should not be treated as the main modeling workflow.

Use scripts/transform_data.py only when workbook-level edits are specifically needed: 

python scripts/transform_data.py input.xlsx output.xlsx --sheet Data

Phase 2: Generate Pretty Reports

Use scripts/generate_report.py only when a workbook-based report is specifically required: 

python scripts/generate_report.py data.xlsx report.xlsx

Next Steps