Skip to content

Show a design-day run without a weather file - #34

Merged
samuelduchesne merged 1 commit into
mainfrom
design-day-without-weather
Oct 16, 2026
Merged

samuelduchesne merged 1 commit into
mainfrom
design-day-without-weather

Conversation

@samuelduchesne

Copy link
Copy Markdown
Contributor

1. Summary

idfkit 1.1.0, adopted in #33, accepts a design-day-only run without a weather file (idfkit/idfkit#230). This pull request updates the "Design-Day Only" section of docs/simulation/running.md accordingly.

  1. docs/snippets/simulation/running/design_day_only.py now calls simulate(model, design_day=True) and no longer declares a placeholder weather variable.
  2. The section states that a design-day-only run needs no weather file, and names the models that still require one:
    • models with GroundHeatTransfer:Slab or GroundHeatTransfer:Basement objects whose preprocessor GroundHeatTransfer:Control enables (refused by idfkit);
    • models with SizingPeriod:WeatherFileDays or SizingPeriod:WeatherFileConditionType (EnergyPlus fails);
    • models with Site:WaterMainsTemperature using CorrelationFromWeatherFile (EnergyPlus reports a severe error and uses 10 °C).
  3. It states that a sizing-only model must be run as a design-day-only run.

The page's parity("local-simulation") statement is unchanged. The snippet type-checks only against idfkit 1.1.0 or later, which is why this change follows #33.

Specification: specs/013-design-day-without-weather/ in idfkit-unification, FR-018 (tasks T037 and T038).

2. Verification

  1. make check: passes.
  2. Strict build: the local build reports only cairosvg warnings, caused by the absent Cairo library on the build machine; the page renders with the new section. The strict-build check on this pull request is authoritative.

idfkit 1.1.0 accepts a design-day-only run without a weather file. The
Design-Day Only example now omits it, and the section states which models
still require one.
@github-actions

Copy link
Copy Markdown
Contributor

github-actions Bot added a commit that referenced this pull request Oct 16, 2026
@samuelduchesne
samuelduchesne merged commit a05d994 into main Oct 16, 2026
7 checks passed
@samuelduchesne
samuelduchesne deleted the design-day-without-weather branch October 16, 2026 20:19
github-actions Bot added a commit that referenced this pull request Oct 16, 2026
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