Skip to content

Commit bb1caeb

Browse files
use Ashrae 90.1 compliance insted of full complaince
1 parent a1d7fab commit bb1caeb

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

docs_site/api/compliance.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Compliance & Reports
22

3-
## UA path vs. full compliance
3+
## UA path vs. ASHRAE 90.1 Compliance Check
44

55
For ASHRAE 90.1-based codes (and state codes derived from them), there are two
66
distinct compliance checks:
77

88
| Check | Method | What it covers |
99
|---|---|---|
1010
| UA path | `check_UA_compliance` | Envelope trade-off path only — fast, synchronous |
11-
| Full compliance | `check_UA_compliance` → simulation | All systems (envelope, lighting, mechanical, renewables) |
11+
| ASHRAE 90.1 Compliance Check | `check_UA_compliance` → simulation | All systems (envelope, lighting, mechanical, renewables) |
1212

1313
Use `check_UA_compliance` alone when you only need to verify the envelope
1414
trade-off path. For a complete compliance determination — or to generate an
@@ -37,7 +37,7 @@ print(compliance)
3737
# }
3838
```
3939

40-
## Full compliance workflow
40+
## ASHRAE 90.1 Compliance Check workflow
4141

4242
```python
4343
import time
@@ -60,7 +60,7 @@ else:
6060
status = client.get_simulation_status(session_id)
6161
if status["status"] == SimulationStatus.SUCCESS:
6262
result = client.get_simulation_result(session_id)
63-
print(f"Full compliance result: {result}")
63+
print(f"ASHRAE 90.1 Compliance Check result: {result}")
6464
break
6565
if status["status"] == SimulationStatus.FAILED:
6666
print(f"Simulation failed: {status.get('message')}")

examples/client/compliance_and_report.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""Example of using COMcheck API client compliance, requirements, and report functions.
22
3-
UA path vs. full compliance
4-
----------------------------
3+
UA path vs. ASHRAE 90.1 Compliance Check
4+
----------------------------------------
55
ASHRAE 90.1-based codes (and state codes derived from it) require TWO checks to
66
establish full envelope compliance:
77
@@ -15,7 +15,7 @@
1515
complete code compliance determination is needed.
1616
1717
If your project only needs to verify the envelope trade-off path, Example 1 is
18-
sufficient. If you need a full compliance determination (e.g. to generate an
18+
sufficient. If you need an ASHRAE 90.1 Compliance Check determination (e.g. to generate an
1919
official report), run Example 1 first; if it passes, proceed with Example 6.
2020
"""
2121

@@ -67,7 +67,7 @@
6767
if report:
6868
print(f"Saved report to ./reports/{report['fileName']}")
6969

70-
# Example 6: Full compliance check (ASHRAE 90.1-based codes)
70+
# Example 6: ASHRAE 90.1 Compliance Check (ASHRAE 90.1-based codes)
7171
# For a complete compliance determination, first verify the UA path passes,
7272
# then run the full simulation.
7373
ua_result = client.check_UA_compliance(project)
@@ -80,7 +80,7 @@
8080
status = client.get_simulation_status(session_id)
8181
if status["status"] == SimulationStatus.SUCCESS:
8282
result = client.get_simulation_result(session_id)
83-
print(f"Full compliance result: {result}")
83+
print(f"ASHRAE 90.1 Compliance Check result: {result}")
8484
break
8585
if status["status"] == SimulationStatus.FAILED:
8686
print(f"Simulation failed: {status.get('message')}")

0 commit comments

Comments
 (0)