Generate EV schedules

.github/workflows/config.yml

@@ -33,14 +33,19 @@ jobs:
           git config --global --add safe.directory $(realpath .)
           git diff --exit-code --ignore-cr-at-eol *.rb
 
-      - name: Check HPXMLs
+      - name: Check HPXMLs/Schedules
         shell: bash
         run: |
           echo "Regenerating HPXML files..."
           openstudio tasks.rb update_hpxmls
-          echo "Checking for HPXML differences..."
           git config --global --add safe.directory $(realpath .)
+          echo "Checking for HPXML differences..."
+          echo "If differences are found below, then HPXMLs need to be regenerated using: openstudio tasks.rb update_hpxmls"
           git diff --exit-code --ignore-cr-at-eol workflow/*.xml
+          echo "Checking for schedule CSV differences..."
+          echo "If differences are found below, then schedule CSVs need to be regenerated using: openstudio tasks.rb update_hpxmls"
+          git diff --stat --ignore-cr-at-eol HPXMLtoOpenStudio/resources/schedule_files/*.csv
+          git diff --quiet --ignore-cr-at-eol HPXMLtoOpenStudio/resources/schedule_files/*.csv
 
       - name: Run measure unit tests
         run: |

BuildResidentialScheduleFile/measure.rb

@@ -144,7 +144,6 @@ def run(model, runner, user_arguments)
         epw_path = Location.get_epw_path(hpxml_bldg, hpxml_path)
         weather = WeatherFile.new(epw_path: epw_path, runner: runner, hpxml: hpxml)
       end
-
       # deterministically vary schedules across building units
       args[:random_seed] *= (i + 1)
 
@@ -205,7 +204,7 @@ def create_schedules(runner, hpxml, hpxml_bldg, weather, args)
     get_generator_inputs(hpxml_bldg, weather, args)
 
     args[:resources_path] = File.join(File.dirname(__FILE__), 'resources')
-    schedule_generator = ScheduleGenerator.new(runner: runner, **args)
+    schedule_generator = ScheduleGenerator.new(runner: runner, hpxml_bldg: hpxml_bldg, **args)
 
     success = schedule_generator.create(args: args, weather: weather)
     return false if not success
@@ -244,8 +243,6 @@ def get_simulation_parameters(hpxml, weather, args)
       args[:minutes_per_step] = hpxml.header.timestep
     end
     args[:steps_in_day] = 24 * 60 / args[:minutes_per_step]
-    args[:mkc_ts_per_day] = 96
-    args[:mkc_ts_per_hour] = args[:mkc_ts_per_day] / 24
 
     calendar_year = Location.get_sim_calendar_year(hpxml.header.sim_calendar_year, weather)
     args[:sim_year] = calendar_year

BuildResidentialScheduleFile/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>build_residential_schedule_file</name>
   <uid>f770b2db-1a9f-4e99-99a7-7f3161a594b1</uid>
-  <version_id>c5bb6758-f028-455a-a49d-25f4df40e500</version_id>
-  <version_modified>2025-01-02T23:31:30Z</version_modified>
+  <version_id>54e905ce-2e27-4eed-bdc5-f9d3f46626b3</version_id>
+  <version_modified>2025-01-10T00:56:23Z</version_modified>
   <xml_checksum>03F02484</xml_checksum>
   <class_name>BuildResidentialScheduleFile</class_name>
   <display_name>Schedule File Builder</display_name>
@@ -133,7 +133,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>F7D77A2C</checksum>
+      <checksum>4DA9EA23</checksum>
     </file>
     <file>
       <filename>README.md</filename>
@@ -229,7 +229,7 @@
       <filename>schedules.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>F14B1337</checksum>
+      <checksum>C097736B</checksum>
     </file>
     <file>
       <filename>shower_cluster_size_probability.csv</filename>
@@ -931,7 +931,7 @@
       <filename>test_build_residential_schedule_file.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>04AE998D</checksum>
+      <checksum>E9DDC3BC</checksum>
     </file>
   </files>
 </measure>

BuildResidentialScheduleFile/tests/test_build_residential_schedule_file.rb

@@ -332,6 +332,22 @@ def test_zero_occupants
     assert_empty(hpxml.buildings[0].header.schedules_filepaths)
   end
 
+  def test_ev_battery
+    num_occupants = 1.0
+
+    hpxml = _create_hpxml('base-vehicle-ev-charger.xml')
+    hpxml.buildings[0].building_occupancy.number_of_residents = num_occupants
+    XMLHelper.write_file(hpxml.to_doc, @tmp_hpxml_path)
+
+    @args_hash['output_csv_path'] = File.absolute_path(File.join(@tmp_output_path, 'occupancy-stochastic.csv'))
+    hpxml, _result = _test_measure()
+    sf = SchedulesFile.new(schedules_paths: hpxml.buildings[0].header.schedules_filepaths,
+                           year: @year,
+                           output_path: @tmp_schedule_file_path)
+    assert_in_epsilon(6201, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ElectricVehicleCharging].name, schedules: sf.tmp_schedules), @tol)
+    assert_in_epsilon(729.9, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ElectricVehicleDischarging].name, schedules: sf.tmp_schedules), @tol)
+  end
+
   def test_multiple_buildings
     hpxml = _create_hpxml('base-bldgtype-mf-whole-building.xml')
     hpxml.buildings.each do |hpxml_bldg|

HPXMLtoOpenStudio/resources/data/unavailable_periods.csv

@@ -1,5 +1,7 @@
 Schedule Name,Vacancy,Power Outage,No Space Heating,No Space Cooling
 occupants,1,0,0,0
+ev_occupant,1,0,0,0
+present_occupants,1,0,0,0
 lighting_interior,1,1,0,0
 lighting_exterior,1,1,0,0
 lighting_garage,1,1,0,0

HPXMLtoOpenStudio/resources/schedules.rb

@@ -1017,6 +1017,8 @@ def initialize(name, used_by_unavailable_periods, can_be_stochastic, type)
   # periods CSV (e.g., heating), and/or C) EnergyPlus-specific schedules (e.g., battery_charging).
   Columns = {
     Occupants: Column.new('occupants', true, true, :frac),
+    EVOccupant: Column.new('ev_occupant', true, false, :int),
+    PresentOccupants: Column.new('present_occupants', true, false, :int),
     LightingInterior: Column.new('lighting_interior', true, true, :frac),
     LightingExterior: Column.new('lighting_exterior', true, false, :frac),
     LightingGarage: Column.new('lighting_garage', true, true, :frac),
@@ -1081,6 +1083,7 @@ def initialize(runner: nil,
     return if schedules_paths.empty?
 
     @year = year
+    @runner = runner
     import(schedules_paths)
     create_battery_charging_discharging_schedules
     expand_schedules
@@ -1123,6 +1126,7 @@ def includes_col_name(col_name)
   def import(schedules_paths)
     num_hrs_in_year = Calendar.num_hours_in_year(@year)
     @schedules = {}
+    col2path = {}
     schedules_paths.each do |schedules_path|
       # Note: We don't use the CSV library here because it's slow for large files
       columns = File.readlines(schedules_path).map(&:strip).map { |r| r.split(',') }.transpose
@@ -1176,6 +1180,7 @@ def import(schedules_paths)
         end
 
         @schedules[col_name] = values
+        col2path[col_name] = schedules_path
       end
     end
   end

workflow/run_simulation.rb

@@ -18,7 +18,7 @@
 def run_workflow(basedir, rundir, hpxml, debug, skip_validation, add_comp_loads,
                  output_format, building_id, ep_input_format, stochastic_schedules,
                  hourly_outputs, daily_outputs, monthly_outputs, timestep_outputs,
-                 skip_simulation)
+                 skip_simulation, master_seed)
 
   measures_dir = File.join(basedir, '..')
   measures = {}
@@ -32,6 +32,7 @@ def run_workflow(basedir, rundir, hpxml, debug, skip_validation, add_comp_loads,
     args['output_csv_path'] = File.join(rundir, 'stochastic.csv')
     args['debug'] = debug
     args['building_id'] = building_id
+    args['schedules_random_seed'] = master_seed
     measures[measure_subdir] = [args]
   end
 
@@ -164,6 +165,11 @@ def run_workflow(basedir, rundir, hpxml, debug, skip_validation, add_comp_loads,
     options[:stochastic_schedules] = true
   end
 
+  options[:master_seed] = nil
+  opts.on('--master-seed SEED', Integer, 'Master seed for random number generation') do |t|
+    options[:master_seed] = t
+  end
+
   options[:ep_input_format] = 'idf'
   opts.on('--ep-input-format TYPE', 'EnergyPlus input file format (idf, epjson)') do |t|
     options[:ep_input_format] = t
@@ -228,7 +234,7 @@ def run_workflow(basedir, rundir, hpxml, debug, skip_validation, add_comp_loads,
   success = run_workflow(basedir, rundir, options[:hpxml], options[:debug], options[:skip_validation], options[:add_comp_loads],
                          options[:output_format], options[:building_id], options[:ep_input_format], options[:stochastic_schedules],
                          options[:hourly_outputs], options[:daily_outputs], options[:monthly_outputs], options[:timestep_outputs],
-                         options[:skip_simulation])
+                         options[:skip_simulation], options[:master_seed])
 
   if not success
     exit! 1