Skip to content

Commit

Permalink
Support OpenStudio 3.7 (#265)
Browse files Browse the repository at this point in the history
* point to os37 branch of core-gem for testing

* rake openstudio update & test

* use OS3.7 in CI, and bump `checkout` to v4

* bump to version 0.11.0

* depend on core-gem v0.11.0 in gemspec

* uncomment allow_local code in Gemfile

* fix copy/paste typo in contributing.md

* include 2024 in license

* bump json-schema minor version

* set safe dir in CI runner to eliminate nag message
  • Loading branch information
vtnate authored Jan 9, 2024
1 parent f9b41df commit fe3b040
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 24 deletions.
8 changes: 6 additions & 2 deletions .github/workflows/nightly_build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,13 @@ jobs:
weeknight-tests:
runs-on: ubuntu-latest
container:
image: docker://nrel/openstudio:3.6.1
image: docker://nrel/openstudio:3.7.0
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: set git config options
shell: bash
run: |
git config --global --add safe.directory '*'
- name: Update gems
run: |
ruby --version
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ The contribution process for URBANopt is composed of three steps:

## 1. Send consent email

In order for us to distribute your code as part of URBANopt under the URBANopt SDK [license](https://github.com/urbanopt/urbanopt-scenario-gem/blob/develop/LICENSE.md), we’ll need your consent. An email acknowledging your understanding of these terms and agreeing to them is all that will be asked of any contributor. Send an email to the URBANopt project manager ([see below](#documentation) for the address) including the following text and a list of co-contributors (if any):
In order for us to distribute your code as part of URBANopt under the URBANopt SDK [license](https://github.com/urbanopt/urbanopt-geojson-gem/blob/develop/LICENSE.md), we’ll need your consent. An email acknowledging your understanding of these terms and agreeing to them is all that will be asked of any contributor. Send an email to the URBANopt project manager ([see below](#documentation) for the address) including the following text and a list of co-contributors (if any):

*I agree to contribute to the URBANopt SDK. I agree to the following terms and conditions for my contributions: First, I agree that I am licensing the copyright to my contributions under the terms of the current URBANopt SDK license. Second, I hereby grant to Alliance for Sustainable Energy, LLC, to any successor manager and distributor of URBANopt SDK appointed by the U.S. Department of Energy, and to all recipients of a version of URBANopt SDK that includes my contributions, a non-exclusive, worldwide, royalty-free, irrevocable patent license under any patent claims owned by me, or owned by my employer and known to me, that are or will be,necessarily infringed upon by my contributions alone, or by combination of my contributions with the version of URBANopt SDK to which they are contributed, to make, have made, use, offer to sell, sell, import, and otherwise transfer any version of URBANopt SDK that includes my contributions, in source code and object code form. Third, I represent and warrant that I am authorized to make the contributions and grant the foregoing license(s). Additionally, if, to my knowledge, my employer has rights to intellectual property that covers my contributions, I represent and warrant that I have received permission to make these contributions and grant the foregoing license(s) on behalf of my employer.*

Once we have your consent on file, you’ll only need to redo it if conditions change (e.g. a change of employer).

## 2. Scope agreement and timeline commitment

If your contribution is small (e.g. a bug fix), simply submit your contribution via GitHub. If you find a bug, first make sure it is not an already known issue, then report it in the GitHub [issue tracker](https://github.com/urbanopt/urbanopt-scenario-gem/issues) for this repository. If your contribution is larger (e.g. a new feature or new functionality/capability), we’ll need to evaluate your proposed contribution first. We may ask you to revise your materials and make changes to it, which we will then re-review.
If your contribution is small (e.g. a bug fix), simply submit your contribution via GitHub. If you find a bug, first make sure it is not an already known issue, then report it in the GitHub [issue tracker](https://github.com/urbanopt/urbanopt-geojson-gem/issues) for this repository. If your contribution is larger (e.g. a new feature or new functionality/capability), we’ll need to evaluate your proposed contribution first. We may ask you to revise your materials and make changes to it, which we will then re-review.

## 3. Technical contribution process

Expand Down
10 changes: 5 additions & 5 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ gem 'parser', '3.2.2.2'
# gem 'openstudio-extension', github: 'NREL/openstudio-extension-gem', branch: 'develop'
# end

# if allow_local && File.exist?('../urbanopt-core-gem')
# gem 'urbanopt-core', path: '../urbanopt-core-gem'
# elsif allow_local
# gem 'urbanopt-core', github: 'URBANopt/urbanopt-core-gem', branch: 'develop'
# end
if allow_local && File.exist?('../urbanopt-core-gem')
gem 'urbanopt-core', path: '../urbanopt-core-gem'
elsif allow_local
gem 'urbanopt-core', github: 'URBANopt/urbanopt-core-gem', branch: 'develop'
end
2 changes: 1 addition & 1 deletion doc_templates/LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
URBANopt (tm), Copyright (c) 2019-2023, Alliance for Sustainable Energy, LLC, and other
URBANopt (tm), Copyright (c) 2019-2024, Alliance for Sustainable Energy, LLC, and other
contributors. All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
Expand Down
2 changes: 1 addition & 1 deletion lib/measures/urban_geometry_creation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Select which surrounding buildings to include.
**Required:** true,
**Model Dependent:** false

### Scale Footprint Area by the Floor Area?
### Scale Footprint Area by the Floor Area
If true, the footprint area from GeoJSON will be scaled by the floor_area provided by the user in URBANopt.
**Name:** scale_footprint_area_by_floor_area,
**Type:** Boolean,
Expand Down
14 changes: 7 additions & 7 deletions lib/measures/urban_geometry_creation/measure.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<schema_version>3.1</schema_version>
<name>urban_geometry_creation</name>
<uid>5ab85d6b-c9af-4361-8ab9-613ee99a5666</uid>
<version_id>7f03040a-cc98-4c54-ae40-f33db7f534b7</version_id>
<version_modified>2023-07-06T15:57:24Z</version_modified>
<version_id>583499fb-4275-4787-9168-e3383dca0fc6</version_id>
<version_modified>2023-11-20T17:10:01Z</version_modified>
<xml_checksum>D254E772</xml_checksum>
<class_name>UrbanGeometryCreation</class_name>
<display_name>UrbanGeometryCreation</display_name>
Expand Down Expand Up @@ -48,7 +48,7 @@
</argument>
<argument>
<name>scale_footprint_area_by_floor_area</name>
<display_name>Scale Footprint Area by the Floor Area?</display_name>
<display_name>Scale Footprint Area by the Floor Area</display_name>
<description>If true, the footprint area from GeoJSON will be scaled by the floor_area provided by the user in URBANopt.</description>
<type>Boolean</type>
<required>false</required>
Expand Down Expand Up @@ -114,7 +114,7 @@
<filename>README.md</filename>
<filetype>md</filetype>
<usage_type>readme</usage_type>
<checksum>74F54DC5</checksum>
<checksum>AA2D38B0</checksum>
</file>
<file>
<filename>README.md.erb</filename>
Expand All @@ -131,7 +131,7 @@
<filename>measure.rb</filename>
<filetype>rb</filetype>
<usage_type>script</usage_type>
<checksum>4B36EB4E</checksum>
<checksum>5D490083</checksum>
</file>
<file>
<filename>nrel_stm_footprints.geojson</filename>
Expand All @@ -143,13 +143,13 @@
<filename>shadowed_tests.rb</filename>
<filetype>rb</filetype>
<usage_type>test</usage_type>
<checksum>1AD96F0B</checksum>
<checksum>6F2F2CA8</checksum>
</file>
<file>
<filename>urban_geometry_creation_test.rb</filename>
<filetype>rb</filetype>
<usage_type>test</usage_type>
<checksum>CA11D7FF</checksum>
<checksum>81FF63D2</checksum>
</file>
</files>
</measure>
6 changes: 3 additions & 3 deletions lib/measures/urban_geometry_creation_zoning/measure.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<schema_version>3.1</schema_version>
<name>urban_geometry_creation_zoning</name>
<uid>96ea1317-76ac-4670-b51d-71ee3f4fdd65</uid>
<version_id>c1c0bf6d-92a2-4a69-9446-e3ebf392c376</version_id>
<version_modified>2023-07-06T15:57:24Z</version_modified>
<version_id>4d47bb3f-6e49-4309-a4e0-5f2c3748b947</version_id>
<version_modified>2023-11-20T17:10:01Z</version_modified>
<xml_checksum>D254E772</xml_checksum>
<class_name>UrbanGeometryCreationZoning</class_name>
<display_name>UrbanGeometryCreationZoning</display_name>
Expand Down Expand Up @@ -136,7 +136,7 @@
<filename>urban_geometry_creation_zoning_test.rb</filename>
<filetype>rb</filetype>
<usage_type>test</usage_type>
<checksum>5C631B7A</checksum>
<checksum>FC65E7CE</checksum>
</file>
</files>
</measure>
2 changes: 1 addition & 1 deletion lib/urbanopt/geojson/version.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@

module URBANopt
module GeoJSON
VERSION = '0.10.0'.freeze
VERSION = '0.11.0'.freeze
end
end
4 changes: 2 additions & 2 deletions urbanopt-geojson-gem.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ Gem::Specification.new do |spec|
spec.add_development_dependency 'simplecov', '~> 0.18.2'
spec.add_development_dependency 'simplecov-lcov', '~> 0.8.0'

spec.add_runtime_dependency 'json-schema', '~> 2.7'
spec.add_runtime_dependency 'urbanopt-core', '~> 0.10.0'
spec.add_runtime_dependency 'json-schema', '~> 2.8'
spec.add_runtime_dependency 'urbanopt-core', '~> 0.11.0'
end

0 comments on commit fe3b040

Please sign in to comment.