diff --git a/CHANGELOG.md b/CHANGELOG.md index 7c18150..d1b3361 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ All notable changes to this project are documented in this file. ## [Unreleased] ### Added +- Docs and AI skill note that mechanical requirements (`requirementAnswer`) are not supported and must be filled out on COMcheck Web - Renewable energy operations module (`project_renewable_operations`) for managing on-site renewable systems and off-site procurement - `set_renewable_exception_in_project` — set the renewable exception on a project - `update_renewable_in_project` — update scalar fields on the renewable singleton diff --git a/comcheck_api/ai/skill/SKILL.md b/comcheck_api/ai/skill/SKILL.md index 960e233..0a01f94 100644 --- a/comcheck_api/ai/skill/SKILL.md +++ b/comcheck_api/ai/skill/SKILL.md @@ -508,6 +508,12 @@ a fan system if it's empty or already used. You cannot update `fanSystemKey` directly — use `assign_fan_system_to_hvac_system` or `remove_fan_system_from_project` (which clears `fanSystemKey` on referencing HVAC systems). +**Mechanical requirements**: not supported by this package. `requirementAnswer` +on HVAC systems, fan systems, plants, and water heaters can't be set through the +update operations. Tell the user to save the project and fill out the mechanical +requirements on [COMcheck Web](https://comcheck.energycode.pnl.gov/). Don't try +to work around this. + ### Adding energy credits Energy credits apply to IECC 2021+, ASHRAE 90.1-2022, and state codes diff --git a/comcheck_api/ai/skill/reference/operations.md b/comcheck_api/ai/skill/reference/operations.md index fdd313b..fd957d5 100644 --- a/comcheck_api/ai/skill/reference/operations.md +++ b/comcheck_api/ai/skill/reference/operations.md @@ -187,6 +187,11 @@ Mechanical operations manage HVAC systems, fan systems, HVAC plants, and service water heating. The `hvac` singleton can be `MISSING` and is created automatically on add. `swhSystem[]` is a top-level list (not under `hvac`). +Mechanical requirements (`requirementAnswer` on HVAC systems, fan systems, +plants, and water heaters) are not supported by this package. Save the project, +then open it on [COMcheck Web](https://comcheck.energycode.pnl.gov/) to fill +them out. + | Function | Purpose | |---|---| | **HVAC systems** (`hvac.hvacSystem[]`) | | diff --git a/comcheck_api/project_operations/project_mechanical_operations.py b/comcheck_api/project_operations/project_mechanical_operations.py index 287084f..e24703b 100644 --- a/comcheck_api/project_operations/project_mechanical_operations.py +++ b/comcheck_api/project_operations/project_mechanical_operations.py @@ -21,6 +21,13 @@ ``HVACSystem.fanSystemKey``. Use ``assign_fan_system_to_hvac_system`` to create this link by description; callers never handle the UUID directly. +Mechanical requirements +----------------------- +Mechanical requirements (``requirementAnswer`` on HVAC systems, fan systems, +plants, and water heaters) are not supported by this package. Save the project, +then open it on COMcheck Web (https://comcheck.energycode.pnl.gov/) to fill +them out. + Energy codes ------------ Mechanical operations don't check ``control.code`` — which mechanical components diff --git a/docs_site/api/operations/mechanical.md b/docs_site/api/operations/mechanical.md index ddbff65..5e9bb48 100644 --- a/docs_site/api/operations/mechanical.md +++ b/docs_site/api/operations/mechanical.md @@ -20,6 +20,12 @@ All four lists are identified by `description`, which is auto-generated if missi See `examples/project_operations/mechanical_operations.py` for a full walkthrough. +!!! warning "Mechanical requirements" + Mechanical requirements (`requirementAnswer` on HVAC systems, fan systems, + plants, and water heaters) are not supported by this package. Save the project, + then open it on [COMcheck Web](https://comcheck.energycode.pnl.gov/) to fill + them out. + ## HVAC Systems HVAC systems are identified by their `description`. diff --git a/docs_site/getting-started.md b/docs_site/getting-started.md index 9355fcb..4b01b90 100644 --- a/docs_site/getting-started.md +++ b/docs_site/getting-started.md @@ -1,7 +1,7 @@ # Getting Started !!! note "Supported Sections" - Currently, **Building Area**, **Envelope**, **Interior Lighting**, **Exterior Lighting**, **Renewable Energy**, **Credits**, and **Compliance Simulation** operations are fully supported. The mechanical section is planned but not yet implemented. See the [home page](index.md#current-status) for the full status table. + Currently, **Building Area**, **Envelope**, **Interior Lighting**, **Exterior Lighting**, **Mechanical**, **Renewable Energy**, **Credits**, and **Compliance Simulation** operations are supported. Mechanical requirements are not supported; fill them out on [COMcheck Web](https://comcheck.energycode.pnl.gov/). See the [home page](index.md#current-status) for the full status table. ## Setup diff --git a/docs_site/index.md b/docs_site/index.md index 84cc42d..4c7c7e4 100644 --- a/docs_site/index.md +++ b/docs_site/index.md @@ -13,11 +13,11 @@ This package is under active development. Here is the current support status for | Interior Lighting | Supported | | Exterior Lighting | Supported | | Compliance Simulation | Supported | -| Mechanical | TBD | +| Mechanical | Supported (requirements must be filled out on COMcheck Web) | | Credits | Supported | | Renewable Energy | Supported | -Operations and data managers for the TBD sections are not yet implemented. The underlying types and models for these sections are available (see [Types Guide](types-guide.md)), but there are no high-level convenience functions for them yet. +Mechanical requirements (`requirementAnswer` on HVAC systems, fan systems, plants, and water heaters) are not supported by this package. Save the project, then open it on [COMcheck Web](https://comcheck.energycode.pnl.gov/) to fill them out. ## Features