Skip to content

Commit a1d7fab

Browse files
update the compliance page
1 parent 8fa04e2 commit a1d7fab

1 file changed

Lines changed: 24 additions & 22 deletions

File tree

docs_site/api/compliance.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,28 @@ trade-off path. For a complete compliance determination — or to generate an
1515
official report — run the UA check first, and if it passes, launch the full
1616
simulation.
1717

18+
## Check UA path compliance
19+
20+
`check_UA_compliance(project)` evaluates the project's envelope assemblies
21+
against the UA trade-off path and returns the per-category compliance status.
22+
23+
```python
24+
from comcheck_api import COMcheckClient
25+
from comcheck_api.defaults import get_default_project_template
26+
27+
client = COMcheckClient(api_key="your-key")
28+
project = get_default_project_template()
29+
30+
compliance = client.check_UA_compliance(project)
31+
print(compliance)
32+
# {
33+
# "mandatoryRequirementsMet": ...,
34+
# "envelopeStatus": {...}, "interiorLightingStatus": {...},
35+
# "exteriorLightingStatus": {...}, "renewableStatus": {...},
36+
# "energyCreditStatus": {...},
37+
# }
38+
```
39+
1840
## Full compliance workflow
1941

2042
```python
@@ -28,8 +50,9 @@ project = get_default_project_template()
2850

2951
# Step 1: UA path check
3052
ua = client.check_UA_compliance(project)
53+
print(ua) # inspect the UA compliance result
3154
if not ua or not ua.get("mandatoryRequirementsMet"):
32-
print("UA path failed — full simulation not needed.")
55+
print("UA path failed.")
3356
else:
3457
# Step 2: Full simulation
3558
session_id = client.start_run_simulation(project)
@@ -47,27 +70,6 @@ else:
4770

4871
See [Simulation](simulation.md) for details on polling and result fields.
4972

50-
## Check UA path compliance
51-
52-
`check_UA_compliance(project)` evaluates the project's envelope assemblies
53-
against the UA trade-off path and returns the per-category compliance status.
54-
55-
```python
56-
from comcheck_api import COMcheckClient
57-
from comcheck_api.defaults import get_default_project_template
58-
59-
client = COMcheckClient(api_key="your-key")
60-
project = get_default_project_template()
61-
62-
compliance = client.check_UA_compliance(project)
63-
# {
64-
# "mandatoryRequirementsMet": ...,
65-
# "envelopeStatus": {...}, "interiorLightingStatus": {...},
66-
# "exteriorLightingStatus": {...}, "renewableStatus": {...},
67-
# "energyCreditStatus": {...},
68-
# }
69-
```
70-
7173
## Check requirements
7274

7375
`check_requirements(project)` returns the applicable requirements for a

0 commit comments

Comments
 (0)