urbanopt-cli 0.9.3 → 0.10.0

data/example_files/resources/hpxml-measures/ReportUtilityBills/measure.rb

@@ -180,7 +180,6 @@ class ReportUtilityBills < OpenStudio::Measure::ReportingMeasure
 
     # assign the user inputs to variables
     args = get_argument_values(runner, arguments(model), user_arguments)
-    args = Hash[args.collect { |k, v| [k.to_sym, v] }]
     output_format = args[:output_format].get
 
     output_dir = File.dirname(runner.lastEpwFilePath.get.to_s)
@@ -252,10 +251,10 @@ class ReportUtilityBills < OpenStudio::Measure::ReportingMeasure
         segment = new_segment
       end
 
-      results_out << ["#{bill_scenario_name}: #{fuel_type}: Fixed (USD)", bill.annual_fixed_charge.round(2)] if bill.annual_fixed_charge != 0
-      results_out << ["#{bill_scenario_name}: #{fuel_type}: Energy (USD)", bill.annual_energy_charge.round(2)] if bill.annual_energy_charge != 0
-      results_out << ["#{bill_scenario_name}: #{fuel_type}: PV Credit (USD)", bill.annual_production_credit.round(2)] if [FT::Elec].include?(fuel_type) && bill.annual_production_credit != 0
-      results_out << ["#{bill_scenario_name}: #{fuel_type}: Total (USD)", bill.annual_total.round(2)] if bill.annual_total != 0
+      results_out << ["#{bill_scenario_name}: #{fuel_type}: Fixed (USD)", bill.annual_fixed_charge.round(2)]
+      results_out << ["#{bill_scenario_name}: #{fuel_type}: Energy (USD)", bill.annual_energy_charge.round(2)]
+      results_out << ["#{bill_scenario_name}: #{fuel_type}: PV Credit (USD)", bill.annual_production_credit.round(2)] if [FT::Elec].include?(fuel_type)
+      results_out << ["#{bill_scenario_name}: #{fuel_type}: Total (USD)", bill.annual_total.round(2)]
     end
 
     if ['csv'].include? output_format
@@ -311,9 +310,9 @@ class ReportUtilityBills < OpenStudio::Measure::ReportingMeasure
           tariff = tariff[:items][0]
           fields = tariff.keys
 
+          rate.fixedmonthlycharge = 0.0
           if fields.include?(:fixedchargeunits)
             if tariff[:fixedchargeunits] == '$/month'
-              rate.fixedmonthlycharge = 0.0 if fields.include?(:fixedchargefirstmeter) || fields.include?(:fixedchargeeaaddl)
               rate.fixedmonthlycharge += tariff[:fixedchargefirstmeter] if fields.include?(:fixedchargefirstmeter)
               rate.fixedmonthlycharge += tariff[:fixedchargeeaaddl] if fields.include?(:fixedchargeeaaddl)
             else
@@ -505,8 +504,7 @@ class ReportUtilityBills < OpenStudio::Measure::ReportingMeasure
 
       timeseries_freq = 'monthly'
       timeseries_freq = 'hourly' if fuel_type == FT::Elec && !utility_bill_scenario.elec_tariff_filepath.nil?
-      num_timestamps = OutputMethods.get_timestamps(@msgpackData, @hpxml, false)[0].size
-      fuel.timeseries = get_report_meter_data_timeseries(fuel.meters, unit_conv, 0, num_timestamps, timeseries_freq)
+      fuel.timeseries = get_report_meter_data_timeseries(fuel.meters, unit_conv, 0, timeseries_freq)
     end
   end
 
@@ -519,12 +517,18 @@ class ReportUtilityBills < OpenStudio::Measure::ReportingMeasure
     }
   end
 
-  def get_report_meter_data_timeseries(meter_names, unit_conv, unit_adder, num_timestamps, timeseries_freq)
-    return [0.0] * num_timestamps if meter_names.empty?
-
-    msgpack_timeseries_name = OutputMethods.msgpack_frequency_map[timeseries_freq]
-    cols = @msgpackData['MeterData'][msgpack_timeseries_name]['Cols']
-    rows = @msgpackData['MeterData'][msgpack_timeseries_name]['Rows']
+  def get_report_meter_data_timeseries(meter_names, unit_conv, unit_adder, timeseries_freq)
+    msgpack_timeseries_name = { 'timestep' => 'TimeStep',
+                                'hourly' => 'Hourly',
+                                'daily' => 'Daily',
+                                'monthly' => 'Monthly' }[timeseries_freq]
+    begin
+      data = @msgpackData['MeterData'][msgpack_timeseries_name]
+      cols = data['Cols']
+      rows = data['Rows']
+    rescue
+      return [0.0]
+    end
     indexes = cols.each_index.select { |i| meter_names.include? cols[i]['Variable'] }
     vals = []
     rows.each do |row|

data/example_files/resources/hpxml-measures/ReportUtilityBills/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>report_utility_bills</name>
   <uid>ca88a425-e59a-4bc4-af51-c7e7d1e960fe</uid>
-  <version_id>85b7dc96-d570-4b9b-b72b-a8b85442c94c</version_id>
-  <version_modified>20221112T002848Z</version_modified>
+  <version_id>10456a16-b1fc-449f-b7f8-71fbcdabb1c9</version_id>
+  <version_modified>20230401T012721Z</version_modified>
   <xml_checksum>15BF4E57</xml_checksum>
   <class_name>ReportUtilityBills</class_name>
   <display_name>Utility Bills Report</display_name>
@@ -84,12 +84,6 @@
       <usage_type>test</usage_type>
       <checksum>F96CB80F</checksum>
     </file>
-    <file>
-      <filename>util.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>041AE7DE</checksum>
-    </file>
     <file>
       <filename>detailed_rates/openei_rates.zip</filename>
       <filetype>zip</filetype>
@@ -222,6 +216,18 @@
       <usage_type>resource</usage_type>
       <checksum>387337AD</checksum>
     </file>
+    <file>
+      <filename>util.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>041AE7DE</checksum>
+    </file>
+    <file>
+      <filename>utility_bills_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>08FABF5F</checksum>
+    </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
@@ -231,13 +237,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>861BD498</checksum>
-    </file>
-    <file>
-      <filename>utility_bills_test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>65F0A778</checksum>
+      <checksum>13808DAA</checksum>
     </file>
   </files>
 </measure>

data/example_files/resources/hpxml-measures/ReportUtilityBills/tests/utility_bills_test.rb

@@ -79,7 +79,7 @@ class ReportUtilityBillsTest < MiniTest::Test
       has_fuel[fuel] = @hpxml.has_fuel(fuel, hpxml_doc)
     end
 
-    HPXMLDefaults.apply_header(@hpxml, nil)
+    HPXMLDefaults.apply_header(@hpxml, nil, nil)
     HPXMLDefaults.apply_utility_bill_scenarios(nil, @hpxml, has_fuel)
 
     @root_path = File.absolute_path(File.join(File.dirname(__FILE__), '..', '..'))
@@ -244,6 +244,15 @@ class ReportUtilityBillsTest < MiniTest::Test
     assert_operator(actual_bills['Test 1: Total (USD)'], :>, 0)
   end
 
+  def test_workflow_detailed_calculations_all_electric
+    @args_hash['hpxml_path'] = File.absolute_path(@tmp_hpxml_path)
+    hpxml = HPXML.new(hpxml_path: File.join(@sample_files_path, 'base-hvac-air-to-air-heat-pump-1-speed.xml'))
+    hpxml.header.utility_bill_scenarios.add(name: 'Test 1', elec_tariff_filepath: '../../ReportUtilityBills/tests/JacksonElectricMemberCorp-ResidentialSeniorCitizenLowIncomeAssistance.json')
+    XMLHelper.write_file(hpxml.to_oga, @tmp_hpxml_path)
+    actual_bills = _test_measure()
+    assert_operator(actual_bills['Test 1: Total (USD)'], :>, 0)
+  end
+
   def test_auto_marginal_rate
     fuel_types = [HPXML::FuelTypeElectricity, HPXML::FuelTypeNaturalGas, HPXML::FuelTypeOil, HPXML::FuelTypePropane]
 
@@ -1002,6 +1011,7 @@ class ReportUtilityBillsTest < MiniTest::Test
     require 'zip'
     require 'tempfile'
 
+    @hpxml.pv_systems.each { |pv_system| pv_system.max_power_output = 1000.0 / @hpxml.pv_systems.size }
     @hpxml.header.utility_bill_scenarios.each do |utility_bill_scenario|
       Zip.on_exists_proc = true
       Zip::File.open(File.join(File.dirname(__FILE__), '../resources/detailed_rates/openei_rates.zip')) do |zip_file|
@@ -1017,14 +1027,14 @@ class ReportUtilityBillsTest < MiniTest::Test
 
             utility_bill_scenario.elec_tariff_filepath = tmp_path
             File.delete(@bills_csv) if File.exist? @bills_csv
-            actual_bills = _bill_calcs(@fuels_pv_none_detailed, @hpxml.header, [], utility_bill_scenario)
+            actual_bills = _bill_calcs(@fuels_pv_1kw_detailed, @hpxml.header, @hpxml.pv_systems, utility_bill_scenario)
             if !File.exist?(@bills_csv)
               puts entry.name
               assert(false)
             end
             if entry.name.include? 'North Slope Borough Power Light - Aged or Handicappedseniors over 60'
               # No cost if < 600 kWh/month, which is the case for PV_None.csv
-              assert_nil(actual_bills['Test: Electricity: Total (USD)'])
+              assert_equal(0, actual_bills['Test: Electricity: Total (USD)'])
             else
               assert_operator(actual_bills['Test: Electricity: Total (USD)'], :>, 0)
             end

data/example_files/resources/hpxml-measures/docs/source/usage_instructions.rst

@@ -8,7 +8,7 @@ Setup
 
 To get started:
 
-#. Download `OpenStudio 3.5.0 <https://github.com/NREL/OpenStudio/releases/tag/v3.5.0>`_ and install the Command Line Interface/EnergyPlus/C++ API components, or use the `nrel/openstudio docker image <https://hub.docker.com/r/nrel/openstudio>`_.
+#. Download `OpenStudio 3.6.1 <https://github.com/NREL/OpenStudio/releases/tag/v3.6.1>`_ and install the Command Line Interface/EnergyPlus/C++ API components, or use the `nrel/openstudio docker image <https://hub.docker.com/r/nrel/openstudio>`_.
 #. Download the `latest release <https://github.com/NREL/OpenStudio-HPXML/releases>`_.
 
 Running
@@ -18,7 +18,7 @@ To programatically run simulations, it's recommended to use the OpenStudio `Comm
 Two general approaches (basic and advanced) for running via the CLI are described below.
 The OpenStudio measures can also be run from user interfaces (e.g., the OpenStudio Application or OpenStudio Parametric Analysis Tool (PAT)).
 
-.. note:: 
+.. note::
 
   If the ``openstudio`` command is not found, it's because the executable is not in your PATH. Either add the executable to your PATH or point directly to the executable found in the openstudio-X.X.X/bin directory.
 
@@ -37,7 +37,7 @@ You can also request generation of timeseries output CSV/JSON/MessagePack files
 | ``openstudio workflow/run_simulation.rb -x workflow/sample_files/base.xml --monthly fuels --monthly temperatures --output-format json``
 
 | You can also add a detailed schedule as part of the simulation by using:
-| ``openstudio workflow/run_simulation.rb -x workflow/sample_files/base.xml --add-detailed-schedule stochastic``
+| ``openstudio workflow/run_simulation.rb -x workflow/sample_files/base.xml --add-stochastic-schedules``
 | This run includes the automatic generation of a CSV file with stochastic occupancy schedules that are used in the EnergyPlus simulation.
 
 Run ``openstudio workflow/run_simulation.rb -h`` to see all available commands/arguments.