urbanopt-reporting 0.8.0 → 0.9.0

data/lib/measures/default_feature_reports/LICENSE.md

@@ -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,

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.xml

@@ -1,11 +1,10 @@
 <?xml version="1.0"?>
 <measure>
   <schema_version>3.1</schema_version>
-  <error>wrong number of arguments (given 1, expected 0)</error>
   <name>default_feature_reports</name>
   <uid>9ee3135a-8070-4408-bfa1-b75fecf9dd4f</uid>
-  <version_id>50d54c60-5f7e-4948-9fb0-1567e1335148</version_id>
-  <version_modified>2023-07-06T16:04:16Z</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>
@@ -39,12 +38,10 @@
     <argument>
       <name>feature_location</name>
       <display_name>URBANopt Feature Location</display_name>
-      <descrption>Writes default_feature_reports.json and default_feature_reports.csv files used by URBANopt Scenario Default Post Processor</descrption>
       <type>String</type>
-      <units></units>
-      <required>true</required>
+      <required>false</required>
       <model_dependent>false</model_dependent>
-      <default_value>1</default_value>
+      <default_value>0</default_value>
     </argument>
     <argument>
       <name>reporting_frequency</name>
@@ -108,13 +105,13 @@
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>016C4035</checksum>
+      <checksum>7247B202</checksum>
     </file>
     <file>
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>0B68E96D</checksum>
+      <checksum>D4DA366E</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>

data/lib/measures/export_modelica_loads/LICENSE.md

@@ -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,

data/lib/measures/export_modelica_loads/measure.rb

@@ -56,7 +56,7 @@ class ExportModelicaLoads < OpenStudio::Measure::ReportingMeasure
     result << OpenStudio::IdfObject.load('Output:Meter,WaterSystems:EnergyTransfer,timestep;').get # Joules
     # these variables are used for the modelica export.
     result << OpenStudio::IdfObject.load('Output:Variable,*,Zone Predicted Sensible Load to Setpoint Heat Transfer Rate,timestep;').get # watts according to e+
-    result << OpenStudio::IdfObject.load('Output:Variable,*,Water Heater Total Demand Heat Transfer Rate,timestep;').get # Watts
+    result << OpenStudio::IdfObject.load('Output:Variable,,Water Heater Total Demand Heat Transfer Rate,timestep;').get # Watts
 
     return result
   end
@@ -97,7 +97,7 @@ class ExportModelicaLoads < OpenStudio::Measure::ReportingMeasure
       quick_proc[-1] = quick_proc[-1].delete(')')
       column += quick_proc
 
-      log "Took #{Time.now - start} to iterate"
+      # log "Took #{Time.now - start} to iterate"
     end
 
     log 'Appending column to data'
@@ -227,21 +227,21 @@ class ExportModelicaLoads < OpenStudio::Measure::ReportingMeasure
     extract_timeseries_into_matrix(sql_file, rows, 'Electricity:Facility', nil, 0, timestep)
     extract_timeseries_into_matrix(sql_file, rows, 'Gas:Facility', nil, 0, timestep)
     extract_timeseries_into_matrix(sql_file, rows, 'Heating:EnergyTransfer', nil, 0, timestep)
-    extract_timeseries_into_matrix(sql_file, rows, 'WaterSystems:EnergyTransfer', nil, 0, timestep)
+    extract_timeseries_into_matrix(sql_file, rows, 'Water Heater Total Demand Heat Transfer Rate', nil, 0, timestep)
 
     # get all zones and save the names for later use in aggregation.
     tz_names = []
     model.getThermalZones.each do |tz|
       tz_names << tz.name.get if tz.name.is_initialized
       extract_timeseries_into_matrix(sql_file, rows, 'Zone Predicted Sensible Load to Setpoint Heat Transfer Rate', tz_names.last, 0, timestep)
-      extract_timeseries_into_matrix(sql_file, rows, 'Water Heater Heating Rate', tz_names.last, 0, timestep)
+      # extract_timeseries_into_matrix(sql_file, rows, 'Water Heater Heating Rate', tz_names.last, 0, timestep)
     end
 
     # sum up a couple of the columns and create a new columns
     create_new_variable_sum(rows, 'TotalSensibleLoad', 'ZonePredictedSensibleLoadtoSetpointHeatTransferRate')
     create_new_variable_sum(rows, 'TotalCoolingSensibleLoad', 'ZonePredictedSensibleLoadtoSetpointHeatTransferRate', negative_only: true)
     create_new_variable_sum(rows, 'TotalHeatingSensibleLoad', 'ZonePredictedSensibleLoadtoSetpointHeatTransferRate', positive_only: true)
-    create_new_variable_sum(rows, 'TotalWaterHeating', 'WaterHeaterHeatingRate')
+    create_new_variable_sum(rows, 'TotalWaterHeating', 'WaterHeaterTotalDemandHeatTransferRate')
 
     # convert this to CSV object
     File.open('./building_loads.csv', 'w') do |f|
@@ -284,17 +284,13 @@ class ExportModelicaLoads < OpenStudio::Measure::ReportingMeasure
 
     File.open('./modelica.mos', 'w') do |f|
       f << "#1\n"
-      f << "#Heating and Cooling Model loads from OpenStudio Prototype Buildings\n"
-      f << "#  Building Type: {{BUILDINGTYPE}}\n"
-      f << "#  Climate Zone: {{CLIMATEZONE}}\n"
-      f << "#  Vintage: {{VINTAGE}}\n"
-      f << "#  Simulation ID (for debugging): {{SIMID}}\n"
-      f << "#  URL: https://github.com/urbanopt/openstudio-prototype-loads\n"
+      f << "#Exported loads from OpenStudio Reporting Measure\n"
+      f << "#  Measure location: https://github.com/urbanopt/urbanopt-reporting-gem/tree/develop/lib/measures/export_modelica_loads\n"
       f << "\n"
       f << "#First column: Seconds in the year (loads are hourly)\n"
       f << "#Second column: cooling loads in Watts (as negative numbers).\n"
       f << "#Third column: space heating loads in Watts\n"
-      f << "#Fourth column: water heating in Watts\n"
+      f << "#Fourth column: water heating loads in Watts\n"
       f << "\n"
       f << "#Peak space cooling load = #{peak_cooling} Watts\n"
       f << "#Peak space heating load = #{peak_heating} Watts\n"

data/lib/measures/export_modelica_loads/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>export_modelica_loads</name>
   <uid>7051db01-2e55-4223-b5b5-fee615b68dd0</uid>
-  <version_id>5ecb1fdb-fab0-4da7-a2f4-e67e9b3f94a0</version_id>
-  <version_modified>2023-07-06T16:04:16Z</version_modified>
+  <version_id>e682f518-4785-4917-802e-600023816cc3</version_id>
+  <version_modified>2024-01-08T22:54:10Z</version_modified>
   <xml_checksum>2C8A3EEF</xml_checksum>
   <class_name>ExportModelicaLoads</class_name>
   <display_name>Export Modelica Loads</display_name>
@@ -33,7 +33,7 @@
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>016C4035</checksum>
+      <checksum>7247B202</checksum>
     </file>
     <file>
       <filename>README.md</filename>
@@ -62,7 +62,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>6CE65AC0</checksum>
+      <checksum>B130AAF4</checksum>
     </file>
     <file>
       <filename>report.html.in</filename>

data/lib/measures/export_time_series_modelica/LICENSE.md

@@ -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,

data/lib/measures/export_time_series_modelica/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>export_time_series_loads_csv</name>
   <uid>9fcf6116-c2eb-43d6-93f0-e1bdd822f768</uid>
-  <version_id>562d7da7-5edf-46b5-8231-0cb55e4a78bd</version_id>
-  <version_modified>2023-07-20T19:21:47Z</version_modified>
+  <version_id>0b134568-d3a8-4ede-bf22-2010a173ea97</version_id>
+  <version_modified>2024-01-08T22:54:07Z</version_modified>
   <xml_checksum>9BF1E6AC</xml_checksum>
   <class_name>ExportTimeSeriesLoadsCSV</class_name>
   <display_name>ExportTimeSeriesLoadsCSV</display_name>
@@ -76,7 +76,7 @@
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>016C4035</checksum>
+      <checksum>7247B202</checksum>
     </file>
     <file>
       <filename>README.md</filename>

data/lib/urbanopt/reporting/default_reports/power_distribution.rb

@@ -16,7 +16,8 @@ module URBANopt
       ##
       class PowerDistribution
         attr_accessor :under_voltage_hours, :over_voltage_hours, :nominal_capacity,
-                      :reactance_resistance_ratio, :nominal_voltage, :max_power_kw, :max_reactive_power_kvar # :nodoc:
+                      :reactance_resistance_ratio, :nominal_voltage, :max_power_kw, :max_reactive_power_kvar,
+                      :tx_incoming_voltage, :tx_outgoing_voltage # :nodoc:
 
         ##
         # PowerDistribution class initialize all power_distribution attributes:
@@ -36,6 +37,8 @@ module URBANopt
           @nominal_voltage = hash[:nominal_voltage] # in V
           @max_power_kw = hash[:max_power_kw]
           @max_reactive_power_kvar = hash[:max_reactive_power_kvar]
+          @tx_incoming_voltage = hash[:tx_incoming_voltage]
+          @tx_outgoing_voltage = hash[:tx_outgoing_voltage]
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
           @@schema ||= @@validator.schema
@@ -53,6 +56,8 @@ module URBANopt
           hash[:nominal_voltage] = nil
           hash[:max_power_kw] = nil
           hash[:max_reactive_power_kvar] = nil
+          hash[:tx_incoming_voltage] = nil
+          hash[:tx_outgoing_voltage] = nil
 
           return hash
         end
@@ -72,6 +77,8 @@ module URBANopt
           result[:nominal_voltage] = @nominal_voltage if @nominal_voltage
           result[:max_power_kw] = @max_power_kw if @max_power_kw
           result[:max_reactive_power_kvar] = @max_reactive_power_kvar if @max_reactive_power_kvar
+          result[:tx_incoming_voltage] = @tx_incoming_voltage if @tx_incoming_voltage
+          result[:tx_outgoing_voltage] = @tx_outgoing_voltage if @tx_outgoing_voltage
 
           # validate power_distribution properties against schema
           if @@validator.validate(@@schema[:definitions][:PowerDistribution][:properties], result).any?