Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Assign <blank> instead of, e.g., 0 to mean unused #1316

Draft
wants to merge 49 commits into
base: develop
Choose a base branch
from
Draft

Assign <blank> instead of, e.g., 0 to mean unused #1316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
ac98471
Squashed 'resources/hpxml-measures/' changes from 6980e23d12d3..ac06a…
joseph-robertson Oct 25, 2024
a6be5bc
Merge commit 'ac98471f37740dd5271603887f2e520a5ae2b46a' into lookup-u…
joseph-robertson Oct 25, 2024
d6bc566
Point to correct defaulting methods.
joseph-robertson Oct 25, 2024
fa746b8
Test new optional dehumidifier arguments in lookup.
joseph-robertson Oct 25, 2024
83c6c53
Merge branch 'latest-os-hpxml' into lookup-unused-args
joseph-robertson Oct 25, 2024
6ba024e
Merge branch 'latest-os-hpxml' into lookup-unused-args
joseph-robertson Oct 28, 2024
76502d7
Update UpgradeCosts test osw files.
joseph-robertson Oct 28, 2024
101f5f6
Latest results.
Oct 28, 2024
60b526e
Updates for water heater efficiency arguments.
joseph-robertson Oct 28, 2024
d1dec10
Try updating integration-tests job with python 3.11.
joseph-robertson Oct 29, 2024
b5f9400
Latest results.
Oct 29, 2024
36b2fd8
Conflict in measure xml file.
joseph-robertson Oct 29, 2024
97ef049
Updates for ceiling fan, appliances, mech vent, etc.
joseph-robertson Oct 29, 2024
b7a4598
Turn has_flue arguments into optional choice.
joseph-robertson Oct 29, 2024
66a5315
Update HVAC options.
joseph-robertson Oct 29, 2024
5c4703c
Latest results.
Oct 30, 2024
d8a26f3
Auto is only an option for choice arguments when an OS-HPXML default …
joseph-robertson Oct 30, 2024
4adb495
Auto is only an option for bool arguments when an OS-HPXML default is…
joseph-robertson Oct 30, 2024
c377635
Another sweep thru lookup of changing unused argument values to blank.
joseph-robertson Oct 30, 2024
8b89b4f
Catch a few places where auto is used to indicate none.
joseph-robertson Oct 30, 2024
69e6363
Change all cooling_system_integrated to blank to indicate none.
joseph-robertson Oct 30, 2024
fb5b1cd
Update Housing Characteristics docs header based on change to using b…
joseph-robertson Oct 30, 2024
4e1dcf4
Squashed 'resources/hpxml-measures/' changes from 76951e1802ad..06f62…
joseph-robertson Oct 30, 2024
c00544e
Merge commit '4e1dcf40f42a77ac6a57f2aee24b94d83cf05709' into lookup-u…
joseph-robertson Oct 30, 2024
90d7de2
Remove a few more instances in lookup of using auto to mean unused.
joseph-robertson Oct 30, 2024
deb166e
Updates for foundations and rim joists.
joseph-robertson Oct 30, 2024
08957f2
Merge branch 'latest-os-hpxml' into lookup-unused-args
joseph-robertson Oct 30, 2024
00fd4b0
Auto no longer valid for hvac_perf_data_capacity_type.
joseph-robertson Oct 30, 2024
d72b0d1
Latest results.
Oct 31, 2024
542f36b
Merge branch 'develop' into lookup-unused-args
joseph-robertson Oct 31, 2024
25284df
Squashed 'resources/hpxml-measures/' changes from 1d56ca3cac1f..9fc03…
joseph-robertson Nov 4, 2024
97a3ef9
Merge commit '25284dfc31b4241231fd8d41fb4fa9acfbdf96e8' into lookup-u…
joseph-robertson Nov 4, 2024
cde85a6
Clean up resstockarguments after build measure argument changes.
joseph-robertson Nov 4, 2024
617673b
Remove more uses of auto to mean unused.
joseph-robertson Nov 4, 2024
73d4182
Merge commit 'e65273d5adde832bd4972e5936c4832ca24b475c' into lookup-u…
joseph-robertson Nov 4, 2024
e65273d
Squashed 'resources/hpxml-measures/' changes from 9fc0362034ce..2f31f…
joseph-robertson Nov 4, 2024
09fcb25
Remove more uses of auto to mean unused.
joseph-robertson Nov 4, 2024
663c753
Merge commit 'b973fa4eb166704ceb304d3ee40322c19f9ab2f8' into lookup-u…
joseph-robertson Nov 4, 2024
b973fa4
Squashed 'resources/hpxml-measures/' changes from 2f31f5b41ea4..6e3bb…
joseph-robertson Nov 4, 2024
55a4dfb
Remove more uses of auto to mean unused.
joseph-robertson Nov 4, 2024
ca2b15f
Squashed 'resources/hpxml-measures/' changes from 6e3bb515d4a3..2f490…
joseph-robertson Nov 4, 2024
f46178d
Merge commit 'ca2b15f89670f9a23cd7b5d55046068333e2c22e' into lookup-u…
joseph-robertson Nov 4, 2024
0bd7756
Merge branch 'latest-os-hpxml' into lookup-unused-args
joseph-robertson Nov 5, 2024
06fa4d7
Squashed 'resources/hpxml-measures/' changes from 2f7c47554c5d..103a8…
joseph-robertson Nov 5, 2024
f338311
Merge commit '06fa4d70843c5c92d4e1272690d4b7ebc6577c47' into lookup-u…
joseph-robertson Nov 5, 2024
963b701
Merge branch 'latest-os-hpxml' into lookup-unused-args
joseph-robertson Nov 5, 2024
1550b96
Respect argument type changes from meta measures.
joseph-robertson Nov 5, 2024
50aeca8
Update applyupgrade tests for argument type change.
joseph-robertson Nov 5, 2024
023efcc
Latest results.
Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3,413 changes: 1,680 additions & 1,733 deletions docs/read_the_docs/source/workflow_inputs/characteristics.rst
View file
Open in desktop

Large diffs are not rendered by default.

5 changes: 2 additions & 3 deletions docs/read_the_docs/source/workflow_inputs/create_characteristics_rst.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ def get_measure_xml(filepath)
f.puts("- **#{source_report_col}**")
end
f.puts
f.puts('Additionally, for each parameter an **Arguments** table is populated (if applicable) based on the contents of `ResStockArguments <https://github.com/NREL/resstock/blob/develop/measures/ResStockArguments>`_ and `BuildResidentialHPXML <https://github.com/NREL/resstock/blob/develop/resources/hpxml-measures/BuildResidentialHPXML>`_ measure.xml files.')
f.puts('Additionally, for each housing characteristics parameter an **Arguments** table is populated (if applicable) based on the contents of `ResStockArguments <https://github.com/NREL/resstock/blob/develop/measures/ResStockArguments>`_ and `BuildResidentialHPXML <https://github.com/NREL/resstock/blob/develop/resources/hpxml-measures/BuildResidentialHPXML>`_ measure.xml files.')
f.puts
arguments_cols.each do |arguments_col|
if ['Name', 'Required', 'Type'].include?(arguments_col)
Expand All @@ -125,8 +125,7 @@ def get_measure_xml(filepath)
f.puts('.. [#] May be "true" or "false".')
f.puts('.. [#] May be "String", "Double", "Integer", "Boolean", or "Choice".')
f.puts
f.puts('Furthermore, all *optional* Choice arguments include "auto" as one of the possible **Choices**.')
f.puts('Most *optional* String/Double/Integer/Boolean arguments can also be assigned a value of "auto" (e.g., ``site_ground_conductivity``).')
f.puts('Most *optional* arguments include "auto" as one of the possible **Choices**.')
f.puts('Assigning "auto" means that downstream default values (e.g., from OpenStudio-HPXML) will be used (if applicable).')
f.puts('When an argument is defaulted using OpenStudio-HPXML, the **Description** field will include link(s) to `OpenStudio-HPXML documentation <https://openstudio-hpxml.readthedocs.io/en/latest/?badge=latest>`_ describing these default values.')
f.puts
Expand Down
8 changes: 4 additions & 4 deletions measures/ApplyUpgrade/measure.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,13 +350,13 @@ def run(model, runner, user_arguments)
end

if whole_sfa_or_mf_building_sim && hpxml.buildings.size > 1
measures['BuildResidentialHPXML'][0]['battery_present'] = 'false' # limitation of OS-HPXML
measures['BuildResidentialHPXML'][0]['battery_present'] = false # limitation of OS-HPXML
end

unit_multiplier = hpxml_bldg.building_construction.number_of_units
measures['BuildResidentialHPXML'][0]['unit_multiplier'] = unit_multiplier
if unit_multiplier > 1
measures['BuildResidentialHPXML'][0]['dehumidifier_type'] = 'none' # limitation of OS-HPXML
measures['BuildResidentialHPXML'][0]['dehumidifier_type'] = Constants::None # limitation of OS-HPXML
end

# Set additional properties
Expand Down Expand Up @@ -399,7 +399,7 @@ def run(model, runner, user_arguments)
heat_pump_is_ducted = measures['BuildResidentialHPXML'][0]['heat_pump_is_ducted']

# Only set the backup if the heat pump is applied and there is an existing heating system
if (heat_pump_type != 'none') && (not heating_system.nil?)
if (heat_pump_type != Constants::None) && (not heating_system.nil?)
heat_pump_backup_type = get_heat_pump_backup_type(heating_system, heat_pump_type, heat_pump_is_ducted)
heat_pump_backup_values = get_heat_pump_backup_values(heating_system)

Expand Down Expand Up @@ -573,7 +573,7 @@ def get_heating_system(hpxml_bldg)

def get_heat_pump_backup_type(heating_system, heat_pump_type, heat_pump_is_ducted)
ducted_backup = [HPXML::HVACTypeFurnace].include?(heating_system.heating_system_type)
if (ducted_backup && (heat_pump_type == HPXML::HVACTypeHeatPumpMiniSplit) && (heat_pump_is_ducted == 'true')) ||
if (ducted_backup && (heat_pump_type == HPXML::HVACTypeHeatPumpMiniSplit) && heat_pump_is_ducted) ||
(ducted_backup && [HPXML::HVACTypeHeatPumpAirToAir, HPXML::HVACTypeHeatPumpGroundToAir].include?(heat_pump_type))
return HPXML::HeatPumpBackupTypeIntegrated
end
Expand Down
8 changes: 4 additions & 4 deletions measures/ApplyUpgrade/measure.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<schema_version>3.1</schema_version>
<name>apply_upgrade</name>
<uid>33f1654c-f734-43d1-b35d-9d2856e41b5a</uid>
<version_id>bdafc4c0-e705-4aec-bcd1-4e662b31f968</version_id>
<version_modified>2024-10-04T15:40:22Z</version_modified>
<version_id>f56decab-40cf-418a-a288-90eda02f3a1d</version_id>
<version_modified>2024-11-05T20:06:57Z</version_modified>
<xml_checksum>9339BE01</xml_checksum>
<class_name>ApplyUpgrade</class_name>
<display_name>Apply Upgrade</display_name>
Expand Down Expand Up @@ -6342,7 +6342,7 @@
<filename>measure.rb</filename>
<filetype>rb</filetype>
<usage_type>script</usage_type>
<checksum>F73DDD7C</checksum>
<checksum>9B993594</checksum>
</file>
<file>
<filename>constants.rb</filename>
Expand All @@ -6354,7 +6354,7 @@
<filename>apply_upgrade_test.rb</filename>
<filetype>rb</filetype>
<usage_type>test</usage_type>
<checksum>108FF5AA</checksum>
<checksum>CA81E878</checksum>
</file>
</files>
</measure>
16 changes: 8 additions & 8 deletions measures/ApplyUpgrade/tests/apply_upgrade_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@ def test_SFD_1story_FB_UA_GRG_MSHP_FuelTanklessWH
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, nil, expected_values)

expected_values['heat_pump_backup_type'] = nil
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, 'false', expected_values)
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, false, expected_values)

expected_values['heat_pump_backup_type'] = nil
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, 'true', expected_values)
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, true, expected_values)
end

def test_SFD_1story_UB_UA_GRG_ACV_FuelFurnace_PortableHeater_HPWH
Expand Down Expand Up @@ -118,10 +118,10 @@ def test_SFD_1story_UB_UA_GRG_ACV_FuelFurnace_PortableHeater_HPWH
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, nil, expected_values)

expected_values['heat_pump_backup_type'] = HPXML::HeatPumpBackupTypeSeparate
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, 'false', expected_values)
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, false, expected_values)

expected_values['heat_pump_backup_type'] = HPXML::HeatPumpBackupTypeIntegrated
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, 'true', expected_values)
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, true, expected_values)
end

def test_SFD_2story_CS_UA_AC2_FuelBoiler_FuelTankWH
Expand Down Expand Up @@ -180,10 +180,10 @@ def test_SFD_2story_CS_UA_AC2_FuelBoiler_FuelTankWH
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, nil, expected_values)

expected_values['heat_pump_backup_type'] = HPXML::HeatPumpBackupTypeSeparate
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, 'false', expected_values)
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, false, expected_values)

expected_values['heat_pump_backup_type'] = HPXML::HeatPumpBackupTypeSeparate
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, 'true', expected_values)
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, true, expected_values)
end

def test_SFD_2story_FB_UA_GRG_AC1_ElecBaseboard_FuelTankWH
Expand Down Expand Up @@ -242,10 +242,10 @@ def test_SFD_2story_FB_UA_GRG_AC1_ElecBaseboard_FuelTankWH
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, nil, expected_values)

expected_values['heat_pump_backup_type'] = HPXML::HeatPumpBackupTypeSeparate
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, 'false', expected_values)
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, false, expected_values)

expected_values['heat_pump_backup_type'] = HPXML::HeatPumpBackupTypeSeparate
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, 'true', expected_values)
_test_heat_pump_backup(HPXML::HVACTypeHeatPumpMiniSplit, true, expected_values)
end

private
Expand Down
4 changes: 2 additions & 2 deletions measures/BuildExistingModel/measure.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,14 +378,14 @@ def run(model, runner, user_arguments)
end

if whole_sfa_or_mf_building_sim && num_units_modeled > 1
measures['BuildResidentialHPXML'][0]['battery_present'] = 'false' # limitation of OS-HPXML
measures['BuildResidentialHPXML'][0]['battery_present'] = false # limitation of OS-HPXML
end

if !unit_multipliers.empty?
unit_multiplier = unit_multipliers[unit_number - 1]
measures['BuildResidentialHPXML'][0]['unit_multiplier'] = unit_multiplier
if unit_multiplier > 1
measures['BuildResidentialHPXML'][0]['dehumidifier_type'] = 'none' # limitation of OS-HPXML
measures['BuildResidentialHPXML'][0]['dehumidifier_type'] = Constants::None # limitation of OS-HPXML
end
end

Expand Down
6 changes: 3 additions & 3 deletions measures/BuildExistingModel/measure.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<schema_version>3.1</schema_version>
<name>build_existing_model</name>
<uid>dedf59bb-3b88-4f16-8755-2c1ff5519cbf</uid>
<version_id>a901b49d-d749-45b2-94fc-d5122935fd30</version_id>
<version_modified>2024-10-04T15:40:23Z</version_modified>
<version_id>bc439b4e-7a8e-4950-be59-1f9272d104a8</version_id>
<version_modified>2024-11-05T19:48:59Z</version_modified>
<xml_checksum>2C38F48B</xml_checksum>
<class_name>BuildExistingModel</class_name>
<display_name>Build Existing Model</display_name>
Expand Down Expand Up @@ -349,7 +349,7 @@
<filename>measure.rb</filename>
<filetype>rb</filetype>
<usage_type>script</usage_type>
<checksum>E660DFB7</checksum>
<checksum>C072817C</checksum>
</file>
</files>
</measure>
Loading