Skip to content

L200 baseline HVAC workflow - #33

Open
JieXiong9119 wants to merge 4 commits into
developfrom
l200-baseline-hvac
Open

JieXiong9119 wants to merge 4 commits into
developfrom
l200-baseline-hvac

Conversation

@JieXiong9119

@JieXiong9119 JieXiong9119 commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds L200 HVAC topology construction to the baseline: when a BuildingSync file's existing HVAC system exactly matches a supported topology, BOSS builds that topology instead of relying on create_typical_building_from_model's generic HVAC. All other cases keep today's fallback behavior.

This pulls the baseline + HVAC part of scenario-workflow branch (up to #30) into develop on its own, ahead of the package-scenario work. Scenario mapping, scenario OSW writing/running, modifier binding, and retrofit fixtures stay on scenario-workflow.

Behavior

  • Topology baseline: when every non-proposed HVACSystem exactly matches one supported configuration (PTAC, PTHP, four-pipe fan coil, packaged rooftop AC/heat pump, packaged rooftop VAV or VAV with hot-water reheat, warm air furnace, VRF; optionally plus ventilation-only/DOAS with zone equipment) that serves the whole building:
    • create_typical_building_from_model gets add_hvac: false
    • apply_hvac_topology_to_zone_scope (create, all_model_zones) then apply_standard_hvac_sizing_and_efficiency are added
    • buildingsync-measures-gem measure paths are added to measure_paths
    • Simulation coverage in this PR: packaged rooftop heat pump (2 fixtures); the other configurations are covered by selector/planner/binder unit specs.
  • Fallback baseline (no match or unsupported template): add_hvac: true, existing system_type mapping, a logged warning, and no dependency on the sibling checkout. Verified byte-identical in.osw against develop for building_151 and all_measures_applied_example.
  • No changes to public APIs, CLI commands/options, runner inputs, or the baseline/in.osw layout.

Changes

  • OswArgPopulator: append_step, set_step_argument, step_argument_setter, add_hvac: keyword (default true)
  • ExternalMeasureRepoManager + config/external_measure_repos.yml: local_path sources (used in place, never touched by Git; missing path is an actionable error) and the scenario_only / include_scenario_only gate so only topology baselines need ../buildingsync-measures-gem
  • BuildingSyncReader#get_hvac_systems_xml
  • New HvacTopologySelector, BaselineHvacPlanner (incl. proposed_system_ids, moved from ScenarioHvacPlanner), and HvacTargetBinder (topology binding only; bind_modifier intentionally omitted)
  • Boss.write_baseline_osw refactored onto private build_baseline_osw; run_baseline_osw unchanged
  • Fixtures: example-smalloffice-level2.xml, example-smalloffice-level2-built-2012.xml
  • CI checks out buildingsync-measures-gem as a sibling at the pinned ref in the unit and integration jobs; paths/caches/artifacts adjusted for the BOSS/ subfolder. Shards, smoke selection, and docs-only gates unchanged.
  • Two topology baseline integration examples (DOE Ref 1980-2004, 90.1-2013), run on shard 0 only and skipped with BOSS_SMOKE=1
  • README: "Baseline HVAC" section, sibling-checkout setup, add_hvac row updated

Testing

  • bundle exec rspec spec/tests/unit — 152 examples, 0 failures
  • Fallback OSW parity with develop (building_151, all_measures_applied_example) — identical
  • bundle exec rake measures:install_external + rspec spec/tests/integration/write_and_run_osws_spec.rb -e "topology HVAC baseline" — 2 examples, 0 failures (both simulations Success)
  • git diff --check — clean
  • Full integration suite / shards — via CI
  • RuboCop

Local setup

git clone https://github.com/BuildingSync/buildingsync-measures-gem.git ../buildingsync-measures-gem
git -C ../buildingsync-measures-gem checkout 789bd50

Only needed for topology baselines and the related specs.

@JieXiong9119 JieXiong9119 self-assigned this Nov 18, 2026
@JieXiong9119

Copy link
Copy Markdown
Contributor Author

Notes:

  • This PR can't merge into develop until upstream buildingsync-measures-gem PR #6 merges and the BSYNC_MEASURES_REF pin in CI points to the merged commit.
  • After this merges, update scenario-workflow so ScenarioHvacPlanner.proposed_system_ids calls the copy that now lives in BaselineHvacPlanner.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant