urbanopt-core 0.11.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04e8fc835d4d909cdd2d98231dc2f37e4b93c453adc4063861926c88a8801c2f
-  data.tar.gz: 4cfd41bcd04a8c44bc90ccb6169377320dfcb127fa5eb14bf39ac2baba78d949
+  metadata.gz: 5cd161e310c17d98c30e9dc46f2cec0f84f4f52d42f198e70187a141fe7302c7
+  data.tar.gz: 2e51a5becf77145b0f5da82a8af0258d2d4c8ea57c20c6db18a1db7dfcc5e6ff
 SHA512:
-  metadata.gz: 58f27fd266418977bab100dc9b0b5b4d3b3f235d47298acf8acb8c3f863a601c96b7dc8b967286f24657cc812c5948161feef4379b2310f703aaf168df79aedf
-  data.tar.gz: b1039dd9b3e43c580af2c3f9d6c415750d710e4eaeac1a9e7a07ca274af339d1ef3c58d6b4a4a65d9ebe90e0ebeef36d63587c5a3ca4754e43962259aba6dd3e
+  metadata.gz: d6d3ff0d274f36e4f70e749d05a826a655b8b99197c0cd3848e3c14180588d4a5837c095775e096c2d4998bd2b865f1d9423681d35b3025a0f6862a8455fc049
+  data.tar.gz: 11919cbdbf0f303672c574757a95dd76a52ce5187226f77838fbdad036e56f114d56adc8526d43b2774723caa78ff1d7a37258f7de32e2d572223ad3e4952a54

data/.github/workflows/nightly_build.yml

@@ -1,13 +1,12 @@
 name: Core-gem CI
 
 on:
-  # push:
+  push:
+  workflow_dispatch:
   schedule:
     # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule
     # 5 am UTC (11pm MDT the day before) every weekday night in MDT
-    - cron: '25 5 * * 2-6'
-  pull_request:
-    types: [review_requested]
+    - cron: "25 5 * * 2-6"
 
 env:
   # This env var should enforce develop branch of all dependencies
@@ -18,11 +17,13 @@ jobs:
   weeknight-tests:
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:3.7.0
+      image: docker://nrel/openstudio:3.9.0
     steps:
       - uses: actions/checkout@v4
       - name: Update gems
-        run: bundle update
+        run: |
+          bundle install
+          bundle update
       - name: Run Rspec
         run: bundle exec rspec
       # coveralls action docs: https://github.com/marketplace/actions/coveralls-github-action

data/.gitignore

@@ -5,6 +5,7 @@ Gemfile.lock
 /gems
 /_yardoc/
 /coverage/
+.coverage
 /doc/
 /pkg/
 /spec/reports/

data/CHANGELOG.md

@@ -1,44 +1,66 @@
 # URBANopt Core Gem
 
+## Version 1.0.0
+
+## Exciting New Features 🎉
+
+* Use openstudio 3.9.0 by @vtnate in https://github.com/urbanopt/urbanopt-core-gem/pull/60
+
+### Other Changes
+
+* Used the pinned version of regex-parser in openstudio-extension. by @wenyikuang in https://github.com/urbanopt/urbanopt-core-gem/pull/61
+
+## New Contributors
+
+* @wenyikuang made their first contribution in https://github.com/urbanopt/urbanopt-core-gem/pull/61
+
+**Full Changelog**: https://github.com/urbanopt/urbanopt-core-gem/compare/v0.11.0...v1.0.0
+
 ## Version 0.11.0
 
-## What's Changed
 ### Exciting New Features 🎉
+
 * More tests by @vtnate in https://github.com/urbanopt/urbanopt-core-gem/pull/55
 * Os37 by @vtnate in https://github.com/urbanopt/urbanopt-core-gem/pull/56
+
 ### Other Changes
+
 * remove Jenkinsfile by @vtnate in https://github.com/urbanopt/urbanopt-core-gem/pull/53
 * also run CI when a PR gets a review request by @vtnate in https://github.com/urbanopt/urbanopt-core-gem/pull/54
 
-
 **Full Changelog**: https://github.com/urbanopt/urbanopt-core-gem/compare/v0.10.0...v0.11.0
 
 ## Version 0.10.0
+
 Date Range: 12/12/22 - 07/19/23
 
-- Update dependencies for OpenStudio 3.6.0
-- Update license and references to the license file
-- Remove outdated Travis CI config file
+* Update dependencies for OpenStudio 3.6.0
+* Update license and references to the license file
+* Remove outdated Travis CI config file
 
 ## Version 0.9.0
+
 Date Range: 04/22/22 - 12/12/22
 
-- Update dependencies for OpenStudio 3.5.0
+* Update dependencies for OpenStudio 3.5.0
 
 ## Version 0.8.0
+
 Date Range: 11/23/21 - 04/21/22
 
-- Fixed [#41]( https://github.com/urbanopt/urbanopt-core-gem/pull/41 ), Update licenses
+* Fixed [#41]( https://github.com/urbanopt/urbanopt-core-gem/pull/41 ), Update licenses
 
 ## Version 0.7.0
+
 Date Range: 07/02/21 - 11/22/21
 
-- Updated dependencies for OpenStudio 3.3.0
+* Updated dependencies for OpenStudio 3.3.0
 
 ## Version 0.6.1
+
 Date Range: 04/27/21 - 07/01/21
 
-- Fixed [#37]( https://github.com/urbanopt/urbanopt-core-gem/pull/37 ), update rubocop configs to v4
+* Fixed [#37]( https://github.com/urbanopt/urbanopt-core-gem/pull/37 ), update rubocop configs to v4
 
 ## Version 0.6.0
 
@@ -50,8 +72,8 @@ Updated dependencies for OpenStudio 3.2.0 (Ruby 2.7)
 
 Date Range: 11/26/20 - 12/08/20
 
-- Fixed [#15]( https://github.com/urbanopt/urbanopt-core-gem/issues/15 ), Updated urbanopt-reopt-example-project to simulate and generate results for multiple PVs
-- Fixed [#30]( https://github.com/urbanopt/urbanopt-core-gem/issues/30 ), Update extension-gem dependency
+* Fixed [#15]( https://github.com/urbanopt/urbanopt-core-gem/issues/15 ), Updated urbanopt-reopt-example-project to simulate and generate results for multiple PVs
+* Fixed [#30]( https://github.com/urbanopt/urbanopt-core-gem/issues/30 ), Update extension-gem dependency
 
 ## Version 0.5.0
 
@@ -63,16 +85,15 @@ Updated dependencies for OpenStudio 3.1.0
 
 Date Range: 06/05/20 - 09/17/20
 
-- Fixed [#7]( https://github.com/urbanopt/urbanopt-core-gem/issues/7 ), Remove travis in favor of Jenkins
-- Fixed [#24]( https://github.com/urbanopt/urbanopt-core-gem/issues/24 ), Chore: Add TM to first mention URBANopt on LICENSE file and LICENSE section
-
+* Fixed [#7]( https://github.com/urbanopt/urbanopt-core-gem/issues/7 ), Remove travis in favor of Jenkins
+* Fixed [#24]( https://github.com/urbanopt/urbanopt-core-gem/issues/24 ), Chore: Add TM to first mention URBANopt on LICENSE file and LICENSE section
 
 ## Version 0.3.0
 
 Date Range: 03/31/20 - 06/04/20
 
-- Updated dependencies for ruby 2.5.x and OpenStudio 3.x
-- Remove old changelog script functionality in favor of new extension-gem functionality (can be run via rake task)
+* Updated dependencies for ruby 2.5.x and OpenStudio 3.x
+* Remove old changelog script functionality in favor of new extension-gem functionality (can be run via rake task)
 
 ## Version 0.2.0
 
@@ -81,9 +102,10 @@ URBANopt Core Gem version 0.2.0 include minor updates to dependencies and update
 Date Range: 12/27/19 - 03/31/20
 
 Closed Issues and Features
-- Fixed [#11]( https://github.com/urbanopt/urbanopt-core-gem/pull/11 ), Use URBANopt standard contributing guidelines
-- Fixed [#13]( https://github.com/urbanopt/urbanopt-core-gem/pull/13 ), updating copyrights
-- Fixed [#14]( https://github.com/urbanopt/urbanopt-core-gem/pull/14 ), set ruby and extension gem versions
+
+* Fixed [#11]( https://github.com/urbanopt/urbanopt-core-gem/pull/11 ), Use URBANopt standard contributing guidelines
+* Fixed [#13]( https://github.com/urbanopt/urbanopt-core-gem/pull/13 ), updating copyrights
+* Fixed [#14]( https://github.com/urbanopt/urbanopt-core-gem/pull/14 ), set ruby and extension gem versions
 
 ## Version 0.1.1 (unreleased)
 

data/Gemfile

@@ -11,11 +11,6 @@ gemspec
 # checkout the latest version (develop) from github.
 allow_local = ENV['FAVOR_LOCAL_GEMS']
 
-# pin this dependency to avoid unicode_normalize error
-gem 'addressable', '2.8.1'
-# pin this dependency to avoid using racc dependency (which has native extensions)
-gem 'parser', '3.2.2.2'
-
 # if allow_local && File.exist?('../OpenStudio-extension-gem')
 #   gem 'openstudio-extension', path: '../OpenStudio-extension-gem'
 # elsif allow_local

data/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt (tm), Copyright (c) 2019-2024, Alliance for Sustainable Energy, LLC, and other
+URBANopt (tm), Copyright (c) 2019-2025, Alliance for Sustainable Energy, LLC, and other
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/README.md

@@ -13,19 +13,23 @@ Add this line to your application's Gemfile:
 gem 'urbanopt-core'
 ```
 
-And then execute:
+And then in the terminal, execute:
 
-    $ bundle
+```terminal
+    bundle
+```
 
 Or install it yourself as:
 
-    $ gem install 'urbanopt-core'
+```terminal
+    gem install 'urbanopt-core'
+```
 
 ## Usage
 
 This Extension Gem stores the base information needed for all derivative URBANopt extension gems.
 
-# Releasing
+## Releasing
 
 * Update CHANGELOG.md
 * Run `rake rubocop:auto_correct`

data/doc_templates/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt (tm), Copyright (c) 2019-2024, Alliance for Sustainable Energy, LLC, and other
+URBANopt (tm), Copyright (c) 2019-2025, Alliance for Sustainable Energy, LLC, and other
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/doc_templates/copyright_erb.txt

@@ -1,6 +1,6 @@
 <%
   # *********************************************************************************
-  # URBANopt (tm), Copyright (c) 2019-2024, Alliance for Sustainable Energy, LLC, and other
+  # URBANopt (tm), Copyright (c) 2019-2025, Alliance for Sustainable Energy, LLC, and other
   # contributors. All rights reserved.
 
   # Redistribution and use in source and binary forms, with or without modification,

data/lib/measures/urbanopt-core-test-measure/LICENSE.md

@@ -0,0 +1,42 @@
+URBANopt (tm), Copyright (c) 2019-2025, Alliance for Sustainable Energy, LLC, and other
+contributors. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list
+of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright notice, this
+list of conditions and the following disclaimer in the documentation and/or other
+materials provided with the distribution.
+
+Neither the name of the copyright holder nor the names of its contributors may be
+used to endorse or promote products derived from this software without specific
+prior written permission.
+
+Redistribution of this software, without modification, must refer to the software
+by the same designation. Redistribution of a modified version of this software
+(i) may not refer to the modified version by the same designation, or by any
+confusingly similar designation, and (ii) must refer to the underlying software
+originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+the term “URBANopt”, or any confusingly similar designation may not be used to
+refer to any modified version of this software or any modified version of the
+underlying software originally provided by Alliance without the prior written
+consent of Alliance.
+
+The name of the copyright holder(s), any contributors, the United States Government,
+the United States Department of Energy, or any of their employees may not be used to
+endorse or promote products derived from this software without specific prior written
+permission from the respective party.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED STATES
+DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/measures/urbanopt-core-test-measure/README.md

@@ -0,0 +1,40 @@
+
+
+###### (Automatically generated documentation)
+
+# URBANopt Core Test Measure
+
+## Description
+This measure is just a test of Urbanopt Core measure. it adds a meter at the requested reporting frequency.
+
+## Modeler Description
+The measure just passes in the string and does not validate that it is a proper meter name. It is up to the user to know this or to look at the .mdd file from a previous simulation run.
+
+## Measure Type
+ModelMeasure
+
+## Taxonomy
+
+
+## Arguments
+
+
+### Enter Meter Name
+
+**Name:** meter_name,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Reporting Frequency
+
+**Name:** reporting_frequency,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+
+
+

data/lib/measures/urbanopt-core-test-measure/README.md.erb

@@ -0,0 +1,42 @@
+<%#= README.md.erb is used to auto-generate README.md. %>
+<%#= To manually maintain README.md throw away README.md.erb and manually edit README.md %>
+###### (Automatically generated documentation)
+
+# <%= name %>
+
+## Description
+<%= description %>
+
+## Modeler Description
+<%= modelerDescription %>
+
+## Measure Type
+<%= measureType %>
+
+## Taxonomy
+<%= taxonomy %>
+
+## Arguments
+
+<% arguments.each do |argument| %>
+### <%= argument[:display_name] %>
+<%= argument[:description] %>
+**Name:** <%= argument[:name] %>,
+**Type:** <%= argument[:type] %>,
+**Units:** <%= argument[:units] %>,
+**Required:** <%= argument[:required] %>,
+**Model Dependent:** <%= argument[:model_dependent] %>
+<% end %>
+
+<% if arguments.size == 0 %>
+<%= "This measure does not have any user arguments" %>
+<% end %>
+
+<% if outputs.size > 0 %>
+## Outputs
+<% output_names = [] %>
+<% outputs.each do |output| %>
+<% output_names << output[:display_name] %>
+<% end %>
+<%= output_names.join(", ") %>
+<% end %>

data/lib/measures/urbanopt-core-test-measure/measure.rb

@@ -0,0 +1,109 @@
+# *********************************************************************************
+# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://github.com/urbanopt/urbanopt-core-gem/blob/develop/LICENSE.md
+# *********************************************************************************
+
+# see the URL below for information on how to write OpenStudio measures
+# http://openstudio.nrel.gov/openstudio-measure-writing-guide
+
+# see the URL below for access to C++ documentation on mondel objects (click on "model" in the main window to view model objects)
+# http://openstudio.nrel.gov/sites/openstudio.nrel.gov/files/nv_data/cpp_documentation_it/model/html/namespaces.html
+
+# start the measure
+class UrbanoptCoreTestMeasure < OpenStudio::Measure::ModelMeasure
+  # define the name that a user will see, this method may be deprecated as
+  # the display name in PAT comes from the name field in measure.xml
+  def name
+    return 'URBANopt Core Test Measure'
+  end
+
+  # human readable description
+  def description
+    return 'This measure is just a test of Urbanopt Core measure. it adds a meter at the requested reporting frequency.'
+  end
+
+  # human readable description of modeling approach
+  def modeler_description
+    return 'The measure just passes in the string and does not validate that it is a proper meter name. It is up to the user to know this or to look at the .mdd file from a previous simulation run.'
+  end
+
+  # define the arguments that the user will input
+  def arguments(model)
+    args = OpenStudio::Measure::OSArgumentVector.new
+
+    # make an argument for the meter name
+    meter_name = OpenStudio::Measure::OSArgument.makeStringArgument('meter_name', true)
+    meter_name.setDisplayName('Enter Meter Name')
+    meter_name.setDefaultValue('Electricity:Facility')
+    args << meter_name
+
+    # make an argument for the electric tariff
+    reporting_frequency_chs = OpenStudio::StringVector.new
+    reporting_frequency_chs << 'detailed'
+    reporting_frequency_chs << 'timestep'
+    reporting_frequency_chs << 'hourly'
+    reporting_frequency_chs << 'daily'
+    reporting_frequency_chs << 'monthly'
+    reporting_frequency = OpenStudio::Measure::OSArgument.makeChoiceArgument('reporting_frequency', reporting_frequency_chs, true)
+    reporting_frequency.setDisplayName('Reporting Frequency')
+    reporting_frequency.setDefaultValue('hourly')
+    args << reporting_frequency
+
+    return args
+  end
+
+  # define what happens when the measure is run
+  def run(model, runner, user_arguments)
+    super(model, runner, user_arguments)
+
+    # use the built-in error checking
+    if !runner.validateUserArguments(arguments(model), user_arguments)
+      return false
+    end
+
+    # assign the user inputs to variables
+    meter_name = runner.getStringArgumentValue('meter_name', user_arguments)
+    reporting_frequency = runner.getStringArgumentValue('reporting_frequency', user_arguments)
+
+    # check the user_name for reasonableness
+    if meter_name == ''
+      runner.registerError('No meter name was entered.')
+      return false
+    end
+
+    meters = model.getOutputMeters
+    # reporting initial condition of model
+    runner.registerInitialCondition("The model started with #{meters.size} meter objects.")
+
+    # flag to add meter
+    add_flag = true
+
+    # OpenStudio doesn't seemt to like two meters of the same name, even if they have different reporting frequencies.
+    meters.each do |meter|
+      if meter.name == meter_name
+        runner.registerWarning("A meter named #{meter_name} already exists. One will not be added to the model.")
+        if meter.reportingFrequency != reporting_frequency
+          meter.setReportingFrequency(reporting_frequency)
+          runner.registerInfo("Changing reporting frequency of existing meter to #{reporting_frequency}.")
+        end
+        add_flag = false
+      end
+    end
+
+    if add_flag
+      meter = OpenStudio::Model::OutputMeter.new(model)
+      meter.setName(meter_name)
+      meter.setReportingFrequency(reporting_frequency)
+      runner.registerInfo("Adding meter for #{meter.name} reporting #{reporting_frequency}")
+    end
+
+    meters = model.getOutputMeters
+    # reporting final condition of model
+    runner.registerFinalCondition("The model finished with #{meters.size} meter objects.")
+
+    return true
+  end
+end
+
+# this allows the measure to be use by the application
+UrbanoptCoreTestMeasure.new.registerWithApplication

data/lib/measures/urbanopt-core-test-measure/measure.xml

@@ -0,0 +1,117 @@
+<?xml version="1.0"?>
+<measure>
+  <schema_version>3.1</schema_version>
+  <name>urbanopt_core_test_measure</name>
+  <uid>3e11f20d-88a8-44eb-a951-4f8cf8a09ccd</uid>
+  <version_id>a8297a21-bb02-432c-910e-69222d8fa0f6</version_id>
+  <version_modified>2024-11-08T17:31:22Z</version_modified>
+  <xml_checksum>0CA4D54C</xml_checksum>
+  <class_name>UrbanoptCoreTestMeasure</class_name>
+  <display_name>URBANopt Core Test Measure</display_name>
+  <description>This measure is just a test of Urbanopt Core measure. it adds a meter at the requested reporting frequency.</description>
+  <modeler_description>The measure just passes in the string and does not validate that it is a proper meter name. It is up to the user to know this or to look at the .mdd file from a previous simulation run.</modeler_description>
+  <arguments>
+    <argument>
+      <name>meter_name</name>
+      <display_name>Enter Meter Name</display_name>
+      <type>String</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>Electricity:Facility</default_value>
+    </argument>
+    <argument>
+      <name>reporting_frequency</name>
+      <display_name>Reporting Frequency</display_name>
+      <type>Choice</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>hourly</default_value>
+      <choices>
+        <choice>
+          <value>detailed</value>
+          <display_name>detailed</display_name>
+        </choice>
+        <choice>
+          <value>timestep</value>
+          <display_name>timestep</display_name>
+        </choice>
+        <choice>
+          <value>hourly</value>
+          <display_name>hourly</display_name>
+        </choice>
+        <choice>
+          <value>daily</value>
+          <display_name>daily</display_name>
+        </choice>
+        <choice>
+          <value>monthly</value>
+          <display_name>monthly</display_name>
+        </choice>
+      </choices>
+    </argument>
+  </arguments>
+  <outputs />
+  <provenances />
+  <tags>
+    <tag>Reporting.QAQC</tag>
+  </tags>
+  <attributes>
+    <attribute>
+      <name>Measure Type</name>
+      <value>ModelMeasure</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Measure Function</name>
+      <value>Measure</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Requires EnergyPlus Results</name>
+      <value>false</value>
+      <datatype>boolean</datatype>
+    </attribute>
+    <attribute>
+      <name>Uses SketchUp API</name>
+      <value>false</value>
+      <datatype>boolean</datatype>
+    </attribute>
+  </attributes>
+  <files>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>D2F2365A</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>0EA09A41</checksum>
+    </file>
+    <file>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>703C9964</checksum>
+    </file>
+    <file>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>2.0.0</identifier>
+        <min_compatible>2.0.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>7C4E6482</checksum>
+    </file>
+    <file>
+      <filename>urbanopt_core_test_measure_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>FC45981D</checksum>
+    </file>
+  </files>
+</measure>

data/lib/measures/urbanopt-core-test-measure/tests/urbanopt_core_test_measure_test.rb

@@ -0,0 +1,83 @@
+# *********************************************************************************
+# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://github.com/urbanopt/urbanopt-core-gem/blob/develop/LICENSE.md
+# *********************************************************************************
+
+require 'openstudio'
+require 'openstudio/measure/ShowRunnerOutput'
+require 'fileutils'
+
+require_relative '../measure'
+require 'minitest/autorun'
+
+class UrbanoptCoreTestMeasureTest < Minitest::Test
+  def test_urbanopt_core_test_measure_bad_input
+    # create an instance of the measure
+    measure = UrbanoptCoreTestMeasure.new
+
+    # create an instance of a runner
+    runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
+
+    # make an empty model
+    model = OpenStudio::Model::Model.new
+
+    # get arguments and test that they are what we are expecting
+    arguments = measure.arguments(model)
+    assert_equal(2, arguments.size)
+    assert_equal('meter_name', arguments[0].name)
+    assert_equal('reporting_frequency', arguments[1].name)
+
+    # set argument values to bad values and run the measure
+    argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
+    meter_name = arguments[0].clone
+    assert(meter_name.setValue(''))
+    argument_map['meter_name'] = meter_name
+    measure.run(model, runner, argument_map)
+    result = runner.result
+    assert(result.value.valueName == 'Fail')
+  end
+
+  def test_urbanopt_core_test_measure_good_input
+    # create an instance of the measure
+    measure = UrbanoptCoreTestMeasure.new
+
+    # create an instance of a runner
+    runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
+
+    # make an empty model
+    model = OpenStudio::Model::Model.new
+
+    # get arguments and test that they are what we are expecting
+    arguments = measure.arguments(model)
+
+    # set argument values to good values and run the measure on model with spaces
+    argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
+    meter_name = arguments[0].clone
+    assert(meter_name.setValue('JustATest'))
+    argument_map['meter_name'] = meter_name
+    reporting_frequency = arguments[1].clone
+    assert(reporting_frequency.setValue('hourly'))
+    argument_map['reporting_frequency'] = reporting_frequency
+    measure.run(model, runner, argument_map)
+    result = runner.result
+    show_output(result)
+    assert(result.value.valueName == 'Success')
+    assert(result.warnings.empty?)
+    assert(result.info.size == 1)
+
+    # attempt to add a second meter
+    # create an instance of the measure
+    measure = UrbanoptCoreTestMeasure.new
+
+    # create an instance of a runner
+    runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
+
+    measure.run(model, runner, argument_map)
+
+    result = runner.result
+    show_output(result)
+    assert(result.value.valueName == 'Success')
+    assert(result.warnings.size == 1)
+    assert(result.info.empty?)
+  end
+end

data/lib/urbanopt/core/version.rb

@@ -5,6 +5,6 @@
 
 module URBANopt
   module Core
-    VERSION = '0.11.0'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

data/urbanopt-core-gem.gemspec

@@ -19,13 +19,13 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '~> 2.7.0'
+  # We support exactly Ruby v3.2.2 because os-extension requires bundler==2.4.10 and that requires Ruby 3.2.2: https://stdgems.org/bundler/
+  # It would be nice to be able to use newer patches of Ruby 3.2, which would require os-extension to relax its dependency on bundler.
+  spec.required_ruby_version = '3.2.2'
 
-  spec.add_development_dependency 'bundler', '~> 2.1'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.9'
-  spec.add_development_dependency 'simplecov', '~> 0.18.2'
-  spec.add_development_dependency 'simplecov-lcov', '~> 0.8.0'
+  spec.add_development_dependency 'rspec', '~> 3.13'
+  spec.add_development_dependency 'simplecov', '0.22.0'
+  spec.add_development_dependency 'simplecov-lcov', '0.8.0'
 
-  spec.add_dependency 'openstudio-extension', '~> 0.7.1'
+  spec.add_dependency 'openstudio-extension', '~> 0.8.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-core
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Dan Macumber
@@ -9,76 +9,48 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2025-01-22 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.2
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.2
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.8.0
 - !ruby/object:Gem::Dependency
@@ -87,14 +59,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.8.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.8.3
 description: URBANopt core library and measures
 email:
 - nicholas.long@nrel.gov
@@ -120,6 +92,12 @@ files:
 - doc_templates/copyright_ruby.txt
 - lib/measures/.gitkeep
 - lib/measures/.rubocop.yml
+- lib/measures/urbanopt-core-test-measure/LICENSE.md
+- lib/measures/urbanopt-core-test-measure/README.md
+- lib/measures/urbanopt-core-test-measure/README.md.erb
+- lib/measures/urbanopt-core-test-measure/measure.rb
+- lib/measures/urbanopt-core-test-measure/measure.xml
+- lib/measures/urbanopt-core-test-measure/tests/urbanopt_core_test_measure_test.rb
 - lib/urbanopt/core.rb
 - lib/urbanopt/core/extension.rb
 - lib/urbanopt/core/feature.rb
@@ -135,16 +113,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - '='
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: URBANopt core library and measures