37 lines
1.1 KiB
Markdown
37 lines
1.1 KiB
Markdown
# remodel-engine
|
|
|
|
UI-agnostic Python calculation library for hybrid RE (Solar + Wind + BESS) project finance.
|
|
|
|
## Setup
|
|
|
|
```bash
|
|
poetry install
|
|
```
|
|
|
|
## Common commands
|
|
|
|
```bash
|
|
poetry run pytest # run tests with coverage
|
|
poetry run ruff check . # lint
|
|
poetry run mypy src/ # type-check
|
|
poetry run remodel --help # CLI (after implementation)
|
|
```
|
|
|
|
## Package layout
|
|
|
|
```
|
|
src/remodel_engine/
|
|
├── schemas/ Pydantic models (single source of truth)
|
|
├── catalog/ Default values, CostItem catalog, profiles
|
|
├── generation/ solar.py, wind.py, bess_state.py
|
|
├── dispatch/ hybrid_rtc.py, mcp_settlement.py
|
|
├── commercial/ ppa.py, dsm.py, charges.py, losses.py
|
|
├── capex/ cost_items.py, phasing.py, idc.py
|
|
├── financial/ pnl.py, cfs.py, bs.py, depreciation.py, tax.py
|
|
├── debt/ sizing.py, sculpting.py, schedule.py, compliance.py
|
|
├── irr/ metrics.py
|
|
├── solver/ tariff.py
|
|
├── scenarios/ runner.py, sweep.py
|
|
├── io/ parquet_io.py, excel_export.py
|
|
└── cli.py
|
|
```
|