411c477d09
Closes the second half of P5 (HANDOVER_SYSTEMATIC_REVIEW §2.5): - Adds test_bre_worked_examples.py — one comprehensive test that locks every published SapResult.intermediate key against its SAP 10.2 worksheet item number ((4) TFA, (33) fabric heat loss, (39) HTC, (40) HLP, (73) gains, (93) mean internal temp, (98c) space heating, (240e/247/250) costs, (252) PV credit, (256) deflator, (257) ECF, (261-272) per-end-use CO2, (275-287) primary energy per m²). All formulas derived independently from the worksheet pages 131-148; passes against the synthetic 100 m² baseline. - Explicit caveat in module docstring: BRE-published worked examples don't exist in any of the three SAP-spec PDFs we have (rdSAP10, SAP10.2, SAP10.3 — all greppped). The test is spec-formula-derived, not BRE-validated. Structure stays if BRE numbers surface later; only expected values change. Also surfaces and documents an RdSAP10 spec drift in PARITY_FINDINGS.md: Table 32 (page 95 of rdSAP10) gives Energy Cost Deflator = 0.42, vs the code's 0.36 (SAP10.2 Table 12, worksheet item (256)). Not changed in P5 — needs ADR-level resolution on whether the calculator targets SAP10.2 (0.36) or RdSAP10 (0.42) ratings. P5 (SapResult.intermediate population + BRE worked-example fixtures) is now complete on this branch. |
||
|---|---|---|
| .devcontainer | ||
| .github/workflows | ||
| .idea | ||
| .vscode | ||
| asset_list | ||
| backend | ||
| backlog | ||
| datatypes | ||
| docs | ||
| epr_data_exports | ||
| etl | ||
| infrastructure/terraform | ||
| model_data/requirements | ||
| packages | ||
| recommendations | ||
| scripts | ||
| services | ||
| sfr/principal_pitch | ||
| survey_report | ||
| utils | ||
| .coveragerc | ||
| .dockerignore | ||
| .gitignore | ||
| __init__.py | ||
| AGENTS.md | ||
| ara_backend_design.md | ||
| BaseUtility.py | ||
| CLAUDE.md | ||
| conftest.py | ||
| CONTEXT.md | ||
| devcontainer.sh | ||
| Dockerfile.test | ||
| Dockerfile.test.dockerignore | ||
| Makefile | ||
| MEMORY.md | ||
| package-lock.json | ||
| package.json | ||
| pyproject.toml | ||
| pyrightconfig.json | ||
| pytest.ini | ||
| README.md | ||
| run_backlog.sh | ||
| run_lambda_local.sh | ||
| serverless.yml | ||
| test.requirements.txt | ||
| tox.ini | ||
| UBIQUITOUS_LANGUAGE.md | ||
Model Repository
This repository contains the code pertaining to the development of the data science and machine learning products being utilised by Hestia.
The different folders in this repository relate to services that can be used independently, or can be imported and used as part of a larger application
Getting Started
Prerequisites
Dev Container Setup
This repo uses a Docker Compose-based dev container. The model-backend service joins a shared-dev Docker network so it can communicate with other local services (e.g. a frontend container) running on your machine.
VS Code users: The initializeCommand in devcontainer.json creates the shared-dev network automatically before the container starts. No manual step required — just open the repo and select Reopen in Container.
Non-VS Code / CI workflows: Run the following once before starting the container:
make dev-setup
This is idempotent and safe to re-run if the network already exists.
Folders
backend/
This folder contains the code for the fastapi backend service, which provides an interface to much of the functionality in this repository, for the frontend
model_data/
This folder contains related to the reading and preparation of assessment model data, including pulling out epc attributes
Testing
All tests can be run, against the configuration in pytest.ini running
pytest
This will run the complete panel of tests and report on coverage in the locations specified by the pytest.ini file.
To run tests in a specific service, e.g. inside of model_data, simply run
pytest --cov-config=model_data/.coveragerc --cov=model_data
This will produce the test results and coverage reports