urbanopt-reporting 0.7.0 → 0.9.0

data/lib/measures/.rubocop.yml

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

data/lib/measures/default_feature_reports/LICENSE.md

@@ -1,27 +1,32 @@
-URBANopt (tm), Copyright (c) 2019-2020, 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, 
+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 
+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 
+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 
+
+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.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 OR CONTRIBUTORS 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.
+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/default_feature_reports/README.md

@@ -2,16 +2,16 @@
 
 ###### (Automatically generated documentation)
 
-# 
+# DefaultFeatureReports
 
 ## Description
-
+Writes default_feature_reports.json and default_feature_reports.csv files used by URBANopt Scenario Default Post Processor
 
 ## Modeler Description
-
+This measure only allows for one feature_report per simulation. If multiple features are simulated in a single simulation, a new measure must be written to disaggregate simulation results to multiple features.
 
 ## Measure Type
-ModelMeasure
+ReportingMeasure
 
 ## Taxonomy
 
@@ -19,8 +19,46 @@ ModelMeasure
 ## Arguments
 
 
+### Feature unique identifier
+
+**Name:** feature_id,
+**Type:** String,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+### Feature scenario specific name
+
+**Name:** feature_name,
+**Type:** String,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+### URBANopt Feature Type
+
+**Name:** feature_type,
+**Type:** String,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+### URBANopt Feature Location
+
+**Name:** feature_location,
+**Type:** String,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+### Reporting Frequency
+The frequency at which to report timeseries output data.
+**Name:** reporting_frequency,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
 
 
-This measure does not have any user arguments
 
 

data/lib/measures/default_feature_reports/measure.rb

@@ -1,41 +1,6 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2022, 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.
-
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 OR CONTRIBUTORS 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.
+# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://github.com/urbanopt/urbanopt-reporting-gem/blob/develop/LICENSE.md
 # *********************************************************************************
 
 require 'urbanopt/reporting/default_reports'
@@ -294,7 +259,6 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     qaqc_flags_hash = {} # Make a hash for count of flags of each category
 
     runner.workflow.workflowSteps.each do |step| # Go through all the steps
-
       if step.to_MeasureStep.is_initialized
         measure_step = step.to_MeasureStep.get
 
@@ -310,17 +274,17 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
             result = measure_step.result.get
             puts " result = #{result}"
 
-            ## Adding quaqc_flags_list to check the step value name since units key is missing from the result 
+            ## Adding quaqc_flags_list to check the step value name since units key is missing from the result
             ## It does show in the out.osw but not in the runner.workflow.workflowSteps object
-            # use this list to define the flags you want to report 
-            qaqc_flags_list = ['eui_reasonableness' , 'end_use_by_category',
-            'mechanical_system_part_load_efficiency', 'simultaneous_heating_and_cooling', 
-            'internal_loads', 'schedules', 'envelope_r_value', 'domestic_hot_water',
-            'mechanical_system_efficiency', 'supply_and_zone_air_temperature', 'total_qaqc_flags' ]
-            
+            # use this list to define the flags you want to report
+            qaqc_flags_list = [
+              'eui_reasonableness', 'end_use_by_category', 'mechanical_system_part_load_efficiency',
+              'simultaneous_heating_and_cooling', 'internal_loads', 'schedules', 'envelope_r_value',
+              'domestic_hot_water', 'mechanical_system_efficiency', 'supply_and_zone_air_temperature', 'total_qaqc_flags'
+            ]
+
             result.stepValues.each do |step_value|
-              
-              #get name 
+              # get name
               name = step_value.name
 
               if qaqc_flags_list.include? name
@@ -328,27 +292,27 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
                 # get value
                 # check if value, double, int, or bool
                 value_type = step_value.variantType.valueDescription
-                if value_type == "Double"
+                case value_type
+                when 'Double'
                   value = step_value.valueAsDouble
-                elsif value_type == "Integer"
+                when 'Integer'
                   value = step_value.valueAsInteger
-                elsif value_type == "Boolean"
+                when 'Boolean'
                   value = step_value.valueAsBoolean
-                elsif value_type == "String"
+                when 'String'
                   value = step_value.valueAsString
                 else
                   # catchall for unexpected value types
                   value = step_value.valueAsVariant.to_s
                 end
-                
+
                 if qaqc_flags_hash[name]
                   qaqc_flags_hash[name] += value
-                else 
+                else
                   qaqc_flags_hash[name] = value
                 end
 
               end
-
             end
 
             puts "qaqc_flags_hash = #{qaqc_flags_hash}"
@@ -359,11 +323,10 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
             qaqc_flags_hash['total_qaqc_flags'] = temp_hash_for_ordering['total_qaqc_flags']
 
           end
-        
+
         end
 
       end
-
     end
     return qaqc_flags_hash
   end
@@ -948,7 +911,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       @@logger.info('Emissions are not reported for this feature')
     end
 
-    # add qaqc results to feature report 
+    # add qaqc results to feature report
     qaqc_flags_hash = feature_qaqc_flags(runner)
     feature_report.qaqc_flags.eui_reasonableness = qaqc_flags_hash['eui_reasonableness']
     feature_report.qaqc_flags.end_use_by_category = qaqc_flags_hash['end_use_by_category']
@@ -1501,7 +1464,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       end
     end
 
-    #puts "values = #{values}"
+    # puts "values = #{values}"
 
     # closing the sql file
     sql_file.close
@@ -1512,7 +1475,6 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     feature_report.timeseries_csv.first_report_datetime = '0'
     feature_report.timeseries_csv.column_names = final_timeseries_names
 
-
     ##### Save the 'default_feature_reports.json' file
     feature_report_hash = feature_report.to_hash
 

data/lib/measures/default_feature_reports/measure.xml

@@ -1,11 +1,10 @@
 <?xml version="1.0"?>
 <measure>
-  <schema_version>3.0</schema_version>
-  <error>wrong number of arguments (given 1, expected 0)</error>
+  <schema_version>3.1</schema_version>
   <name>default_feature_reports</name>
   <uid>9ee3135a-8070-4408-bfa1-b75fecf9dd4f</uid>
-  <version_id>136d51d4-9a61-48cd-b068-0e02c4094e76</version_id>
-  <version_modified>20210427T174740Z</version_modified>
+  <version_id>0d079df4-5b14-465d-9b3c-d00e30b3def2</version_id>
+  <version_modified>2024-01-08T22:54:10Z</version_modified>
   <xml_checksum>FB304155</xml_checksum>
   <class_name>DefaultFeatureReports</class_name>
   <display_name>DefaultFeatureReports</display_name>
@@ -15,45 +14,40 @@
     <argument>
       <name>feature_id</name>
       <display_name>Feature unique identifier</display_name>
-      <description></description>
       <type>String</type>
-      <units></units>
       <required>false</required>
       <model_dependent>false</model_dependent>
       <default_value>1</default_value>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>feature_name</name>
       <display_name>Feature scenario specific name</display_name>
-      <description></description>
       <type>String</type>
-      <units></units>
       <required>false</required>
       <model_dependent>false</model_dependent>
       <default_value>name</default_value>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>feature_type</name>
       <display_name>URBANopt Feature Type</display_name>
-      <description></description>
       <type>String</type>
-      <units></units>
       <required>false</required>
       <model_dependent>false</model_dependent>
       <default_value>Building</default_value>
-      <min_value></min_value>
-      <max_value></max_value>
+    </argument>
+    <argument>
+      <name>feature_location</name>
+      <display_name>URBANopt Feature Location</display_name>
+      <type>String</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+      <default_value>0</default_value>
     </argument>
     <argument>
       <name>reporting_frequency</name>
       <display_name>Reporting Frequency</display_name>
       <description>The frequency at which to report timeseries output data.</description>
       <type>Choice</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>Timestep</default_value>
@@ -87,8 +81,6 @@
           <display_name>Runperiod</display_name>
         </choice>
       </choices>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
   </arguments>
   <outputs />
@@ -110,10 +102,16 @@
   </attributes>
   <files>
     <file>
-      <filename>USA_CO_Golden-NREL.724666_TMY3.epw</filename>
-      <filetype>epw</filetype>
-      <usage_type>test</usage_type>
-      <checksum>BDF687C1</checksum>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>7247B202</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>D4DA366E</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>
@@ -122,39 +120,33 @@
       <checksum>703C9964</checksum>
     </file>
     <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>0B68E96D</checksum>
-    </file>
-    <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>BBD19F47</checksum>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>1.11.0</identifier>
+        <min_compatible>1.11.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>A0464D25</checksum>
     </file>
     <file>
-      <filename>example_model.osm</filename>
-      <filetype>osm</filetype>
+      <filename>USA_CO_Golden-NREL.724666_TMY3.epw</filename>
+      <filetype>epw</filetype>
       <usage_type>test</usage_type>
-      <checksum>A178EC04</checksum>
+      <checksum>BDF687C1</checksum>
     </file>
     <file>
       <filename>default_feature_reports_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>0C4ED2E7</checksum>
+      <checksum>8AD78A1A</checksum>
     </file>
     <file>
-      <version>
-        <software_program>OpenStudio</software_program>
-        <identifier>1.11.0</identifier>
-        <min_compatible>1.11.0</min_compatible>
-      </version>
-      <filename>measure.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>script</usage_type>
-      <checksum>CD1AFD42</checksum>
+      <filename>example_model.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>C4527950</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/export_modelica_loads/LICENSE.md

@@ -1,27 +1,32 @@
-URBANopt (tm), Copyright (c) 2019-2020, 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, 
+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 
+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 
+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 
+
+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.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 OR CONTRIBUTORS 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.
+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.