Contains projects associated to the development of modeling products
Find a file
Khalim Conn-Kowlessar 1b3bbbf783 Slice S0380.88: full Table 4e dispatch + strict-raise on unmapped control codes
SAP 10.2 Table 4e (PDF p.171-174) "Heating system controls" — 8 groups
covering boiler / HP / heat-network / electric-storage / warm-air /
room-heater / other systems, ~40 codes total. Pre-S0380.88 the cascade
dispatch dict had spotty coverage:

  - Group 1 (BOILER): partial (12 of 13 codes)
  - Group 2 (HEAT PUMP): added in S0380.87 (10 codes)
  - Groups 3, 4, 5, 6, 7: completely missing

Codes from missing groups silently defaulted to type 2 — the same
failure mode that hid the cert 000565 2207→type-3 bug for ~22 slices
until S0380.87 surfaced it. Per the user-requested strict-raise
philosophy ("we keep debugging silent fallbacks"), this slice
forecloses the pattern at the dispatch boundary.

Corpus audit (full JSON sweep) at HEAD c0328f4e:

    2103, 2104, 2106, 2110, 2113  (Group 1 — covered)
    2206, 2207                    (Group 2 — covered after S0380.87)
    2307                          (Group 3 — silently mis-classified)
    2401                          (Group 4 — silently mis-classified)
    2603                          (Group 6 — silently mis-classified)

Three corpus codes (2307, 2401, 2603) were silently routed to type 2
when their spec types are 2 / 3 / 3 respectively.

Fix:

  - `_CONTROL_TYPE_BY_CODE` extended to full Table 4e coverage
    (Groups 0-7), with per-group spec citation in comments
  - New `UnmappedSapCode(ValueError)` exception class mirroring the
    `UnmappedApiCode` / `UnmappedElmhurstLabel` mapper-side pattern
    per [[reference-unmapped-api-code]]
  - `_control_type` flipped to strict-raise: lodging absent (None /
    0 / "") returns modal type 2 default; lodging present but
    unmapped raises `UnmappedSapCode("main_heating_control", code)`

The strict / not-strict distinction is principled: cascade-helper
value defaults (u_wall, u_floor, ...) stay total per RdSAP §6.2.3
"assume as-built if no evidence". Code-dispatch sites strict-raise
because an unmapped code means the spec table coverage is incomplete
— a forcing function for spec-completion slices rather than a
silent miscalculation.

Tests (3 new, AAA-structure):

  - `test_main_heating_control_code_table_4e_full_coverage_groups_0_through_7`
    pins ~20 codes across Groups 3-7 to their spec-correct control
    types (Table 4e PDF p.171-174 verbatim)
  - `test_cert_to_inputs_raises_unmapped_sap_code_on_unknown_main_heating_control`
    pins the strict-raise contract: lodging present but unmapped
    (e.g. test code 2998) raises `UnmappedSapCode` with the field
    name + value attached
  - `test_cert_to_inputs_does_not_raise_when_main_heating_control_is_missing`
    pins the absent-lodging contract: None / "" / 0 returns modal
    type 2 default — same behaviour as pre-S0380.88 for legitimately
    missing data

Test baseline: 564 pass (was 561 + 3 new) + 9 expected
`test_sap_result_pin[000565-*]` fails unchanged. Cohort + golden +
cert 9501 unaffected (their codes were all already covered or
silently routed to type 2 which is now explicit).

Pyright net-zero per touched file. The new `not code` absent-
lodging check replaces the original `code is None or code == "" or
code == 0` triple-check (pyright flagged `is None` as redundant given
`main_heating_control: Union[int, str]` annotation; runtime data
exhibits None / "" on Main 2 records that lack space-heating
controls — cert 000565 Main 2 is one such case).

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-30 09:12:25 +00:00
.devcontainer added 0.0.7 2026-05-13 16:04:53 +00:00
.github/workflows undo postcodesplitter changes 2026-05-21 10:12:08 +00:00
.idea scaffolding for ml pipeline 2026-05-16 14:15:56 +00:00
.vscode added utils to allow easier subtask management 2026-03-02 15:15:39 +00:00
applications local run changes 2026-05-21 10:37:13 +00:00
asset_list redeploy old postcode splitter 2026-05-21 09:46:47 +00:00
backend Slice S0380.86: §5.6 thin-wall stone + §5.8 dry-line closes BP[0] alt1 cascade gap 2026-05-30 08:37:46 +00:00
backlog implemented onboarding 2026-04-21 20:23:33 +00:00
datatypes Slice S0380.86: §5.6 thin-wall stone + §5.8 dry-line closes BP[0] alt1 cascade gap 2026-05-30 08:37:46 +00:00
deployment/terraform undo postcodesplitter changes 2026-05-21 10:12:08 +00:00
docs/adr refactor: move docs/sap-spec/ contents into domain/sap10_calculator/ 2026-05-26 13:17:18 +00:00
domain Slice S0380.88: full Table 4e dispatch + strict-raise on unmapped control codes 2026-05-30 09:12:25 +00:00
epr_data_exports allowing carbon and energy otimisation by removing slack 2025-07-31 19:13:16 +01:00
etl scaffolding for ml pipeline 2026-05-16 14:15:56 +00:00
infrastructure some excel files are formatted differently 2026-05-20 17:36:20 +00:00
model_data/requirements its working the way khalim wanted wiht postcode and then search that 2026-01-22 15:17:13 +00:00
orchestration get rid of comments 2026-05-20 13:21:11 +00:00
recommendations save 2026-05-07 15:55:44 +00:00
repositories tests framework completed 2026-05-20 14:00:19 +00:00
scripts Slice S0380.39: bulk-fetch 38 cohort-2 EPC API JSONs for cross-mapper parity 2026-05-28 16:40:58 +00:00
sfr/principal_pitch added added historic epc data class with shape 2026-05-08 12:03:35 +00:00
survey_report quidos site notes extraction 2025-02-18 19:49:29 +00:00
tests tests framework completed 2026-05-20 14:00:19 +00:00
utilities get rid of comments 2026-05-20 13:21:11 +00:00
utils rename files in sharepoint to desired structure 2026-05-20 16:26:07 +00:00
.coveragerc fixed unit tests 2023-10-05 16:04:12 +01:00
.dockerignore deployment from infrastructure 2026-05-19 12:55:30 +00:00
.gitignore fixed merge conflicts from main 2026-05-26 11:21:09 +00:00
__init__.py added checking for directory before creation and made some minor style changes 2023-08-25 15:21:17 +01:00
ara_backend_design.md refactor: lift-and-shift packages/domain/src/domain/ml → domain/sap10_ml 2026-05-26 13:01:35 +00:00
BaseUtility.py fixed missing task and subtask for single remote assessments 2025-11-27 17:50:26 +00:00
CLAUDE.md fixed merge conflicts from main 2026-05-26 11:21:09 +00:00
conftest.py working on integrating new EPC api into address2UPRN 2026-04-27 11:32:44 +00:00
CONTEXT.md refactor: lift-and-shift packages/domain/src/domain/ml → domain/sap10_ml 2026-05-26 13:01:35 +00:00
devcontainer.sh add dev container 2026-04-17 14:50:57 +00:00
Dockerfile.test fix: address 22 project-wide test failures from previous sweep 2026-05-26 13:34:51 +00:00
Dockerfile.test.dockerignore deployment from infrastructure 2026-05-19 12:55:30 +00:00
Makefile adding to dev container to create shared network on start up 2026-04-25 15:03:07 +00:00
MEMORY.md memory 2026-04-02 10:24:31 +00:00
package-lock.json restructuring openUrpn code 2023-07-20 11:41:43 +01:00
package.json restructuring openUrpn code 2023-07-20 11:41:43 +01:00
pyproject.toml slice 14a: ml_training_data pkg + sample.py (CSV filter + random sample) 2026-05-16 17:39:43 +00:00
pyrightconfig.json slice 14d: build_features wires bulk reader -> mapper -> EpcMlTransform 2026-05-16 18:38:41 +00:00
pytest.ini refactor: lift-and-shift packages/domain/src/domain/ml → domain/sap10_ml 2026-05-26 13:01:35 +00:00
README.md adding to dev container to create shared network on start up 2026-04-25 15:03:07 +00:00
run_lambda_local.sh debugging local lambda run and updating the sap point checking condition 2023-09-13 18:47:12 +01:00
serverless.yml added logic to add to serverless 2026-04-22 12:39:44 +00:00
test.requirements.txt infrastructure: typed S3/SQS clients (S3Client, CsvS3Client, SqsClient, Address2UprnQueueClient) 2026-05-19 17:12:21 +00:00
tox.ini removing playright install for integration test 2026-04-30 20:08:13 +00:00
UBIQUITOUS_LANGUAGE.md postcode_splitter: pure domain (UserAddress, sanitise_postcode, postcode_batching) 2026-05-19 16:45:47 +00:00

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