Skip to content

Commit

Permalink
Merge pull request #213 from urbanopt/v0.12.0
Browse files Browse the repository at this point in the history 
Doc changes for v0.12.0
  • Loading branch information
@kflemin
kflemin authored May 15, 2024
2 parents 823abeb + d32796c commit 0339a0f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 10 deletions.
4 changes: 3 additions & 1 deletion developer_resources/compatibility_matrix.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The URBANopt<sup>&trade;</sup> installer includes Ruby and OpenStudio. The matri

|URBANopt Version|OpenStudio| OpenStudio-HPXML | Ruby | Python | REopt API | Modelica Buildings Library |
|:--------------:|:--------:|:----------------:|:----:|:------:|:---------:|:--------------------------:|
| 0.12.0 | 3.7.0 | 1.7.0 | 2.7.2| 3.10 | v3 | 10 |
| 0.11.0 | 3.7.0 | 1.7.0 | 2.7.2| 3.10 | v2 | 10 |
| 0.10.0 | 3.6.1 | 1.6.0 | 2.7 | 3.10 | v2 | 9 |
| 0.9.1 - 0.9.2 | 3.5.1 | 1.5.1 | 2.7 | 3.10 | v2 | 9 |
Expand All @@ -29,7 +30,8 @@ URBANopt<sup>&trade;</sup> depends on various other components to function. Ensu

|URBANopt Version|URBANopt CLI|OpenStudio|Ruby |Gems |
|:--------------:|:----------:|:--------:|:-----:|:------------------------------------|
|**0.11.0** | 0.11.0 | 3.7 | 2.7.2 | **URBANopt Gems:** <br/>Core Gem v0.11.0 <br/> GeoJSON Gem v0.11.1 <br/> REopt Gem v0.11.0 <br/> Reporting Gem v0.9.1 <br/> RNM-US Gem v0.7.0 <br/> Scenario Gem v0.11.0<br/> **Python Dependencies:** <br/> DISCO v0.4.1 <br/> DiTTo Reader v0.6.3 <br/> GeoJSON Modelica Translator v0.6.0 <br/> ThermalNetwork v0.2.3 **OpenStudio Gems:**<br/>Extension Gem v0.7.1 <br/> Common Measures v0.9.0 <br/> Model Articulation v0.9.0 <br/> Load Flexibility v0.8.0 <br/> EE Gem v0.9.0 <br/> Calibration Gem v0.9.0 <br/> GEB Gem v0.4.0 |
|**0.12.0** | 0.12.0 | 3.7 | 2.7.2 | **URBANopt Gems:** <br/>Core Gem v0.11.0 <br/> GeoJSON Gem v0.11.1 <br/> REopt Gem v0.12.0 <br/> Reporting Gem v0.10.0 <br/> RNM-US Gem v0.7.0 <br/> Scenario Gem v0.12.0<br/> **Python Dependencies:** <br/> DISCO v0.5.1 <br/> DiTTo Reader v0.6.4 <br/> GeoJSON Modelica Translator v0.7.0 <br/> ThermalNetwork v0.2.5 **OpenStudio Gems:**<br/>Extension Gem v0.7.1 <br/> Common Measures v0.9.0 <br/> Model Articulation v0.9.0 <br/> Load Flexibility v0.8.0 <br/> EE Gem v0.9.0 <br/> Calibration Gem v0.9.0 <br/> GEB Gem v0.4.0 |
|**0.11.0** | 0.11.0 | 3.7 | 2.7.2 | **URBANopt Gems:** <br/>Core Gem v0.11.0 <br/> GeoJSON Gem v0.11.1 <br/> REopt Gem v0.11.0 <br/> Reporting Gem v0.9.1 <br/> RNM-US Gem v0.7.0 <br/> Scenario Gem v0.11.0<br/> **Python Dependencies:** <br/> DISCO v0.4.1 <br/> DiTTo Reader v0.6.3 <br/> GeoJSON Modelica Translator v0.6.0 <br/> ThermalNetwork v0.2.5 **OpenStudio Gems:**<br/>Extension Gem v0.7.1 <br/> Common Measures v0.9.0 <br/> Model Articulation v0.9.0 <br/> Load Flexibility v0.8.0 <br/> EE Gem v0.9.0 <br/> Calibration Gem v0.9.0 <br/> GEB Gem v0.4.0 |
|**0.10.0** |0.10.0 |3.6 |2.7.x|**URBANopt Gems:** <br/>Core Gem v0.10.0<br/> GeoJSON Gem v0.10.0 <br/> Scenario Gem v0.10.0<br/> Reporting Gem v0.8.0 <br/> REopt Gem v0.10.0 <br/> RNM-US Gem v0.6.0 <br/> **Python Dependencies:** <br/> DiTTo Reader v0.5.1 <br/> GeoJSON Modelica Translator v0.5.0 <br/> DISCO v0.4.1 <br/> **OpenStudio Gems:**<br/>Extension Gem v0.6.1 <br/> Common Measures v0.8.0 <br/> Model Articulation v0.8.0 <br/> Load Flexibility v0.7.0 <br/> EE Gem v0.8.0 <br/> Calibration Gem v0.8.0 <br/> GEB Gem v0.3.2 |
|**0.9.0 - 0.9.3** |0.9.3 |3.5 |2.7.x|**URBANopt Gems:** <br/>Core Gem v0.9.0<br/> GeoJSON Gem v0.9.0 <br/> Scenario Gem v0.9.0<br/> Reporting Gem v0.7.0 <br/> REopt Gem v0.9.0 <br/> RNM-US Gem v0.5.0 <br/> **Python Dependencies:** <br/> DiTTo Reader v0.5.1 <br/> GeoJSON Modelica Translator v0.4.0 <br/> DISCO v0.4.1 <br/> **OpenStudio Gems:**<br/>Extension Gem v0.6.0 <br/> Common Measures v0.7.0 <br/> Model Articulation v0.7.0 <br/> Load Flexibility v0.6.1 <br/> EE Gem v0.7.0 <br/> Calibration Gem v0.7.0 <br/> GEB Gem v0.2.1 |
|**0.8.3** |0.8.3 |3.4 |2.7.x|**URBANopt Gems:** <br/>Core Gem v0.8.0<br/> GeoJSON Gem v0.8.1 <br/> Scenario Gem v0.8.0<br/> Reporting Gem v0.6.1 <br/> REopt Gem v0.8.0 <br/> RNM-US Gem v0.4.0 <br/> DiTTo Reader v0.4.0 <br/> GeoJSON Modelica Translator v0.2.3 <br/> **OpenStudio Gems:**<br/>Extension Gem v0.5.1 <br/> Common Measures v0.6.1 <br/> Model Articulation v0.6.1 <br/> Load Flexibility v0.5.0 <br/> EE Gem v0.6.0 <br/> Calibration Gem v0.6.0 |
Expand Down
12 changes: 3 additions & 9 deletions developer_resources/release_instructions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,20 +28,14 @@ We recommend releasing gems **in order from the base to most dependent**. For ea
```
1. Remove .DS_Store files if any are in the repo
1. If the gem has rdoc documentation, [regenerate the rdocs](../developer_resources/developer_resources.md#generating-rdoc-documentation)
1. 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.
```
rake openstudio:change_log[start_date,end_date,apikey]
```
No spaces around the commas! Paste the `Closed Issues` into the CHANGELOG, matching formatting as appropriate.
1. Ensure that the Gemfile and gemspec files are "clean" and that no dependency is pointing to a github branch before merging to develop and main branches.
1. Merge pull requests to the `develop` branch
1. On GitHub, go to the releases page and draft a latest release tag. Name it “Version x.y.z”. Use the Github automated changelog generation and copy the CHANGELOG entry into the changelog file.
1. Update the documentation with detailed usage and helpful examples
1. Update [Compatibility Matrix](compatibility_matrix.md) as appropriate
1. Create PR to main
- Ensure all tests pass before merging
1. Locally - from the main branch, run `rake release` to release the gem to RubyGems
1. Update the documentation with detailed usage and helpful examples
1. 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
1. Update [Compatibility Matrix](compatibility_matrix.md) as appropriate
### Updates for New Version of OpenStudio
Follow these steps when testing URBANopt for a new version of OpenStudio. These changes should be made on all URBANopt Ruby gems, the example-geojson-project repo, and the CLI:
Expand Down

0 comments on commit 0339a0f

Please sign in to comment.