1ac22f3a58
Documents deleted (pre-implementation or superseded): - `docs/sap-spec/CALCULATOR_DESIGN_SKETCH.md` — pre-implementation design sketch referencing SAP 10.3 PDF. Status field said "sketch only — not implemented" but the calculator IS implemented and the active spec target is SAP 10.2 per ADR-0010. Served its purpose. - `docs/sap-spec/HANDOVER_SECTION_6.md` — §6 handover from when §6 was being built. §6 is now Full (per closed cascade pins). Superseded by HANDOVER_NEXT.md. - `docs/sap-spec/PARITY_FINDINGS.md` — log of MAE/RMSE measurements against 100-cert sample. The project has since moved to strict abs=1e-4 per-line-ref pins on 6 deterministic test vectors; MAE/ RMSE on a random sample doesn't carry information value any more. Superseded by the cascade pin scoreboard in HANDOVER_NEXT.md. - `docs/sap-spec/SPEC_COVERAGE.md` — coverage map with status table per-section. Stale: said §3 "Full (non-RR)" but RR detailed is implemented; said §4 "Table 3c pending" but Table 3c landed in slices 6-7; said §14 CO2/primary energy partial — current state lives in HANDOVER_NEXT.md cascade pin scoreboard. Maintenance burden of keeping a static status table in sync with reality made it net-negative. `packages/domain/src/domain/sap/README.md` updates: - Spec reference repointed to SAP 10.2 (14-03-2025) per ADR-0010 (was sap-10-3-full-specification-2026-01-13.pdf). - Added validation contract section pointing to test_section_ cascade_pins.py + test_e2e_elmhurst_sap_score.py with the abs=1e-4 rule. - Window lodgement section: documented per-window u_value path (slice 22) instead of legacy single-avg-U. - §3 "currently only checks invariants" claim removed — all four §3 aggregates pinned at abs=1e-4. - Room-in-roof "one big known gap" claim removed — §3.10 detailed surfaces implemented across slices 13/16/23. U=0.86 external gable variant flagged as the remaining open item. - "Worksheet lines to capture" guidance points at the cascade pin approach + capturing every line through §12. Also added §A.4 to HANDOVER_NEXT.md: the user prefers the fixture × line-ref matrix format for scoreboard reporting (with ✓ for within abs=1e-4 or numeric Δ for finer granularity). Following sections renumbered A.5/A.6. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> |
||
|---|---|---|
| .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