Best practices for version control of OpenStudio Measures

asked 2020-03-30 14:23:15 -0600

updated 2020-03-30 14:26:36 -0600

What are your best practices for version control of OpenStudio Measures? For example, I'd like to avoid all the XML file diffs that result whenever the OpenStudio Application opens the local My Measures folder.

Some ideas...

Use a .gitignore file
Use separate folders, e.g. development or published
Use separate repositories to develop and publish
Use a Git submodule (nested repository)

answered 2020-03-31 10:25:36 -0600

shorowit

11801 ●200 ●9 https://www.nrel.gov/b...

Ideally after you make changes to your measures, you would run openstudio measure -u /path/to/measure_dir (or openstudio measure -t /path/to/dir_of_measures if there are multiple measures) and commit the updated measure XML file. You could wrap this command in a rake task or perhaps a git pre-commit hook to make it easier to run. Thus the git repo would have measure XMLs that are consistent with the measures, and running the OpenStudio App would not generate any XML file diffs.

edit flag offensive delete link

Comments

Thanks Scott. Here's the link to the documentaion https://nrel.github.io/OpenStudio-use...

MatthewSteen ( 2020-03-31 10:41:12 -0600 )edit

The only issue I've seen with this workflow is when there are multiple branches that each work on a common measure. They each generate an XML that has correct checksum (for current state), but once things are merged down the checksum is now wrong. So an extra step is needed to re-update the measure.xmls after they are merged together.