The modular nature of URBANopt™ allows for freedom in developing and using only the parts relevant to your work. Keep in mind the following dependencies:
We recommend releasing gems in order from the base to most dependent. For each gem being improved, follow these steps:
- Increment version (if needed) in
- For gems with measures in them, run the following rake tasks and commit the changes:
rake openstudio:test_with_openstudio rake openstudio:update_measures
RuboCopon all PRs before merging to
- Remove .DS_Store files if any are in the repo
- If the gem has rdoc documentation, regenerate the rdocs
- Run the changelog rake task and add the changes to the CHANGELOG file for the range of time between last release and this release. Also make sure that all pull requests have a related Issue to be included in the change log.
No spaces around the commas! Paste the
Closed Issuesinto the CHANGELOG, matching formatting as appropriate.
- Merge pull requests to the
- Create PR to master
- Ensure all tests pass before merging
- Locally - from the master branch, run
rake releaseto release the gem to RubyGems
- Update the documentation with detailed usage and helpful examples
- On GitHub, go to the releases page and update the latest release tag. Name it “Version x.y.z” and copy the CHANGELOG entry into the text box.
- Link to relevant documentation URLs in release tags
- Update Compatibility Matrix as appropriate
URBANopt SDK and OpenStudio SDK share some dependencies, namely the OpenStudio Extension gem. Additionally, the URBANopt SDK is included as a dependency in the OpenStudio Analysis Framework (OSAF). For these reasons, dependency conflicts can arise when the OpenStudio extension gem has a major release (X.0.0 or 0.X.0). This usually happens for major OpenStudio SDK releases and Ruby version changes.
To avoid these conflicts, major versions of OpenStudio, and more specifically OSAF, will not include the URBANopt SDK. URBANopt SDK’s dependencies must first be updated with the newly released OpenStudio Extension gem and tested with the latest OpenStudio SDK version. Once URBANopt SDK is updated and released, a patch release of OSAF will be made that includes the URBANopt SDK.
A few notes:
- Users can use any OpenStudio versions that have a compatible URBANopt SDK release for all workflows excluding optimization.
- Users should use OpenStudio versions not ending in 0 (for example, use 3.2.1 instead of 3.2.0) to use URBANopt optimization workflows.
The diagram below illustrates the OpenStudio and URBANopt release process.