Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions comcheck_api/ai/skill/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions comcheck_api/ai/skill/reference/operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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[]`) | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions docs_site/api/operations/mechanical.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
2 changes: 1 addition & 1 deletion docs_site/getting-started.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs_site/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading