Model EV Batteries #1533

aspeake · 2023-10-30T23:15:48Z

Pull Request Description

Allows detailed modeling of EVs using the EnergyPlus battery model, whereas previous EV charging was limited to a simple plug load. This PR adds arguments to define EV battery parameters, EV charger parameters, driving behavior such as miles traveled, and detailed charging and discharging schedules. The E+ battery model was used so that bidirectional charging can be supported in the future, but this capability is not included in this PR.

Key aspects of this PR include:

Leveraging the new Vehicles element in HPXML
A new vehicles.rb file to apply an EV as ElectricLoadCenter:Storage:LiIonNMCBattery object
Calls methods in battery.rb and uses some existing battery defaults
Default charging/discharging schedules based on stock data and potential for user-defined schedule files
EMS program in vehicles.rb to
- Scale the effective discharge power based on ambient temperature
- Track "unmet driving hours"
Outputs charging energy with the existing "End Use" type Electricity: Electric Vehicle Charging (MBtu) and writes a new "Unmet Hours" output type Driving (hr) (if specified)

Companion HPXML PR: hpxmlwg/hpxml#403
Schedule generation PR: #1757

Checklist

PR Author: Check these when they're done. Not all may apply. ~~strikethrough~~ and check any that do not apply.

PR Reviewer: Verify each has been completed.

Schematron validator (EPvalidator.xml) has been updated
Sample files have been added/updated (via tasks.rb)
Tests have been added/updated (e.g., HPXMLtoOpenStudio/tests and/or workflow/tests/hpxml_translator_test.rb)
Documentation has been updated
Changelog has been updated
openstudio tasks.rb update_measures has been run
No unexpected changes to simulation results of sample files

…ery schedules

…o ev_batteries # Conflicts: # BuildResidentialHPXML/measure.rb # HPXMLtoOpenStudio/resources/battery.rb # HPXMLtoOpenStudio/resources/hpxml_defaults.rb

… into ev_batteries

shorowit · 2024-01-23T19:01:32Z

@aspeake I assume we will need to add error-checking for multiple batteries? I.e., you can't have two EV batteries, and you can't have one EV battery and one home battery. See here for context. Unless you are trying to address this limitation.

aspeake · 2024-01-23T20:46:37Z

@aspeake I assume we will need to add error-checking for multiple batteries? I.e., you can't have two EV batteries, and you can't have one EV battery and one home battery. See here for context. Unless you are trying to address this limitation.

Yes, for now we plan to limit to 1 EV/unit. However, the current implementation does allow for one home battery and one EV battery and expects separate schedules for each.

shorowit · 2024-01-23T21:27:27Z

However, the current implementation does allow for one home battery and one EV battery and expects separate schedules for each.

I assume that probably won't work, for the same reason that modeling two home batteries wasn't previously supported. But we can worry about that later. More of a heads up for now.

aspeake · 2025-01-06T16:21:46Z

BuildResidentialHPXML/measure.rb

+    arg = OpenStudio::Measure::OSArgument::makeDoubleArgument('ev_miles_per_year', false)
+    arg.setDisplayName('Electric Vehicle: Miles Traveled')
+    arg.setDescription('The annual miles traveled by the EV.')
+    arg.setUnits('miles')
+    args << arg


Used to calculate the effective discharge power in vehicles.rb (power = kwh/mile * annl_miles / driving hours)

aspeake · 2025-01-06T16:22:31Z

BuildResidentialHPXML/measure.rb

+    arg = OpenStudio::Measure::OSArgument::makeDoubleArgument('ev_hours_per_week', false)
+    arg.setDisplayName('Electric Vehicle: Hours Driven per Week')
+    arg.setDescription('The weekly hours traveled by the EV.')
+    arg.setUnits('hours')
+    args << arg


Not currently used, but will be needed in schedule generation PR

aspeake · 2025-01-06T16:26:37Z

BuildResidentialHPXML/measure.rb

+    arg = OpenStudio::Measure::OSArgument::makeDoubleArgument('ev_fraction_charged_home', false)
+    arg.setDisplayName('Electric Vehicle: Fraction Charged at Home')
+    arg.setDescription('The fraction charging energy provided by the at-home charger.')
+    args << arg


Not sure if this argument belongs here. It will be used in ResStockArguments to scale the miles/year, which influences the schedule. I liked that it persists into the HPXML to give context to the miles/year, but the fraction is not used directly in OS-HPXML.

I don't follow. Why wouldn't OS-HPXML use this?This should affect how much charging is done at home, no?

… into ev_batteries

aspeake · 2025-01-06T18:30:15Z

HPXMLtoOpenStudio/resources/battery.rb

      charging_schedule = schedules_file.create_schedule_file(model, col_name: SchedulesFile::Columns[:BatteryCharging].name)
      discharging_schedule = schedules_file.create_schedule_file(model, col_name: SchedulesFile::Columns[:BatteryDischarging].name)
+    elsif is_ev
+      charging_schedule, discharging_schedule = Vehicle.get_ev_charging_schedules(runner, model, battery, schedules_file)


Get schedule file or schedule ruleset for EV

aspeake · 2025-01-06T21:15:35Z

HPXMLtoOpenStudio/resources/vehicle.rb

+    # Calculate effective discharge power and rated power output
+    # Scale the effective discharge power by 2.25 to assign the rated discharge power. This value reflects the maximum power adjustment allowed in the EMS EV discharge program at -17.8 C.
+    ev_annl_energy = vehicle.energy_efficiency * vehicle.miles_per_year # kWh/year
+    eff_discharge_power = UnitConversions.convert(ev_annl_energy / annual_driving_hours, 'kw', 'w') # W
+    vehicle.rated_power_output = eff_discharge_power * 2.25


The rated power output is set to avoid ever limiting the actual discharge power at a timestep. This means that some combinations of inputs could result in very high and unrealistic effective discharge powers (eg, high miles, low hours == high annual energy over a short amount of hours). Granted, this would only happen under unrealistic combinations of inputs.

aspeake · 2025-01-07T17:03:05Z

HPXMLtoOpenStudio/resources/data/ev_national_average_schedules.csv

Thoughts on including this file which shows the calculation of the default vehicle charging/discharging schedules?

…o ev_batteries # Conflicts: # HPXMLtoOpenStudio/measure.xml

shorowit

There is a lot of good stuff here. Here's my initial batch of comments, mostly focused on the BuildResHPXML measure, hpxml.rb class, schematron, and documentation. My main comments are:

Generalize the HPXML Vehicle implementation; we are only modeling EVs today, but everything should be generalized in case we include other vehicle types in the future.
Use better consistency between HPXML schema and arguments/properties/variables/descriptions.

shorowit · 2025-01-10T20:29:50Z

BuildResidentialHPXML/measure.rb

+    arg = OpenStudio::Measure::OSArgument::makeBoolArgument('ev_battery_present', false)
+    arg.setDisplayName('Electric Vehicle: Present')
+    arg.setDescription('Whether there is an electric vehicle battery present. If the `misc_plug_loads_vehicle_present` argument is true, this argument is superseded and vehicle charging will be modeled as a plug load only.')
+    arg.setDefaultValue(false)
+    args << arg
+
+    arg = OpenStudio::Measure::OSArgument::makeDoubleArgument('ev_battery_capacity', false)


Could you generalize this to better match the generic Vehicle element in HPXML? I.e.:

Replace "Electric Vehicle: Present" with "Vehicle: Type" where you can choose EV, ICE, etc., or "none". Default to "none".

Change all the display names from "Electric Vehicle: Foo" to be "Vehicle: Foo" and, for those arguments that only apply for certain vehicle types, say so in the description. (You'll find lots of examples of this in the code.) You may have to update the set_electric_vehicle() method a bit too use the vehicle type argument.

Change all descriptions to refer to "vehicle" instead of "EV".

Change all the arguments from ev_battery_foo to vehicle_foo.

This would allow someone to create an HPXML with other vehicle types too. Hopefully not too much work...

shorowit · 2025-01-10T20:33:49Z

BuildResidentialHPXML/measure.rb

+
+    arg = OpenStudio::Measure::OSArgument::makeDoubleArgument('ev_battery_capacity', false)
+    arg.setDisplayName('Electric Vehicle: Nominal Battery Capacity')
+    arg.setDescription('The nominal capacity of the EV battery. If not provided, the OS-HPXML default is used.')


Anytime you say "the OS-HPXML default is used", please include a link to the documentation. You'll find lots of examples where we do this.

shorowit · 2025-01-10T20:36:55Z

BuildResidentialHPXML/measure.rb

    arg = OpenStudio::Measure::OSArgument::makeIntegerArgument('battery_num_bedrooms_served', false)
    arg.setDisplayName('Battery: Number of Bedrooms Served')


Looks like this home battery argument got split from the rest. Please move it up.

shorowit · 2025-01-10T20:44:28Z

BuildResidentialHPXML/measure.rb

+    arg = OpenStudio::Measure::OSArgument::makeDoubleArgument('ev_energy_efficiency', false)
+    arg.setDisplayName('Electric Vehicle: Energy Efficiency')
+    arg.setDescription('The efficiency of the EV. If not provided, the OS-HPXML default is used.')


There is no "Energy Efficiency" element in the HPXML. Please use the same names that are used in the schema, otherwise it is confusing. Seems like it is "Combined Fuel Economy"?

Also, we should probably split this argument in two: the units (choice enumeration, it's fine if only "kWh/mile" is supported today) and the value. You can find examples of this in other arguments in the measure.

shorowit · 2025-01-10T20:45:11Z

BuildResidentialHPXML/measure.rb

+    arg = OpenStudio::Measure::OSArgument::makeDoubleArgument('ev_miles_per_year', false)
+    arg.setDisplayName('Electric Vehicle: Miles Traveled')


Match HPXML schema... I assume "Miles Driven Per Year"?

shorowit · 2025-01-10T22:11:37Z

HPXMLtoOpenStudio/resources/schedule_files/battery-ev-low-charge.csv

Can we rename to vehicle-ev-foo.csv?

shorowit · 2025-01-10T22:11:48Z

HPXMLtoOpenStudio/resources/schedule_files/battery-ev.csv

Can we rename to vehicle-ev.csv?

shorowit · 2025-01-10T22:13:45Z

docs/source/workflow_outputs.rst

@@ -93,7 +93,7 @@ Annual energy outputs are listed below.
  ====================================  ===========================
  Type                                  Notes
  ====================================  ===========================
-  Energy Use: Total (MBtu)              Total energy consumption; includes any battery charging/discharging
+  Energy Use: Total (MBtu)              Total energy consumption; includes any home battery charging/discharging, excludes electric vehicle discharging


Kind of confused by this since it doesn't say anything about EV charging. Is this a simpler version of what you're trying to say?

Suggested change

Energy Use: Total (MBtu) Total energy consumption; includes any home battery charging/discharging, excludes electric vehicle discharging

Energy Use: Total (MBtu) Total energy consumption; includes any home battery charging/discharging and EV charging

Make similar edits below.

shorowit · 2025-01-10T22:14:37Z

docs/source/workflow_outputs.rst

Need to add Unmet Hours: Driving (hr) output and description.

shorowit · 2025-01-10T22:23:22Z

HPXMLtoOpenStudio/resources/vehicle.rb

+  def self.apply_electric_vehicle(runner, model, spaces, hpxml_bldg, vehicle, schedules_file)
+    model.getElectricEquipments.sort.each do |ee|
+      if ee.endUseSubcategory.start_with? Constants::ObjectTypeMiscElectricVehicleCharging
+        runner.registerWarning('Electric vehicle was specified as a plug load and as a battery, vehicle charging will be modeled as a plug load.')


Glad to see you have a warning for this. 👍

Suggested change

runner.registerWarning('Electric vehicle was specified as a plug load and as a battery, vehicle charging will be modeled as a plug load.')

runner.registerWarning('Electric vehicle charging was specified as both a PlugLoad and a Vehicle, the latter will be ignored.')

(If you accept the suggestion, there are other files that need to be updated too.)

…assigned garage doors.

shorowit · 2025-01-10T22:28:23Z

docs/source/workflow_outputs.rst

Looks like you also changed the order of where the EV charging output occurs. That's probably fine, but please update the order in the documentation too.

shorowit · 2025-01-10T22:33:04Z

HPXMLtoOpenStudio/resources/vehicle.rb

+    # Assign charging and vehicle space
+    ev_charger = vehicle.ev_charger
+    if ev_charger.nil?
+      runner.registerWarning('Electric vehicle specified with no charger provided; battery will not be modeled.')


Suggested change

runner.registerWarning('Electric vehicle specified with no charger provided; battery will not be modeled.')

runner.registerWarning('Electric vehicle specified with no charger provided; EV charging will not be modeled.')

shorowit · 2025-01-10T22:35:09Z

HPXMLtoOpenStudio/resources/vehicle.rb

+    # Get schedules to calculate effective discharge power
+    charging_schedule, discharging_schedule = get_ev_charging_schedules(runner, model, vehicle, schedules_file)
+    if charging_schedule.nil? && discharging_schedule.nil?
+      runner.registerWarning('Electric vehicle battery specified with no charging/discharging schedule provided; battery will not be modeled.')


I'm confused. Are schedules required? The schematron/docs say they are optional and that there are defaults.

shorowit · 2025-01-11T00:52:14Z

HPXMLtoOpenStudio/resources/vehicle.rb

+    hpxml_bldg.vehicles.each do |vehicle|
+      next unless vehicle.vehicle_type == HPXML::VehicleTypeBEV


We should also add a warning for non-BEV vehicles to make it clear we are not modeling them. Something like this. And add a test in test_validation.rb.

aspeake added 7 commits October 27, 2023 16:49

new arguments and method to write EV battery to xml

7b651b0

custom schedule columns for EV batteries

36492fb

fix ev battery schedule generation, generalize for ev and non-ev batt…

08c8c5a

…ery schedules

allow one EV and one non-EV battery in schema

3f94374

stub out defaults for EV batteries

744ad66

update how battery ids are assigned in xml

4f1a37e

make ev_battery_preset argument optional

210c463

shorowit assigned aspeake Oct 31, 2023

shorowit added the enhancement New feature or request label Oct 31, 2023

shorowit and others added 13 commits November 2, 2023 08:57

Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML int…

5c36fcb

…o ev_batteries # Conflicts: # BuildResidentialHPXML/measure.rb # HPXMLtoOpenStudio/resources/battery.rb # HPXMLtoOpenStudio/resources/hpxml_defaults.rb

always require schedule when modeling ev batteries

01437d0

initial tests for ev batteries

8f33e3d

Merge remote-tracking branch 'origin/master' into ev_batteries

52bc3ab

add missing ev battery schedule for tests

9db3aeb

update log message tests for batteries

da8dc17

Merge remote-tracking branch 'origin/master' into ev_batteries

357ba18

fix test for battery log message

374aae8

Latest results.

2a9b7bb

Merge remote-tracking branch 'origin/master' into ev_batteries

dd4d5cf

Seperate EVs from batteries and leverage existing EV charger fields

61d39b6

Merge remote-tracking branch 'origin/master' into ev_batteries

22f00b2

Merge branch 'ev_batteries' of https://github.com/NREL/OpenStudio-HPXML…

0056e2c

… into ev_batteries

aspeake added 5 commits February 5, 2024 12:52

Refine inputs for EV battery and charger, update tests

f6b88a3

Merge remote-tracking branch 'origin/master' into ev_batteries

1effbc8

update unit tests for EVs and chargers; apply rubocop

6fbd4f5

Merge remote-tracking branch 'origin/master' into ev_batteries

bd3fbfe

fix failing tests for ev batteries

35e8be4

aspeake added 8 commits December 30, 2024 21:54

Fix incorrect if statement in resilience reporting.

d44ac99

New unit tests for EV and charger default values.

e444f74

Test for multiple battery types, EV and home.

5e5e107

Update schematron for BEVs and chargers.

792f79e

Remove unused sample xml.

35104b2

Merge remote-tracking branch 'origin/master' into ev_batteries

4892769

Update Changelog.

0ff6acb

Fix schematron check for EV charging location.

d9ffc48

aspeake commented Jan 6, 2025

View reviewed changes

GitHub Action and others added 3 commits January 6, 2025 17:02

Latest results.

d8605a9

Allow EV charger without an EV battery.

c6db1ac

Merge branch 'ev_batteries' of https://github.com/NREL/OpenStudio-HPXML…

39492f3

… into ev_batteries

aspeake commented Jan 6, 2025

View reviewed changes

aspeake added 3 commits January 6, 2025 16:31

Clean up measure and test code for EVs and chargers

0bff0a9

Fix warning check in workflow tests.

5ed1495

Catch unmet driving hours warning in workflow tests.

5070b3d

aspeake marked this pull request as ready for review January 7, 2025 00:27

aspeake requested a review from shorowit January 7, 2025 00:28

Address more warnings for workflow tests.

f49ce9a

aspeake commented Jan 7, 2025

View reviewed changes

GitHub Action and others added 2 commits January 7, 2025 17:35

Latest results.

307dad0

Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML int…

42be417

…o ev_batteries # Conflicts: # HPXMLtoOpenStudio/measure.xml

shorowit reviewed Jan 10, 2025

View reviewed changes

Minor unrelated improvement to make sure all HPXMLs with garages get …

9b24b18

…assigned garage doors.

shorowit reviewed Jan 10, 2025

View reviewed changes

Latest results.

0414143

shorowit reviewed Jan 11, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Model EV Batteries #1533

Model EV Batteries #1533

aspeake commented Oct 30, 2023 •

edited

Loading

shorowit commented Jan 23, 2024

aspeake commented Jan 23, 2024

shorowit commented Jan 23, 2024

aspeake Jan 6, 2025 •

edited

Loading

aspeake Jan 6, 2025

aspeake Jan 6, 2025

shorowit Jan 10, 2025

aspeake Jan 6, 2025

aspeake Jan 6, 2025

aspeake Jan 7, 2025

shorowit left a comment

shorowit Jan 10, 2025

shorowit Jan 10, 2025

shorowit Jan 10, 2025

shorowit Jan 10, 2025

shorowit Jan 10, 2025

shorowit Jan 10, 2025

shorowit Jan 10, 2025

shorowit Jan 10, 2025

shorowit Jan 10, 2025

shorowit Jan 10, 2025

shorowit Jan 10, 2025

shorowit Jan 10, 2025

shorowit Jan 10, 2025

shorowit Jan 11, 2025

		arg = OpenStudio::Measure::OSArgument::makeIntegerArgument('battery_num_bedrooms_served', false)
		arg.setDisplayName('Battery: Number of Bedrooms Served')

		arg = OpenStudio::Measure::OSArgument::makeDoubleArgument('ev_miles_per_year', false)
		arg.setDisplayName('Electric Vehicle: Miles Traveled')

	Energy Use: Total (MBtu) Total energy consumption; includes any home battery charging/discharging, excludes electric vehicle discharging
	Energy Use: Total (MBtu) Total energy consumption; includes any home battery charging/discharging and EV charging

	runner.registerWarning('Electric vehicle was specified as a plug load and as a battery, vehicle charging will be modeled as a plug load.')
	runner.registerWarning('Electric vehicle charging was specified as both a PlugLoad and a Vehicle, the latter will be ignored.')

		hpxml_bldg.vehicles.each do \|vehicle\|
		next unless vehicle.vehicle_type == HPXML::VehicleTypeBEV

Model EV Batteries #1533

Are you sure you want to change the base?

Model EV Batteries #1533

Conversation

aspeake commented Oct 30, 2023 • edited Loading

Pull Request Description

Checklist

shorowit commented Jan 23, 2024

aspeake commented Jan 23, 2024

shorowit commented Jan 23, 2024

aspeake Jan 6, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shorowit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aspeake commented Oct 30, 2023 •

edited

Loading

aspeake Jan 6, 2025 •

edited

Loading