Enhance skill docs with version checks and data-vintage guidance#14
Merged
Conversation
Polish low-severity domain gaps from the skills expert review (#6): - weather: note TMY vs actual-year (AMY) data selection and that Site:Location should match the chosen EPW header. - docs: disambiguate from developing-with-idfkit (EnergyPlus object docs via MCP vs writing idfkit Python). - load-model: flag Version mismatch with installed EnergyPlus (suggest migrate_model) and surface simulation-readiness gaps. Closes #6 https://claude.ai/code/session_01XzMPTDsvgLrz6AGSsR4zKC
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
2 participants
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.
Summary
Updated skill documentation to surface critical simulation-readiness checks and clarify data requirements for weather and model loading workflows. These changes help users avoid silent failures and mismatches between model configuration and input data.
Key Changes
load-model skill: Added version-check step to flag EnergyPlus version mismatches and recommend
migrate_modelbefore simulation. Expanded "highlight issues" section with specific simulation-readiness gaps (autosizing without design days, missing weather/location, missing ground temperature, no output variables).weather skill: Added guidance on data vintage (TMY vs. AMY) to clarify that default files are typical-year and unsuitable for M&V work without actual-year data. Added note about
Site:Locationalignment between model and EPW to prevent silent solar/results skew.docs skill: Added clarification that the skill provides EnergyPlus object documentation, with a pointer to
developing-with-idfkitfor Python library guidance.Notable Details
These changes address common failure modes:
The updates make these issues explicit in the skill workflows so users catch them early.
https://claude.ai/code/session_01XzMPTDsvgLrz6AGSsR4zKC