urbanopt-reporting 0.3.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a5d25f304c691b6de042fecc1b03cdbcda6e6cb175609532cf0926116dbce94
-  data.tar.gz: d805ec996625d83bcc9aff79f9d98edf0cc0618ec94b1c799ed8532f7ce47cf5
+  metadata.gz: f3bd0a381b1713f28796ac103c6b193c00a87c0ab75084bb49db62654a6f2906
+  data.tar.gz: 8672b851b4a5c906c2954bcb42fad185044f4b89c536e545aba185dffb0afa6b
 SHA512:
-  metadata.gz: 5a6cc2110c6ba387e9a9fb23b1dcd9d5bcd56cd342a6448097cce382003caa79aabd2bab83360896c764d888dd41408390c350b5eb25943209c8932f22790c52
-  data.tar.gz: 0c57334221a85295fde20dae7f7ae4ad23145c6baf82d17398c32efa4fc80acf71d5b2c6eb806780d67eba137a98e653a9e930cf5d4fb27ffd8f8bad40a5435f
+  metadata.gz: 57bf6dadcd3d1908de6e406bd0bcdf6fd3cf0141cb6858818dc440a4b3cdf1b22d740f06353112181f8d5b3db53a7bdaeb0d890dc0b4b71c6f3103c251584a74
+  data.tar.gz: c3602e94784b2d91499cd7dd439f7ae24131da774241b5a0e685cb60e7a3eb00fe2d9d237431fb4430ce084ba5b678cb2032a79f5734b35c2a4600d3f82f9668

data/CHANGELOG.md

@@ -1,9 +1,51 @@
 # URBANopt Reporting Gem
 
+## Version 0.3.5
+
+Date Range: 01/16/21 - 02/04/21
+
+- Fixed [#58]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/58 ), Feature report saving bug fix.
+- Fixed [#60]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/60 ), Added EV/ ExteriorEquipment results to csv and json reports
+- Fixed [#61]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/61 ), Enhance the aggregation of enduses.
+
+
+## Version 0.3.4
+
+Date Range: 01/14/21 - 01/15/21
+
+- Fixed [#53]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/53 ), Make subfolders in feature saving if necessary
+- Fixed [#55]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/55 ), Fix new measures
+
+## Version 0.3.3
+
+Date Range: 12/09/20 - 01/13/21
+
+- Fixed [#36]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/36 ), Add reporting measure for district heating/cooling system mass flow rates
+- Fixed [#37]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/37 ), Add EUI to default report
+- Fixed [#38]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/38 ), Add better error handling around convert_units
+- Fixed [#43]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/43 ), Add available_roof_area calculation
+- Fixed [#44]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/44 ), Fix coordinates order
+
+## Version 0.3.2
+
+Date Range: 12/07/20 - 12/08/20
+
+- Fixed [#27]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/27 ), reporting measure fails when there are no additional fuels in the model
+- Fixed [#29]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/29 ), restore save_feature_report function for backward compatibility
+- Fixed [#32]( https://github.com/urbanopt/urbanopt-reporting-gem/issues/32 ), bump extension-gem dependency
+
+## Version 0.3.1
+
+Date Range: 11/26/2020 - 12/07/2020
+
+- Fixed [#19]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/19 ), check for nil values to avoid crashing unit conversion
+- Fixed [#24]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/24 ), Support reporting of other fuels
+- Fixed [#28]( https://github.com/urbanopt/urbanopt-reporting-gem/pull/28 ), fix for other_fuels being nil and restore save_feature_report function
+
 ## Version 0.3.0
 
 Date Range: 11/12/2020 - 11/25/2020
- 
+
 - Updating dependencies to support OpenStudio 3.1.0
 
 ## Version 0.2.1
@@ -35,4 +77,4 @@ Date Range: 08/27/2020 - 09/21/2020
 
 08/17/2020
 
-Initial release of the urbanopt-reporting gem.
+Initial release of the urbanopt-reporting gem.

data/docs/package-lock.json

@@ -4814,9 +4814,9 @@
       "integrity": "sha512-l9sfDFsuqtOqKDsQdqrMRk0U85RZc0RtOR9yPI7mRVOa4FsR/BVnZ0shmQRM96Ji99kYZP/7hn1cedc1+ApsTQ=="
     },
     "highlight.js": {
-      "version": "10.3.1",
-      "resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-10.3.1.tgz",
-      "integrity": "sha512-jeW8rdPdhshYKObedYg5XGbpVgb1/DT4AHvDFXhkU7UnGSIjy9kkJ7zHG7qplhFHMitTSzh5/iClKQk3Kb2RFQ=="
+      "version": "10.4.1",
+      "resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-10.4.1.tgz",
+      "integrity": "sha512-yR5lWvNz7c85OhVAEAeFhVCc/GV4C30Fjzc/rCP0aCWzc1UUOPUk55dK/qdwTZHBvMZo+eZ2jpk62ndX/xMFlg=="
     },
     "hmac-drbg": {
       "version": "1.0.1",

data/docs/package.json

@@ -10,7 +10,7 @@
   },
   "author": "NREL",
   "dependencies": {
-    "highlight.js": "^10.3.1",
+    "highlight.js": "^10.4.1",
     "json-schema-ref-parser": "^9.0.6",
     "json-schema-view-js": "git+https://git@github.com/bgschiller/json-schema-view-js.git",
     "vuepress": "^1.7.1",

data/lib/measures/default_feature_reports/measure.rb

@@ -165,9 +165,9 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
 
     # Request the output for each end use/fuel type combination
     end_uses.each do |end_use|
-      end_use, _ = end_use
+      end_use, = end_use
       fuel_types.each do |fuel_type|
-        fuel_type, _ = fuel_type
+        fuel_type, = fuel_type
         variable_name = if end_use == 'Facility'
                           "#{fuel_type}:#{end_use}"
                         else
@@ -178,17 +178,17 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     end
 
     # OtherFuels
-    other_fuels = ["FuelOil#1", "Diesel", "Gasoline", "Coal", "Steam"]
-    other_fuel_uses = ["HeatRejection", "Heating", "WaterSystems", "InteriorEquipment"]
-    custom_meter_facility = "Meter:Custom,OtherFuels:Facility,OtherFuel1"
+    other_fuels = ['FuelOil#1', 'Diesel', 'Gasoline', 'Coal', 'Steam']
+    other_fuel_uses = ['HeatRejection', 'Heating', 'WaterSystems', 'InteriorEquipment']
+    custom_meter_facility = 'Meter:Custom,OtherFuels:Facility,OtherFuel1'
     other_fuel_uses.each do |end_use|
       custom_meter = "Meter:Custom,#{end_use}:OtherFuels,OtherFuel1"
-      other_fuels.each do |other_fuel|  
+      other_fuels.each do |other_fuel|
         result << OpenStudio::IdfObject.load("Output:Meter,#{end_use}:#{other_fuel},#{reporting_frequency};").get
         custom_meter_facility += ",,#{end_use}:#{other_fuel}"
         custom_meter += ",,#{end_use}:#{other_fuel}"
       end
-      custom_meter += ";"
+      custom_meter += ';'
       result << OpenStudio::IdfObject.load(custom_meter).get
       result << OpenStudio::IdfObject.load("Output:Meter,#{end_use}:OtherFuels,#{reporting_frequency};").get
     end
@@ -201,6 +201,8 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Gas:Facility,#{reporting_frequency};").get
     result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,DistrictCooling:Facility,#{reporting_frequency};").get
     result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,DistrictHeating:Facility,#{reporting_frequency};").get
+     
+
     # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Cooling:Electricity,#{reporting_frequency};").get
     # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Heating:Electricity,#{reporting_frequency};").get
     # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,InteriorLights:Electricity,#{reporting_frequency};").get
@@ -213,14 +215,19 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,WaterSystems:Gas,#{reporting_frequency};").get
     # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,InteriorEquipment:Gas,#{reporting_frequency};").get
     result << OpenStudio::IdfObject.load('Output:Variable,*,Heating Coil Heating Rate,hourly; !- HVAC Average [W];').get
+    #result << OpenStudio::IdfObject.load("Output:Variable,*,Exterior Equipment:Electric Vehicles,#{reporting_frequency};").get
 
     timeseries_data = ['District Cooling Chilled Water Rate', 'District Cooling Mass Flow Rate',
                        'District Cooling Inlet Temperature', 'District Cooling Outlet Temperature',
                        'District Heating Hot Water Rate', 'District Heating Mass Flow Rate',
                        'District Heating Inlet Temperature', 'District Heating Outlet Temperature', 'Cooling Coil Total Cooling Rate',
-                       'Heating Coil Heating Rate']
+                       'Heating Coil Heating Rate', 'ExteriorEquipment:Electricity']
+
 
     tes_timeseries_data = ['Ice Thermal Storage End Fraction', 'Cooling coil Ice Thermal Storage End Fraction']
+  
+    ev_timeseries_data = ['Exterior Equipment:Electric Vehicles']
+    
     timeseries_data += tes_timeseries_data
 
     timeseries_data.each do |ts|
@@ -258,6 +265,11 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     if value.nil?
       return nil
     end
+    if from_units.nil? || to_units.nil?
+      @runner.registerError("Cannot convert units...from_units: #{from_units} or to_units: #{to_units} left blank.")
+      return nil
+    end
+
     # apply unit conversion
     value_converted = OpenStudio.convert(value, from_units, to_units)
     if value_converted.is_initialized
@@ -353,10 +365,10 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     ##
 
     if feature_location.include? '['
-      # get latitude from feature_location
-      latitude = (feature_location.split(',')[0].delete! '[]').to_f
       # get longitude from feature_location
-      longitude = (feature_location.split(',')[1].delete! '[]').to_f
+      longitude = (feature_location.split(',')[0].delete! '[]').to_f
+      # get latitude from feature_location
+      latitude = (feature_location.split(',')[1].delete! '[]').to_f
       # latitude
       feature_report.location.latitude_deg = latitude
       # longitude
@@ -495,7 +507,22 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
         total_roof_area += surface.netArea
       end
     end
-    feature_report.program.roof_area_sqft[:total_roof_area_sqft] = convert_units(total_roof_area, 'm^2', 'ft^2')
+
+    total_roof_area_sqft = convert_units(total_roof_area, 'm^2', 'ft^2')
+    feature_report.program.roof_area_sqft[:total_roof_area_sqft] = total_roof_area_sqft
+
+    # available_roof_area_sqft
+    # RK: a more robust method should be implemented to find the available_roof_area
+    # assign available roof area to be a percentage of the total roof area
+
+    if building_types[0][:building_type].include? 'Single-Family Detached'
+      feature_report.program.roof_area_sqft[:available_roof_area_sqft] = 0.45 * total_roof_area_sqft
+    else
+      feature_report.program.roof_area_sqft[:available_roof_area_sqft] = 0.75 * total_roof_area_sqft
+    end
+
+    # RK: Temporary solution: assign available roof area to be equal to total roof area
+    # feature_report.program.roof_area_sqft[:available_roof_area_sqft] = total_roof_area_sqft
 
     # orientation
     # RK: a more robust method should be implemented to find orientation(finding main axis of the building using aspect ratio)
@@ -581,6 +608,22 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     total_source_energy = sql_query(runner, sql_file, 'AnnualBuildingUtilityPerformanceSummary', "TableName='Site and Source Energy' AND RowName='Total Source Energy' AND ColumnName='Total Energy'")
     feature_report.reporting_periods[0].total_source_energy_kwh = convert_units(total_source_energy, 'GJ', 'kWh')
 
+    # EUI is only valid with a full year of energy data
+    if begin_month == 1 && begin_day_of_month == 1 && end_month == 12 && end_day_of_month == 31
+      # calculate site EUI
+      site_EUI_kwh_per_m2 = feature_report.reporting_periods[0].total_site_energy_kwh / floor_area
+      site_EUI_kbtu_per_ft2 = convert_units(total_site_energy, 'GJ', 'kBtu') / feature_report.program.floor_area_sqft
+      # add site EUI to feature report
+      feature_report.reporting_periods[0].site_EUI_kwh_per_m2 = site_EUI_kwh_per_m2
+      feature_report.reporting_periods[0].site_EUI_kbtu_per_ft2 = site_EUI_kbtu_per_ft2
+      # calculate source EUI
+      source_EUI_kwh_per_m2 = feature_report.reporting_periods[0].total_source_energy_kwh / floor_area
+      source_EUI_kbtu_per_ft2 = convert_units(total_source_energy, 'GJ', 'kBtu') / feature_report.program.floor_area_sqft
+      # add source EUI to feature report
+      feature_report.reporting_periods[0].source_EUI_kwh_per_m2 = source_EUI_kwh_per_m2
+      feature_report.reporting_periods[0].source_EUI_kbtu_per_ft2 = source_EUI_kbtu_per_ft2
+    end
+
     # net_site_energy
     net_site_energy = sql_query(runner, sql_file, 'AnnualBuildingUtilityPerformanceSummary', "TableName='Site and Source Energy' AND RowName='Net Site Energy' AND ColumnName='Total Energy'")
     feature_report.reporting_periods[0].net_site_energy_kwh = convert_units(net_site_energy, 'GJ', 'kWh')
@@ -609,7 +652,9 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
 
     # other_fuels
     additional_fuel = sql_query(runner, sql_file, 'AnnualBuildingUtilityPerformanceSummary', "TableName='End Uses' AND RowName='Total End Uses' AND ColumnName='Additional Fuel'")
-    feature_report.reporting_periods[0].other_fuels_kwh = convert_units(additional_fuel, 'GJ', 'kWh')
+    # ensure additional fuel is not nil
+    feature_report.reporting_periods[0].other_fuels_kwh = 0.0
+    feature_report.reporting_periods[0].other_fuels_kwh = convert_units(additional_fuel, 'GJ', 'kWh') unless additional_fuel.nil?
     feature_report.reporting_periods[0].other_fuels_kwh -= feature_report.reporting_periods[0].propane_kwh
     feature_report.reporting_periods[0].other_fuels_kwh -= feature_report.reporting_periods[0].fuel_oil_kwh
 
@@ -686,18 +731,27 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
         m = feature_report.reporting_periods[0].end_uses.send(x_u)
 
         y = eu.tr(' ', '_').downcase
+        # ensure not nil so the equations below don't error out
+        if sql_r.nil?
+          sql_r = 0.0
+        end
         sql_r = convert_units(sql_r, 'GJ', 'kWh')
         if x_u == 'other_fuels_kwh'
           sql_r -= feature_report.reporting_periods[0].end_uses.propane_kwh.send(y)
           sql_r -= feature_report.reporting_periods[0].end_uses.fuel_oil_kwh.send(y)
         end
         building_types.each do |i|
-          sql_r = 0.0 if (i[:building_type].include?('Single-Family Detached') && x_u.include?('district'))
+          sql_r = 0.0 if i[:building_type].include?('Single-Family Detached') && x_u.include?('district')
         end
         m.send("#{y}=", sql_r)
       end
     end
 
+    # add enduses subcategories
+    electric_vehicles = sql_query(runner, sql_file, 'AnnualBuildingUtilityPerformanceSummary', "TableName='End Uses By Subcategory' AND RowName='Exterior Equipment:Electric Vehicles' AND ColumnName='Electricity'")
+    puts "electric_vehicle = #{electric_vehicles}"
+    feature_report.reporting_periods[0].end_uses.electricity_kwh.electric_vehicles = convert_units(electric_vehicles, 'GJ', 'kWh')
+
     ### energy_production
     ## electricity_produced
     # photovoltaic
@@ -761,6 +815,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       'InteriorLights:Electricity',
       'ExteriorLights:Electricity',
       'InteriorEquipment:Electricity',
+      'ExteriorEquipment:Electricity',
       'Fans:Electricity',
       'Pumps:Electricity',
       'WaterSystems:Electricity',
@@ -844,7 +899,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       puts " *********timeseries_name = #{timeseries_name}******************"
       runner.registerInfo("TIMESERIES: #{timeseries_name}")
 
-      # get all the key values that this timeseries can be reported for (e.g. if PMV is requested for each zone)      
+      # get all the key values that this timeseries can be reported for (e.g. if PMV is requested for each zone)
       if timeseries_name.include?('OtherFuels')
         key_values = sql_file.availableKeyValues('RUN PERIOD 1', 'Zone Timestep', timeseries_name.upcase)
       else

data/lib/measures/default_feature_reports/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>default_feature_reports</name>
   <uid>9ee3135a-8070-4408-bfa1-b75fecf9dd4f</uid>
-  <version_id>f9af7bd8-e9ce-41b4-b892-df29f235a9bd</version_id>
-  <version_modified>20201201T173130Z</version_modified>
+  <version_id>d4f5b2e2-f93d-4ce2-9c68-ed29714fdc0c</version_id>
+  <version_modified>20201208T230102Z</version_modified>
   <xml_checksum>FB304155</xml_checksum>
   <class_name>DefaultFeatureReports</class_name>
   <display_name>DefaultFeatureReports</display_name>
@@ -153,7 +153,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>B1E43E26</checksum>
+      <checksum>48AEB753</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/export_modelica_loads/LICENSE.md

@@ -0,0 +1,27 @@
+OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted 
+provided that the following conditions are met:
+
+(1) Redistributions of source code must retain the above copyright notice, this list of conditions 
+and the following disclaimer.
+
+(2) 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.
+
+(3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse 
+or promote products derived from this software without specific prior written permission from the 
+respective party.
+
+(4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other 
+derivative works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar 
+designation without specific prior written permission from Alliance for Sustainable Energy, LLC.
+
+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, THE UNITED STATES GOVERNMENT, 
+OR ANY 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.

data/lib/measures/export_modelica_loads/README.md

@@ -0,0 +1,26 @@
+
+
+###### (Automatically generated documentation)
+
+# Export Modelica Loads
+
+## Description
+Use the results from the EnergyPlus simulation to generate a load file for use in Modelica. This will create a MOS and a CSV file of the heating, cooling, and hot water loads.
+
+## Modeler Description
+
+
+## Measure Type
+ReportingMeasure
+
+## Taxonomy
+
+
+## Arguments
+
+
+
+
+This measure does not have any user arguments
+
+

data/lib/measures/export_modelica_loads/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/export_modelica_loads/measure.rb

@@ -0,0 +1,375 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) 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.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# 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.
+# *******************************************************************************
+
+require 'erb'
+
+
+# This measure is originally from https://github.com/urbanopt/DES_HVAC
+# start the measure
+class ExportModelicaLoads < OpenStudio::Measure::ReportingMeasure
+  # human readable name
+  def name
+    # Measure name should be the title case of the class name.
+    return 'Export Modelica Loads'
+  end
+
+  def description
+    return 'Use the results from the EnergyPlus simulation to generate a load file for use in Modelica. This will create a MOS and a CSV file of the heating, cooling, and hot water loads.'
+  end
+
+  def modeler_description
+    return ''
+  end
+
+  def log(str)
+    puts "#{Time.now}: #{str}"
+  end
+
+  def arguments(_model)
+    args = OpenStudio::Measure::OSArgumentVector.new
+
+    # this measure does not require any user arguments, return an empty list
+    return args
+  end
+
+  # return a vector of IdfObject's to request EnergyPlus objects needed by the run method
+  def energyPlusOutputRequests(runner, user_arguments)
+    super(runner, user_arguments)
+
+    result = OpenStudio::IdfObjectVector.new
+
+    # To use the built-in error checking we need the model...
+    # get the last model and sql file
+    model = runner.lastOpenStudioModel
+    if model.empty?
+      runner.registerError('Cannot find last model.')
+      return false
+    end
+    model = model.get
+
+    # use the built-in error checking
+    if !runner.validateUserArguments(arguments(model), user_arguments)
+      return false
+    end
+
+    result << OpenStudio::IdfObject.load('Output:Variable,,Site Mains Water Temperature,timestep;').get
+    result << OpenStudio::IdfObject.load('Output:Variable,,Site Outdoor Air Drybulb Temperature,timestep;').get
+    result << OpenStudio::IdfObject.load('Output:Variable,,Site Outdoor Air Relative Humidity,timestep;').get
+    result << OpenStudio::IdfObject.load('Output:Meter,Cooling:Electricity,timestep;').get
+    result << OpenStudio::IdfObject.load('Output:Meter,Heating:Electricity,timestep;').get
+    result << OpenStudio::IdfObject.load('Output:Meter,Heating:Gas,timestep;').get
+    result << OpenStudio::IdfObject.load('Output:Meter,InteriorLights:Electricity,timestep;').get
+    result << OpenStudio::IdfObject.load('Output:Meter,Fans:Electricity,timestep;').get
+    result << OpenStudio::IdfObject.load('Output:Meter,InteriorEquipment:Electricity,timestep;').get # Joules
+    result << OpenStudio::IdfObject.load('Output:Meter,ExteriorLighting:Electricity,timestep;').get # Joules
+    result << OpenStudio::IdfObject.load('Output:Meter,Electricity:Facility,timestep;').get # Joules
+    result << OpenStudio::IdfObject.load('Output:Meter,Electricity:Facility,timestep;').get ##Using this for data at timestep interval
+    result << OpenStudio::IdfObject.load('Output:Meter,Gas:Facility,timestep;').get # Joules
+    result << OpenStudio::IdfObject.load('Output:Meter,Heating:EnergyTransfer,timestep;').get # Joules
+    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
+
+    return result
+  end
+
+  def extract_timeseries_into_matrix(sqlfile, data, variable_name, key_value = nil, default_if_empty = 0, timestep)
+    log "Executing query for #{variable_name}"
+    column_name = variable_name
+    if key_value
+      # ts = sqlfile.timeSeries('RUN PERIOD 1', 'Hourly', variable_name, key_value)
+      ts = sqlfile.timeSeries('RUN PERIOD 1', 'Zone Timestep', variable_name, key_value)
+      column_name += "_#{key_value}"
+    else
+      # ts = sqlfile.timeSeries('RUN PERIOD 1', 'Hourly', variable_name)
+      ts = sqlfile.timeSeries('RUN PERIOD 1', 'Zone Timestep', variable_name)
+    end
+    log 'Iterating over timeseries'
+    column = [column_name.delete(':').delete(' ')] # Set the header of the data to the variable name, removing : and spaces
+
+    if ts.empty?
+      log "No time series for #{variable_name}:#{key_value}... defaulting to #{default_if_empty}"
+      # needs to be data.size-1 since the column name is already stored above (+=)
+      column += [default_if_empty] * (data.size - 1)
+    else
+      ts = ts.get if ts.respond_to?(:get)
+      ts = ts.first if ts.respond_to?(:first)
+
+      start = Time.now
+      # Iterating in OpenStudio can take up to 60 seconds with 10min data. The quick_proc takes 0.03 seconds.
+      # for i in 0..ts.values.size - 1
+      #   log "... at #{i}" if i % 10000 == 0
+      #   column << ts.values[i]
+      # end
+
+      quick_proc = ts.values.to_s.split(',')
+
+      # the first and last have some cleanup items because of the Vector method
+      quick_proc[0] = quick_proc[0].gsub(/^.*\(/, '')
+      quick_proc[-1] = quick_proc[-1].delete(')')
+      column += quick_proc
+
+      log "Took #{Time.now - start} to iterate"
+    end
+
+    log 'Appending column to data'
+
+    # append the data to the end of the rows
+    if column.size == data.size
+      data.each_index do |index|
+        data[index] << column[index]
+      end
+    end
+
+    log "Finished extracting #{variable_name}"
+  end
+
+  def create_new_variable_sum(data, new_var_name, include_str, options = nil)
+    var_info = {
+      name: new_var_name,
+      var_indexes: []
+    }
+    data.each_with_index do |row, index|
+      if index.zero?
+        # Get the index of the columns to add
+        row.each do |c|
+          if c.include? include_str
+            var_info[:var_indexes] << row.index(c)
+          end
+        end
+
+        # add the new var to the header row
+        data[0] << var_info[:name]
+      else
+        # sum the values
+        sum = 0
+        var_info[:var_indexes].each do |var|
+          temp_v = row[var].to_f
+          if options.nil?
+            sum += temp_v
+          elsif options[:positive_only] && temp_v > 0
+            sum += temp_v
+          elsif options[:negative_only] && temp_v < 0
+            sum += temp_v
+          end
+        end
+
+        # Also round the data here, because we don't need 10 decimals
+        data[index] << sum.round(1)
+      end
+    end
+  end
+
+  def run(runner, user_arguments)
+    super(runner, user_arguments)
+
+    # get the last model and sql file
+    model = runner.lastOpenStudioModel
+    if model.empty?
+      runner.registerError('Cannot find last model.')
+      return false
+    end
+    model = model.get
+
+    # use the built-in error checking
+    return false unless runner.validateUserArguments(arguments(model), user_arguments)
+
+    # get the last model and sql file
+    model = runner.lastOpenStudioModel
+    if model.empty?
+      runner.registerError('Cannot find last model.')
+      return false
+    end
+    model = model.get
+
+    timesteps_per_hour=model.getTimestep.numberOfTimestepsPerHour.to_i
+    timestep=60/timesteps_per_hour #timestep in minutes
+
+    sqlFile = runner.lastEnergyPlusSqlFile
+    if sqlFile.empty?
+      runner.registerError('Cannot find last sql file.')
+      return false
+    end
+    sqlFile = sqlFile.get
+    model.setSqlFile(sqlFile)
+
+    # create a new csv with the values and save to the reports directory.
+    # assumptions:
+    #   - all the variables exist
+    #   - data are the same length
+
+    # initialize the rows with the header
+    log 'Starting to process Timeseries data'
+    # Initial header row
+    rows = [
+      ['Date Time', 'Month', 'Day', 'Day of Week', 'Hour', 'Minute', 'SecondsFromStart']
+    ]
+
+    # just grab one of the variables to get the date/time stamps
+    attribute_name = 'Electricity:Facility'
+    ts = sqlFile.timeSeries('RUN PERIOD 1', 'Zone Timestep', attribute_name)
+    if ts.empty?
+      runner.registerError("This feature does not have the attribute '#{attribute_name}' to enable this measure to work." \
+      "To resolve, simulate a building with electricity or remove this measure from your workflow.")
+    else
+      ts = ts.first
+      dt_base = nil
+      # Save off the date time values
+      ts.dateTimes.each_with_index do |dt, index|
+        dt_base = DateTime.parse(dt.to_s) if dt_base.nil?
+        dt_current = DateTime.parse(dt.to_s)
+        rows << [
+          DateTime.parse(dt.to_s).strftime('%m/%d/%Y %H:%M'),
+          dt.date.monthOfYear.value,
+          dt.date.dayOfMonth,
+          dt.date.dayOfWeek.value,
+          dt.time.hours,
+          dt.time.minutes,
+          dt_current.to_time.to_i - dt_base.to_time.to_i + timestep*60
+        ]
+      end
+    end
+
+    # add in the other variables by columns -- should really pull this from the report variables defined above
+    extract_timeseries_into_matrix(sqlFile, rows, 'Site Outdoor Air Drybulb Temperature', 'Environment', 0, timestep)
+    extract_timeseries_into_matrix(sqlFile, rows, 'Site Outdoor Air Relative Humidity', 'Environment', 0, timestep)
+    extract_timeseries_into_matrix(sqlFile, rows, 'Heating:Electricity', nil, 0, timestep)
+    extract_timeseries_into_matrix(sqlFile, rows, 'Heating:Gas', nil, 0, timestep)
+    extract_timeseries_into_matrix(sqlFile, rows, 'Cooling:Electricity', nil, 0, timestep)
+    extract_timeseries_into_matrix(sqlFile, rows, 'Electricity:Facility', nil, 0, timestep)
+    extract_timeseries_into_matrix(sqlFile, rows, 'Gas:Facility', nil, 0, timestep)
+    extract_timeseries_into_matrix(sqlFile, rows, 'Heating:EnergyTransfer', nil, 0, timestep)
+    extract_timeseries_into_matrix(sqlFile, rows, 'WaterSystems:EnergyTransfer', 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(sqlFile, rows, 'Zone Predicted Sensible Load to Setpoint Heat Transfer Rate', tz_names.last, 0, timestep)
+      extract_timeseries_into_matrix(sqlFile, 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')
+
+    # convert this to CSV object
+    File.open('./building_loads.csv', 'w') do |f|
+      rows.each do |row|
+        f << row.join(',') << "\n"
+      end
+    end
+
+    # covert the row data into the format needed by modelica
+    modelica_data = [['seconds', 'cooling', 'heating', 'waterheating']]
+    seconds_index = nil
+    total_water_heating_index = nil
+    total_cooling_sensible_index = nil
+    total_heating_sensible_index = nil
+    peak_cooling = 0
+    peak_heating = 0
+    peak_water_heating = 0
+    rows.each_with_index do |row, index|
+      if index.zero?
+        seconds_index = row.index('SecondsFromStart')
+        total_cooling_sensible_index = row.index('TotalCoolingSensibleLoad')
+        total_heating_sensible_index = row.index('TotalHeatingSensibleLoad')
+        total_water_heating_index = row.index('TotalWaterHeating')
+      else
+        new_data = [
+          row[seconds_index],
+          row[total_cooling_sensible_index],
+          row[total_heating_sensible_index],
+          row[total_water_heating_index]
+        ]
+
+        modelica_data << new_data
+
+        # store the peaks
+        peak_cooling = row[total_cooling_sensible_index] if row[total_cooling_sensible_index] < peak_cooling
+        peak_heating = row[total_heating_sensible_index] if row[total_heating_sensible_index] > peak_heating
+        peak_water_heating = row[total_water_heating_index] if row[total_water_heating_index] > peak_water_heating
+      end
+    end
+
+    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 << "\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 << "\n"
+      f << "#Peak space cooling load = #{peak_cooling} Watts\n"
+      f << "#Peak space heating load = #{peak_heating} Watts\n"
+      f << "#Peak water heating load = #{peak_water_heating} Watts\n"
+      f << "double tab1(8760,4)\n"
+      modelica_data.each_with_index do |row, index|
+        next if index.zero?
+        f << row.join(';') << "\n"
+      end
+    end
+
+    # Find the total runtime for energyplus and save it into a registerValue
+    total_time = -999
+    location_of_file = ['../eplusout.end', './run/eplusout.end']
+    first_index = location_of_file.map { |f| File.exist?(f) }.index(true)
+    if first_index
+      match = File.read(location_of_file[first_index]).to_s.match(/Elapsed.Time=(.*)hr(.*)min(.*)sec/)
+      total_time = match[1].to_i * 3600 + match[2].to_i * 60 + match[3].to_f
+    end
+
+    runner.registerValue('energyplus_runtime', total_time, 'sec')
+    runner.registerValue('peak_cooling_load', peak_cooling, 'W')
+    runner.registerValue('peak_heating_load', peak_heating, 'W')
+    runner.registerValue('peak_water_heating', peak_water_heating, 'W')
+
+    return true
+  ensure
+    sqlFile.close if sqlFile
+  end
+end
+
+# register the measure to be used by the application
+ExportModelicaLoads.new.registerWithApplication