Add measure spec tables, clean up measure docs - #2
Open
JieXiong9119 wants to merge 1 commit into
Open
Conversation
JieXiong9119
changed the title
There was a problem hiding this comment.
Pull request overview
This PR expands and standardizes measure documentation by adding measure README pages and ASHRAE 211 L2 semantic-mapping references, plus “BuildingSync Reader Mapping” tables to align measure arguments with candidate BuildingSync data paths.
Changes:
- Added/expanded per-measure documentation READMEs (usage, arguments, OSW examples).
- Added ASHRAE 211 Level 2 semantic-mapping documents for measures and updated existing semantic-mapping docs.
- Added “BuildingSync Reader Mapping” tables across multiple measure docs to describe potential BuildingSync-to-argument sourcing.
Reviewed changes
Copilot reviewed 11 out of 12 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| lib/measures/set_infiltration_by_ach/docs/README.md | New measure README describing purpose, arguments, BuildingSync mapping, and OSW example. |
| lib/measures/set_infiltration_by_ach/docs/ashrae-211-l2-semantic-mapping.md | New ASHRAE 211 L2 semantic mapping doc for ACH-based infiltration translation. |
| lib/measures/set_infiltration_by_ach/docs/ASHRAE_211_L2_SEMANTIC_MAPPING.md | Adds BuildingSync Reader Mapping section to existing semantic mapping doc. |
| lib/measures/modify_schedules/docs/USAGE.md | Adds BuildingSync Reader Mapping section to usage documentation. |
| lib/measures/modify_schedules/docs/README.md | New comprehensive measure README covering payload formats, binding behavior, errors, and testing notes. |
| lib/measures/modify_schedules/docs/ashrae-211-l2-semantic-mapping.md | New ASHRAE 211 L2 semantic mapping doc for schedule/operations translation. |
| lib/measures/modify_hvac/docs/README.md | New HVAC measure README describing supported types, arguments, mappings, and SDK setters. |
| lib/measures/modify_hvac/docs/modify_hvac_measure.md | Adds BuildingSync Reader Mapping section to detailed HVAC measure doc. |
| lib/measures/modify_hvac/docs/ashrae-211-l2-semantic-mapping.md | Updates semantic mapping doc to reference the README as the primary implementation reference. |
| lib/measures/modify_envelope_insulation/docs/README.md | New semantic mapping document added as the measure docs README. |
| lib/measures/modify_envelope_insulation/docs/ASHRAE_211_L2_SEMANTIC_MAPPING.md | Adds BuildingSync Reader Mapping section to existing envelope semantic mapping doc. |
| lib/measures/disable_sizing_runs/docs/README.md | New measure README describing behavior, workflow placement, and OSW example. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "day_type": "Weekday|Weekend|Holiday", | ||
| "start_time": "HH:MM:SS", | ||
| "end_time": "HH:MM:SS", | ||
| "value_percent": 0–100 |
| ### Occupancy Schedules | ||
| - Added to building-level DefaultScheduleSet as occupancy schedule | ||
| - Applied to all People objects via the default schedule set | ||
| - If `replace_existing=true`, explicit people activity schedules are cleared |
|
|
||
| - All times are stored as total seconds from midnight (0–86,400) | ||
| - OpenStudio `Time` objects are constructed from (days=0, hours, minutes, seconds) components | ||
| - Timestamps are clamped to 23:59:59 maximum; 24:00:00 is converted to 23:59:59 |
Comment on lines
+357
to
+360
| ```bash | ||
| cd /repo | ||
| RUN_OPENSTUDIO_INTEGRATION=1 pytest tests/test_measure_authoring.py -k "modify_schedules" -v | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.