writing-openstudio-model-measures

Write an OpenStudio ModelMeasure by creating a Ruby class that inherits from OpenStudio::Measure::ModelMeasure and implements required methods: name(), description(), modeler_description(), arguments(model), and run(model, runner, user_arguments) returning a boolean. This Skill provides scaffolding to generate boilerplate measure directories, measure.rb templates, and test patterns for OpenStudio 3.9 environments.

Use the Skill's scaffolding script to generate a complete measure directory structure, including boilerplate measure.rb, test templates, and metadata files. Name your measure (e.g., 'Add Window Overhangs'), run the scaffold command, and begin editing measure.rb with the generated framework in place.

Yes. OpenStudio ModelMeasures require inheritance from OpenStudio::Measure::ModelMeasure, implementation of name(), description(), modeler_description(), arguments(model), and run(model, runner, user_arguments) methods, and a boolean return value. This Skill enforces these conventions through scaffolding and guidance aligned with OpenStudio measure writing best practices.

Yes. The Skill's scaffolding generates test templates alongside measure.rb and resources, providing a testing pattern structure. You populate the tests with your measurement logic and assertions for your specific measure behavior.

You need intermediate Ruby proficiency to write measure logic within the ModelMeasure framework. The Skill provides boilerplate code and scaffolding to handle class structure and method signatures, so you focus on the modeling logic inside run() and argument definitions.

Yes. This Skill is designed for OpenStudio 3.9 environments and modeling workflows. It generates measures compliant with the OpenStudio::Measure::ModelMeasure API and conventions in that version.