openstudio-calibration 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7194dfd20a78327be74f86f736c0bf86d7d13a63e8a6efbd27b962d711c11553
-  data.tar.gz: d05a98095f956bcd2951f66d8e7f22c697e4744ad3a1c308587c7ffb1626e687
+  metadata.gz: 333b762599adb79b796439d113959cc6925c82d8e4efed47579aec7ce2748394
+  data.tar.gz: 50bc1780606d0a715692e305f6b3a29b196965b91abb109ce534e46d688d43af
 SHA512:
-  metadata.gz: 1d343cc7da0a62b54e7509e014bd88c1bcea4477c624580f8425c4610b7b750ef7ae83254e876241161986253f807536e4791abb0430672f7aec27429d15f8f4
-  data.tar.gz: 471684d460cc78da4319df65734f3268148f215c0394643e15beaf1f9b4c389dfe0938dd695d76b04c620f455f14893de153f2ec9f008161be9613840f073f8b
+  metadata.gz: 6316a5449e432e7615f77681ecfd28d6773f6e3ee25633f2a8ca38ae177563a78909fd2f2c2ec9ff689a813709f67db0f43116a162f641fbe26e540073196d5e
+  data.tar.gz: 45c713f0c6a32482532b4012654af15d942a4674394f16e9acd2df806fb287e3c2e23472af18427778c294fda68dd25734d467c7c358bc32cadda9dc97a5a7cc

data/.gitignore

@@ -28,3 +28,4 @@
 lib/measures/.rubocop.yml
 lib/test/*
 test_results/
+/lib/measures/*/output/

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
   Exclude:
     - 'spec/test_measures/**/*'
+
+require: rubocop-performance
 inherit_from:
-  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v3.yml
+    - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v4.yml

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # OpenStudio Calibration Measures Gem
 
+## Version 0.6.0
+* Support for OpenStudio 3.4 (upgrade to standards gem 0.2.16, no extension gem upgrade)
+
+## Version 0.5.1
+* Fixed [#24]( https://github.com/NREL/openstudio-calibration-gem/pull/24 ), HardSizeHvac: undefined method `runSizingRun'
+* Fixed [#42]( https://github.com/NREL/openstudio-calibration-gem/pull/42 ), Update reporting measures in repo to pass in model = nil
+* Fixed [#43]( https://github.com/NREL/openstudio-calibration-gem/pull/43 ), Check all measures in this repo for multiple tags
+
+## Version 0.5.0
+* Support for OpenStudio 3.3 (upgrade to extension gem 0.5.1 and standards gem 0.2.15)
+- Fixed [#35]( https://github.com/NREL/openstudio-calibration-gem/pull/35 ), adding compatibility matrix and contribution policy
+- Fixed [#38]( https://github.com/NREL/openstudio-calibration-gem/pull/38 ), Add hoo var method argment to change hours of operation measure
+
 ## Version 0.4.0
 
 * Support Ruby ~> 2.7

data/Jenkinsfile

@@ -1,10 +1,11 @@
 //Jenkins pipelines are stored in shared libraries. Please see: https://github.com/NREL/cbci_jenkins_libs
-
+ 
 @Library('cbci_shared_libs') _
 
-// Build for PR to develop branch only.
+// Build for PR to develop branch only. 
 if ((env.CHANGE_ID) && (env.CHANGE_TARGET) ) { // check if set
 
   openstudio_extension_gems()
+    
+}
 
-}

data/README.md

@@ -20,16 +20,32 @@ Or install it yourself as:
 
     $ gem install 'openstudio-calibration'
 
-## Usage
+# Compatibility Matrix
+
+|OpenStudio Calibration Gem|OpenStudio|Ruby|
+|:--------------:|:----------:|:--------:|
+| 0.6.0  | 3.4      | 2.7    |
+| 0.5.0  | 3.3      | 2.7    |
+| 0.4.0 - 0.4.2  | 3.2      | 2.7    |
+| 0.3.0 - 0.3.1  | 3.1      | 2.5    |
+| 0.2.0   | 3.0      | 2.5    |
+| 0.1.4 and below | 2.9 and below      | 2.2.4    |
+
+# Contributing 
+
+Please review the [OpenStudio Contribution Policy](https://openstudio.net/openstudio-contribution-policy) if you would like to contribute code to this gem.
 
-To be filled out later.
 
 # Releasing
 
 * Update CHANGELOG.md
-* Run `rake rubocop:auto_correct`
+* Run `rake openstudio:rubocop:auto_correct`
+* Run `rake openstudio:update_copyright`
+* Run `rake openstudio:update_measures` (this has to be done last since prior tasks alter measure files)
+* Update version in `readme.md`
+* Update version in `openstudio-calibration-measures.gemspec`
 * Update version in `/lib/openstudio/calibration_measures/version.rb`
 * Create PR to master, after tests and reviews complete, then merge
 * Locally - from the master branch, run `rake release`
-* 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 description box.
+* 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 description box.
 

data/lib/measures/CalibrationReports/measure.xml

@@ -1,7 +1,6 @@
 <?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
-  <error>wrong number of arguments (given 1, expected 0)</error>
   <name>calibration_reports</name>
   <uid>2baede0a-65f3-47ec-b5f6-9c21d0f91aff</uid>
   <version_id>63aaeb4e-fd54-483b-92f4-7a5d893986bd</version_id>

data/lib/measures/ExteriorWallThermalPropertiesMultiplier/measure.xml

@@ -3,9 +3,9 @@
   <schema_version>3.0</schema_version>
   <name>exterior_wall_thermal_properties_multiplier</name>
   <uid>6ab39cf2-1f9e-4570-a797-360a814aaa74</uid>
-  <version_id>f6eb026d-b992-42cc-a11e-f6d8f2794127</version_id>
-  <version_modified>20210304T152734Z</version_modified>
-  <xml_checksum>31085437</xml_checksum>
+  <version_id>cc91b451-1ab1-4b68-9bef-d4e7575e6500</version_id>
+  <version_modified>20220223T012552Z</version_modified>
+  <xml_checksum>EB1A0C08</xml_checksum>
   <class_name>ExteriorWallThermalPropertiesMultiplier</class_name>
   <display_name>Exterior Wall Thermal Properties Multiplier</display_name>
   <description>Change exterior walls by altering the thermal resistance, density, and solar absorptance of the wall constructions by a Multiplier</description>
@@ -40,7 +40,6 @@
   <provenances />
   <tags>
     <tag>Envelope.Opaque</tag>
-    <tag>Calibration</tag>
   </tags>
   <attributes>
     <attribute>

data/lib/measures/ExteriorWallThermalPropertiesPercentChange/measure.xml

@@ -3,9 +3,9 @@
   <schema_version>3.0</schema_version>
   <name>exterior_wall_thermal_properties_percent_change</name>
   <uid>6ab39cf2-1f9e-4570-a797-360a814aaa64</uid>
-  <version_id>90e96c89-f488-4f6a-a12d-1f15e0c3f304</version_id>
-  <version_modified>20210304T152734Z</version_modified>
-  <xml_checksum>31085437</xml_checksum>
+  <version_id>900fc466-62cd-4726-8917-164d0e5c670f</version_id>
+  <version_modified>20220223T012552Z</version_modified>
+  <xml_checksum>EB1A0C08</xml_checksum>
   <class_name>ExteriorWallThermalPropertiesPercentChange</class_name>
   <display_name>Exterior Wall Thermal Percent Change</display_name>
   <description>Change exterior walls by altering the thermal resistance, density, and solar absorptance of the wall constructions by a Percent Change</description>
@@ -40,7 +40,6 @@
   <provenances />
   <tags>
     <tag>Envelope.Opaque</tag>
-    <tag>Calibration</tag>
   </tags>
   <attributes>
     <attribute>

data/lib/measures/HardSizeHvac/measure.rb

@@ -66,13 +66,15 @@ class HardSizeHVAC < OpenStudio::Measure::ModelMeasure
   def run(model, runner, user_arguments)
     super(model, runner, user_arguments)
 
-    # Require the HVAC sizing library
-    # require_relative 'resources/HVACSizing.Model'
+    # Make the standard applier
+    standard = Standard.build('90.1-2004') # template choice doesn't matter
 
-    # Run a sizing run and attach the resulting
-    # sql file to the model.  Hard sizing methods
-    # won't work unless the model has a sql file.
-    model.runSizingRun(Dir.pwd.to_s)
+    # Perform a sizing run (2.5.1 and later)
+    sizing_run_path = OpenStudio::Path.new(File.dirname(__FILE__) + '/output/SR1').to_s
+    runner.registerInfo("Performing sizing run at #{sizing_run_path}.")
+    if standard.model_run_sizing_run(model, sizing_run_path) == false
+      return false
+    end
 
     # Hard sizing every object in the model.
     model.applySizingValues

data/lib/measures/HardSizeHvac/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>hard_size_hvac</name>
   <uid>d7da749f-6318-4077-b502-25994a713b27</uid>
-  <version_id>962f9f66-5795-4157-a3ee-7a335d81b576</version_id>
-  <version_modified>20210304T152734Z</version_modified>
+  <version_id>0647d2b3-e8b0-4529-962f-dbb85d4945fa</version_id>
+  <version_modified>20220223T145950Z</version_modified>
   <xml_checksum>2B526343</xml_checksum>
   <class_name>HardSizeHVAC</class_name>
   <display_name>Hard Size HVAC</display_name>
@@ -71,12 +71,24 @@
       <version>
         <software_program>OpenStudio</software_program>
         <identifier>1.5.0</identifier>
-        <min_compatible>1.5.0</min_compatible>
+        <min_compatible>2.5.1</min_compatible>
       </version>
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>63C57B08</checksum>
+      <checksum>0920138B</checksum>
+    </file>
+    <file>
+      <filename>small_office.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>0FB2ACC8</checksum>
+    </file>
+    <file>
+      <filename>hard_size_hvac_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>FA5BB28D</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/RoofThermalPropertiesMultiplier/measure.xml

@@ -3,9 +3,9 @@
   <schema_version>3.0</schema_version>
   <name>roof_thermal_properties_multiplier</name>
   <uid>6c4eb22b-770f-456c-bcd1-084cfad89eeb</uid>
-  <version_id>9bd50108-91e3-43b5-a78e-8ccc0217b3af</version_id>
-  <version_modified>20210304T152739Z</version_modified>
-  <xml_checksum>31085437</xml_checksum>
+  <version_id>5fbeb5c9-bf38-4798-876e-ec5f23962ef0</version_id>
+  <version_modified>20220223T012552Z</version_modified>
+  <xml_checksum>EB1A0C08</xml_checksum>
   <class_name>RoofThermalPropertiesMultiplier</class_name>
   <display_name>Roof Thermal Properties Multiplier</display_name>
   <description>Change Roof by altering the thermal resistance, density, and solar absorptance of the wall constructions by a Multiplier</description>
@@ -40,7 +40,6 @@
   <provenances />
   <tags>
     <tag>Envelope.Opaque</tag>
-    <tag>Calibration</tag>
   </tags>
   <attributes>
     <attribute>

data/lib/measures/RoofThermalPropertiesPercentChange/measure.xml

@@ -3,9 +3,9 @@
   <schema_version>3.0</schema_version>
   <name>roof_thermal_properties_percent_change</name>
   <uid>07516685-60fd-4da8-9872-1154a995047d</uid>
-  <version_id>aa00c9cc-3008-44d9-90c8-a50bac1cec43</version_id>
-  <version_modified>20210304T152739Z</version_modified>
-  <xml_checksum>31085437</xml_checksum>
+  <version_id>19d0d728-74c8-4344-94ea-af1f1e406f16</version_id>
+  <version_modified>20220223T012552Z</version_modified>
+  <xml_checksum>EB1A0C08</xml_checksum>
   <class_name>RoofThermalPropertiesPercentChange</class_name>
   <display_name>Roof Thermal Properties Percent Change</display_name>
   <description>Change Roof by altering the thermal resistance, density, and solar absorptance of the wall constructions by a Percent Change</description>
@@ -40,7 +40,6 @@
   <provenances />
   <tags>
     <tag>Envelope.Opaque</tag>
-    <tag>Calibration</tag>
   </tags>
   <attributes>
     <attribute>

data/lib/measures/TimeseriesObjectiveFunction/README.md

@@ -2,16 +2,16 @@
 
 ###### (Automatically generated documentation)
 
-# 
+# TimeSeries Objective Function
 
 ## Description
-
+Creates Objective Function from Timeseries Data
 
 ## Modeler Description
-
+Creates Objective Function from Timeseries Data.  The measure applies a Norm at each timestep between the difference of CSV metered data and SQL model data. A timeseries plot can also be created.  Possible outputs are 'cvrmse', 'nmbe', 'simdata' = sum of the simulated data, 'csvdata' = sum of metered data, 'diff' = P Norm between the metered and simulated data if Norm is 1 or 2, else its just the Difference.
 
 ## Measure Type
-ModelMeasure
+ReportingMeasure
 
 ## Taxonomy
 
@@ -19,9 +19,175 @@ ModelMeasure
 ## Arguments
 
 
+### Path to CSV file for the metered data
+Path to CSV file including file name.
+**Name:** csv_name,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### CSV Time Header
+CSV Time Header Value. Used to determine the timestamp column in the CSV file
+**Name:** csv_time_header,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### CSV variable name
+CSV variable name. Used to determine the variable column in the CSV file
+**Name:** csv_var,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Convert Units
+Convert Units in Metered Data
+**Name:** convert_data,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### CSV variable display name
+CSV variable display name. Not yet Implemented
+**Name:** csv_var_dn,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Year in csv data timestamp
+Is the Year in the csv data timestamp => mm:dd:yy or mm:dd (true/false)
+**Name:** year,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Seconds in csv data timestamp
+Is the Seconds in the csv data timestamp => hh:mm:ss or hh:mm (true/false)
+**Name:** seconds,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### SQL key value
+SQL key value for the SQL query to find the variable in the SQL file
+**Name:** key_value,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### TimeSeries Name
+TimeSeries Name for the SQL query to find the variable in the SQL file
+**Name:** timeseries_name,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Reporting Frequency
+Reporting Frequency for SQL Query
+**Name:** reporting_frequency,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Environment Period
+Environment Period for SQL query
+**Name:** environment_period,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Norm of the difference of csv and sql
+Norm of the difference of csv and sql. 1 is absolute value. 2 is euclidean distance. 3 is raw difference.
+**Name:** norm,
+**Type:** Double,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Scale factor to apply to the difference
+Scale factor to apply to the difference (1 is no scale)
+**Name:** scale,
+**Type:** Double,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Find Available data in the SQL file
+Will RegisterInfo all the 'EnvPeriod', 'ReportingFrequencies', 'VariableNames', 'KeyValues' in the SQL file.  Useful for debugging SQL issues.
+**Name:** find_avail,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### algorithm_download
+Make JSON data available for algorithm_download (true/false)
+**Name:** algorithm_download,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### plot_flag timeseries data
+Create plot of timeseries data (true/false)
+**Name:** plot_flag,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Plot name
+Name to include in reporting file name.
+**Name:** plot_name,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### verbose_messages
+verbose messages.  Useful for debugging but MAJOR Performance Hit.
+**Name:** verbose_messages,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### warning_messages
+Warn on missing data.
+**Name:** warning_messages,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### add_first_zero_for_plots
+Add a point of zero value to the plot at the beginning of the runperiod.
+**Name:** add_first_zero_for_plots,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### add_last_zero_for_plots
+Add a point of zero value to the plot at the end of the runperiod.
+**Name:** add_last_zero_for_plots,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
 
 
-This measure does not have any user arguments
 
 
 

data/lib/measures/TimeseriesObjectiveFunction/measure.rb

@@ -59,7 +59,7 @@ class TimeseriesObjectiveFunction < OpenStudio::Measure::ReportingMeasure
   end
 
   # define the arguments that the user will input
-  def arguments
+  def arguments(model = nil)
     args = OpenStudio::Measure::OSArgumentVector.new
 
     # the name of the sql file