Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML int…
Browse files Browse the repository at this point in the history 
…o ev_batteries

# Conflicts:
#	BuildResidentialHPXML/measure.xml
#	HPXMLtoOpenStudio/measure.rb
#	HPXMLtoOpenStudio/measure.xml
#	HPXMLtoOpenStudio/resources/battery.rb
#	HPXMLtoOpenStudio/resources/data/unavailable_periods.csv
#	HPXMLtoOpenStudio/resources/defaults.rb
#	HPXMLtoOpenStudio/resources/hpxml_schema/HPXML.xsd
#	HPXMLtoOpenStudio/resources/schedules.rb
#	ReportSimulationOutput/measure.xml
#	workflow/tests/base_results/results_simulations_energy.csv
  • Loading branch information
@shorowit
shorowit committed Oct 15, 2024
2 parents 1198abd + 09c7cd1 commit 9c373df
Show file tree
Hide file tree
Showing 183 changed files with 74,615 additions and 17,190 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/config.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ jobs:
mkdir workflow/tests/test_results
cp -r test_results/results* workflow/tests/test_results
cd workflow/tests
pip install pandas
pip install pandas --break-system-packages
for csv in test_results/*1_*.csv; do csv2="${csv/1_/2_}"; csv_out="${csv/1_/_}"; python merge.py $csv $csv2 $csv_out; rm $csv; rm $csv2; done
- name: Store results
Expand Down Expand Up @@ -206,10 +206,10 @@ jobs:
mkdir workflow/tests/test_results
cp -r test_results/results* workflow/tests/test_results
pip install numpy
pip install pandas
pip install plotly
pip install kaleido
pip install numpy --break-system-packages
pip install pandas --break-system-packages
pip install plotly --break-system-packages
pip install kaleido --break-system-packages
python workflow/tests/compare.py -a results
python workflow/tests/compare.py -a visualize
Expand Down
106 changes: 79 additions & 27 deletions BuildResidentialHPXML/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,33 +77,33 @@ Absolute/relative paths of csv files containing user-specified detailed schedule

<br/>

**Schedules: Vacancy Periods**
**Schedules: Unavailable Period Types**

Specifies the vacancy periods. Enter a date like "Dec 15 - Jan 15". Optionally, can enter hour of the day like "Dec 15 2 - Jan 15 20" (start hour can be 0 through 23 and end hour can be 1 through 24). If multiple periods, use a comma-separated list.
Specifies the unavailable period types. Possible types are column names defined in unavailable_periods.csv: Vacancy, Power Outage, No Space Heating, No Space Cooling. If multiple periods, use a comma-separated list.

- **Name:** ``schedules_vacancy_periods``
- **Name:** ``schedules_unavailable_period_types``
- **Type:** ``String``

- **Required:** ``false``

<br/>

**Schedules: Power Outage Periods**
**Schedules: Unavailable Period Dates**

Specifies the power outage periods. Enter a date like "Dec 15 - Jan 15". Optionally, can enter hour of the day like "Dec 15 2 - Jan 15 20" (start hour can be 0 through 23 and end hour can be 1 through 24). If multiple periods, use a comma-separated list.
Specifies the unavailable period date ranges. Enter a date range like "Dec 15 - Jan 15". Optionally, can enter hour of the day like "Dec 15 2 - Jan 15 20" (start hour can be 0 through 23 and end hour can be 1 through 24). If multiple periods, use a comma-separated list.

- **Name:** ``schedules_power_outage_periods``
- **Name:** ``schedules_unavailable_period_dates``
- **Type:** ``String``

- **Required:** ``false``

<br/>

**Schedules: Power Outage Periods Window Natural Ventilation Availability**
**Schedules: Unavailable Period Window Natural Ventilation Availabilities**

The availability of the natural ventilation schedule during the power outage periods. Valid choices are 'regular schedule', 'always available', 'always unavailable'. If multiple periods, use a comma-separated list.
The availability of the natural ventilation schedule during unavailable periods. Valid choices are: regular schedule, always available, always unavailable. If multiple periods, use a comma-separated list. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-unavailable-periods'>HPXML Unavailable Periods</a>) is used.

- **Name:** ``schedules_power_outage_periods_window_natvent_availability``
- **Name:** ``schedules_unavailable_period_window_natvent_availabilities``
- **Type:** ``String``

- **Required:** ``false``
Expand All @@ -125,7 +125,7 @@ Value must be a divisor of 60. If not provided, the OS-HPXML default (see <a hre

**Simulation Control: Run Period**

Enter a date like 'Jan 1 - Dec 31'. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-simulation-control'>HPXML Simulation Control</a>) is used.
Enter a date range like 'Jan 1 - Dec 31'. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-simulation-control'>HPXML Simulation Control</a>) is used.

- **Name:** ``simulation_control_run_period``
- **Type:** ``String``
Expand Down Expand Up @@ -160,7 +160,7 @@ Whether to use daylight saving. If not provided, the OS-HPXML default (see <a hr

**Simulation Control: Daylight Saving Period**

Enter a date like 'Mar 15 - Dec 15'. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-building-site'>HPXML Building Site</a>) is used.
Enter a date range like 'Mar 15 - Dec 15'. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-building-site'>HPXML Building Site</a>) is used.

- **Name:** ``simulation_control_daylight_saving_period``
- **Type:** ``String``
Expand Down Expand Up @@ -323,7 +323,7 @@ State code of the home address. If not provided, the OS-HPXML default (see <a hr

**Site: Zip Code**

Zip code of the home address.
Zip code of the home address. Either this or the Weather Station: EnergyPlus Weather (EPW) Filepath input below must be provided.

- **Name:** ``site_zip_code``
- **Type:** ``String``
Expand Down Expand Up @@ -386,12 +386,12 @@ Longitude of the home address. Must be between -180 and 180. Use negative values

**Weather Station: EnergyPlus Weather (EPW) Filepath**

Path of the EPW file.
Path of the EPW file. Either this or the Site: Zip Code input above must be provided.

- **Name:** ``weather_station_epw_filepath``
- **Type:** ``String``

- **Required:** ``true``
- **Required:** ``false``

<br/>

Expand Down Expand Up @@ -591,6 +591,19 @@ Average distance from the floor to the ceiling.

<br/>

**Geometry: Unit Height Above Grade**

Describes the above-grade height of apartment units on upper floors or homes above ambient or belly-and-wing foundations. It is defined as the height of the lowest conditioned floor above grade and is used to calculate the wind speed for the infiltration model. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-building-construction'>HPXML Building Construction</a>) is used.

- **Name:** ``geometry_unit_height_above_grade``
- **Type:** ``Double``

- **Units:** ``ft``

- **Required:** ``false``

<br/>

**Geometry: Garage Width**

The width of the garage. Enter zero for no garage. Only applies to single-family detached units.
Expand Down Expand Up @@ -1421,9 +1434,22 @@ Full-assembly NFRC solar heat gain coefficient.

<br/>

**Windows: Winter Interior Shading**
**Windows: Interior Shading Type**

Type of window interior shading. Summer/winter shading coefficients can be provided below instead. If neither is provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-interior-shading'>HPXML Interior Shading</a>) is used.

- **Name:** ``window_interior_shading_type``
- **Type:** ``Choice``

- **Required:** ``false``

- **Choices:** `light curtains`, `light shades`, `light blinds`, `medium curtains`, `medium shades`, `medium blinds`, `dark curtains`, `dark shades`, `dark blinds`, `none`

<br/>

Interior shading coefficient for the winter season. 1.0 indicates no reduction in solar gain, 0.85 indicates 15% reduction, etc. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-windows'>HPXML Windows</a>) is used.
**Windows: Winter Interior Shading Coefficient**

Interior shading coefficient for the winter season, which if provided overrides the shading type input. 1.0 indicates no reduction in solar gain, 0.85 indicates 15% reduction, etc. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-interior-shading'>HPXML Interior Shading</a>) is used.

- **Name:** ``window_interior_shading_winter``
- **Type:** ``Double``
Expand All @@ -1434,9 +1460,9 @@ Interior shading coefficient for the winter season. 1.0 indicates no reduction i

<br/>

**Windows: Summer Interior Shading**
**Windows: Summer Interior Shading Coefficient**

Interior shading coefficient for the summer season. 1.0 indicates no reduction in solar gain, 0.85 indicates 15% reduction, etc. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-windows'>HPXML Windows</a>) is used.
Interior shading coefficient for the summer season, which if provided overrides the shading type input. 1.0 indicates no reduction in solar gain, 0.85 indicates 15% reduction, etc. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-interior-shading'>HPXML Interior Shading</a>) is used.

- **Name:** ``window_interior_shading_summer``
- **Type:** ``Double``
Expand All @@ -1447,9 +1473,22 @@ Interior shading coefficient for the summer season. 1.0 indicates no reduction i

<br/>

**Windows: Winter Exterior Shading**
**Windows: Exterior Shading Type**

Type of window exterior shading. Summer/winter shading coefficients can be provided below instead. If neither is provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-exterior-shading'>HPXML Exterior Shading</a>) is used.

- **Name:** ``window_exterior_shading_type``
- **Type:** ``Choice``

- **Required:** ``false``

- **Choices:** `solar film`, `solar screens`, `none`

<br/>

**Windows: Winter Exterior Shading Coefficient**

Exterior shading coefficient for the winter season. 1.0 indicates no reduction in solar gain, 0.85 indicates 15% reduction, etc. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-windows'>HPXML Windows</a>) is used.
Exterior shading coefficient for the winter season, which if provided overrides the shading type input. 1.0 indicates no reduction in solar gain, 0.85 indicates 15% reduction, etc. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-exterior-shading'>HPXML Exterior Shading</a>) is used.

- **Name:** ``window_exterior_shading_winter``
- **Type:** ``Double``
Expand All @@ -1460,9 +1499,9 @@ Exterior shading coefficient for the winter season. 1.0 indicates no reduction i

<br/>

**Windows: Summer Exterior Shading**
**Windows: Summer Exterior Shading Coefficient**

Exterior shading coefficient for the summer season. 1.0 indicates no reduction in solar gain, 0.85 indicates 15% reduction, etc. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-windows'>HPXML Windows</a>) is used.
Exterior shading coefficient for the summer season, which if provided overrides the shading type input. 1.0 indicates no reduction in solar gain, 0.85 indicates 15% reduction, etc. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-exterior-shading'>HPXML Exterior Shading</a>) is used.

- **Name:** ``window_exterior_shading_summer``
- **Type:** ``Double``
Expand All @@ -1475,7 +1514,7 @@ Exterior shading coefficient for the summer season. 1.0 indicates no reduction i

**Windows: Shading Summer Season**

Enter a date like 'May 1 - Sep 30'. Defines the summer season for purposes of shading coefficients; the rest of the year is assumed to be winter. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-windows'>HPXML Windows</a>) is used.
Enter a date range like 'May 1 - Sep 30'. Defines the summer season for purposes of shading coefficients; the rest of the year is assumed to be winter. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-windows'>HPXML Windows</a>) is used.

- **Name:** ``window_shading_summer_season``
- **Type:** ``String``
Expand All @@ -1484,6 +1523,19 @@ Enter a date like 'May 1 - Sep 30'. Defines the summer season for purposes of sh

<br/>

**Windows: Insect Screens**

The type of insect screens, if present. If not provided, assumes there are no insect screens.

- **Name:** ``window_insect_screens``
- **Type:** ``Choice``

- **Required:** ``false``

- **Choices:** `none`, `exterior`, `interior`

<br/>

**Windows: Storm Type**

The type of storm, if present. If not provided, assumes there is no storm.
Expand Down Expand Up @@ -2949,7 +3001,7 @@ Specify the constant or 24-hour comma-separated weekend cooling setpoint schedul

**HVAC Control: Heating Season Period**

Enter a date like 'Nov 1 - Jun 30'. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-hvac-control'>HPXML HVAC Control</a>) is used. Can also provide 'BuildingAmerica' to use automatic seasons from the Building America House Simulation Protocols.
Enter a date range like 'Nov 1 - Jun 30'. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-hvac-control'>HPXML HVAC Control</a>) is used. Can also provide 'BuildingAmerica' to use automatic seasons from the Building America House Simulation Protocols.

- **Name:** ``hvac_control_heating_season_period``
- **Type:** ``String``
Expand All @@ -2960,7 +3012,7 @@ Enter a date like 'Nov 1 - Jun 30'. If not provided, the OS-HPXML default (see <

**HVAC Control: Cooling Season Period**

Enter a date like 'Jun 1 - Oct 31'. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-hvac-control'>HPXML HVAC Control</a>) is used. Can also provide 'BuildingAmerica' to use automatic seasons from the Building America House Simulation Protocols.
Enter a date range like 'Jun 1 - Oct 31'. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-hvac-control'>HPXML HVAC Control</a>) is used. Can also provide 'BuildingAmerica' to use automatic seasons from the Building America House Simulation Protocols.

- **Name:** ``hvac_control_cooling_season_period``
- **Type:** ``String``
Expand Down Expand Up @@ -3680,7 +3732,7 @@ The location of water heater. If not provided, the OS-HPXML default (see <a href

**Water Heater: Tank Volume**

Nominal volume of water heater tank. Only applies to storage water heater, heat pump water heater, and space-heating boiler with storage tank. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#conventional-storage'>Conventional Storage</a>, <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#heat-pump'>Heat Pump</a>, <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#combi-boiler-w-storage'>Combi Boiler w/ Storage</a>) is used.
Nominal volume of water heater tank. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#conventional-storage'>Conventional Storage</a>, <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#heat-pump'>Heat Pump</a>, <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#combi-boiler-w-storage'>Combi Boiler w/ Storage</a>) is used.

- **Name:** ``water_heater_tank_volume``
- **Type:** ``Double``
Expand Down Expand Up @@ -4751,7 +4803,7 @@ The daily energy consumption for holiday lighting (exterior). If not provided, t

**Holiday Lighting: Period**

Enter a date like 'Nov 25 - Jan 5'. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-lighting'>HPXML Lighting</a>) is used.
Enter a date range like 'Nov 25 - Jan 5'. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.8.1/workflow_inputs.html#hpxml-lighting'>HPXML Lighting</a>) is used.

- **Name:** ``holiday_lighting_period``
- **Type:** ``String``
Expand Down
Loading

0 comments on commit 9c373df

Please sign in to comment.