diff --git a/docs/read_the_docs/source/advanced_tutorial/increasing_upgrade_options.rst b/docs/read_the_docs/source/advanced_tutorial/increasing_upgrade_options.rst index 50b13df5e9..c29790e720 100644 --- a/docs/read_the_docs/source/advanced_tutorial/increasing_upgrade_options.rst +++ b/docs/read_the_docs/source/advanced_tutorial/increasing_upgrade_options.rst @@ -9,4 +9,4 @@ To allow more options per upgrade, increase the value returned by the following return 25 end -Then run ``openstudio tasks.rb update_measures``. See :doc:`tasks` for instructions on how to run tasks. +Then run ``openstudio tasks.rb update_measures``. See :doc:`running_tasks` for instructions on how to run tasks. diff --git a/docs/read_the_docs/source/advanced_tutorial/index.rst b/docs/read_the_docs/source/advanced_tutorial/index.rst index 80bbaafd5c..d0fe5d06a9 100644 --- a/docs/read_the_docs/source/advanced_tutorial/index.rst +++ b/docs/read_the_docs/source/advanced_tutorial/index.rst @@ -13,7 +13,7 @@ If your changes are intended to be merged into the ``develop`` branch of the `Re :maxdepth: 2 installer_setup - tasks + running_tasks options_lookup increasing_upgrade_options upgrade_scenario_config diff --git a/docs/read_the_docs/source/advanced_tutorial/options_lookup.rst b/docs/read_the_docs/source/advanced_tutorial/options_lookup.rst index 5c4435b1cf..b6c396e03d 100644 --- a/docs/read_the_docs/source/advanced_tutorial/options_lookup.rst +++ b/docs/read_the_docs/source/advanced_tutorial/options_lookup.rst @@ -1,15 +1,22 @@ Options Lookup ============== -The ``options_lookup.tsv`` file, found in the ``resources`` folder, specifies mappings from sampled options into measure arguments. For example, if the distribution of cooling system types in ``HVAC System Cooling.tsv`` has ``Option=AC, SEER 13`` and ``Option=AC, SEER 15``, but you want to include a ``Option=AC, SEER 17`` option, you would add that option as a column in ``HVAC System Cooling.tsv`` and then create a corresponding row in ``options_lookup.tsv``. Updates to this file will allow you to avoid hitting the following types of integrity check errors: +The ``options_lookup.tsv`` file, found in the ``resources`` folder, specifies mappings from sampled options into measure arguments. +For example, if the distribution of cooling system types in ``HVAC Cooling Efficiency.tsv`` has ``Option=AC, SEER 13`` and ``Option=AC, SEER 15``, but you want to include a ``Option=AC, SEER 17`` option, you would add that option as a column and then create a corresponding row in ``options_lookup.tsv``. +Updates to this file will allow you to avoid hitting the following types of integrity check errors: - :ref:`Could not find parameter and option ` - :ref:`Required argument not provided ` +.. _integrity-check-errors: + +Integrity Check Errors +---------------------- + .. _could-not-find-parameter-and-option: Could not find parameter and option ------------------------------------ +*********************************** You do not have a row in ``options_lookup.tsv`` for a particular option that is sampled. @@ -25,7 +32,7 @@ An example of this error is given below: .. _required-argument-not-provided: Required argument not provided ------------------------------- +****************************** For the particular option that is sampled, your corresponding measure is missing an argument value assignment. diff --git a/docs/read_the_docs/source/advanced_tutorial/tasks.rst b/docs/read_the_docs/source/advanced_tutorial/running_tasks.rst similarity index 99% rename from docs/read_the_docs/source/advanced_tutorial/tasks.rst rename to docs/read_the_docs/source/advanced_tutorial/running_tasks.rst index c2ca44d0be..5e2c9d67b3 100644 --- a/docs/read_the_docs/source/advanced_tutorial/tasks.rst +++ b/docs/read_the_docs/source/advanced_tutorial/running_tasks.rst @@ -1,5 +1,5 @@ -Tasks -===== +Running Tasks +============= Run ``openstudio tasks.rb`` to see available task commands: diff --git a/measures/ApplyUpgrade/measure.rb b/measures/ApplyUpgrade/measure.rb index 8ba7779c2e..c1bc4b928b 100644 --- a/measures/ApplyUpgrade/measure.rb +++ b/measures/ApplyUpgrade/measure.rb @@ -325,7 +325,6 @@ def run(model, runner, user_arguments) new_runner.result.stepValues.each do |step_value| value = get_value_from_workflow_step_value(step_value) next if value == '' - next if step_value.name == 'heat_pump_backup_use_existing_system' measures['BuildResidentialHPXML'][0][step_value.name] = value end diff --git a/measures/ApplyUpgrade/measure.xml b/measures/ApplyUpgrade/measure.xml index 994a3fae3f..3322b797b0 100644 --- a/measures/ApplyUpgrade/measure.xml +++ b/measures/ApplyUpgrade/measure.xml @@ -3,8 +3,8 @@ 3.1 apply_upgrade 33f1654c-f734-43d1-b35d-9d2856e41b5a - 4ecb5790-01ae-4240-a5b8-21fb64c40dcf - 2023-08-21T22:19:47Z + 1e261f14-26dd-4944-9bbf-a667008cef74 + 2023-10-10T21:15:01Z 9339BE01 ApplyUpgrade Apply Upgrade @@ -6330,7 +6330,7 @@ measure.rb rb script - FD9488A5 + FDFA2666 constants.rb diff --git a/measures/LICENSE.md b/measures/LICENSE.md deleted file mode 100644 index 9fa887dc96..0000000000 --- a/measures/LICENSE.md +++ /dev/null @@ -1,11 +0,0 @@ -ResStock™, Copyright (c) 2016-2019, Alliance for Sustainable Energy, LLC. All rights reserved. - -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - -1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -3. The entire corresponding source code of any redistribution, with or without modification, by a research entity, including but not limited to any contracting manager/operator of a United States National Laboratory, any institution of higher learning, and any non-profit organization, must be made publicly available under this license for as long as the redistribution is made available by the research entity. -4. Redistribution of this software, without modification, must refer to the software by the same designation. Redistribution of a modified version of this software (i) may not refer to the modified version by the same designation, or by any confusingly similar designation, and (ii) must refer to the underlying software originally provided by Alliance as “ResStock”. Except to comply with the foregoing, the term “ResStock”, or any confusingly similar designation may not be used to refer to any modified version of this software or any modified version of the underlying software originally provided by Alliance without the prior written consent of Alliance. -5. The name of the copyright holder(s), any contributors, the United States Government, the United States Department of Energy, or any of their employees may not be used to endorse or promote products derived from this software without specific prior written permission from the respective party. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/measures/README.md b/measures/README.md deleted file mode 100644 index c062c915fa..0000000000 --- a/measures/README.md +++ /dev/null @@ -1 +0,0 @@ -# resstock-measures \ No newline at end of file diff --git a/measures/ResStockArguments/measure.rb b/measures/ResStockArguments/measure.rb index b1755ee75e..2eb9c3df52 100644 --- a/measures/ResStockArguments/measure.rb +++ b/measures/ResStockArguments/measure.rb @@ -731,11 +731,6 @@ def run(model, runner, user_arguments) end args[:rim_joist_assembly_r] = rim_joist_assembly_r - # Heat Pump Backup - if args[:heat_pump_backup_use_existing_system].is_initialized - args_to_delete.delete('heat_pump_backup_use_existing_system') - end - args.each do |arg_name, arg_value| begin if arg_value.is_initialized diff --git a/measures/ResStockArguments/measure.xml b/measures/ResStockArguments/measure.xml index e84ce7b421..04044e29db 100644 --- a/measures/ResStockArguments/measure.xml +++ b/measures/ResStockArguments/measure.xml @@ -3,8 +3,8 @@ 3.1 res_stock_arguments c984bb9e-4ac4-4930-a399-9d23f8f6936a - 083ff08c-ef99-446b-a661-d94d85f5e4d3 - 2023-08-09T19:50:37Z + 0f7806f4-076e-4db7-a108-a92a13539218 + 2023-10-10T21:15:02Z 2C38F48B ResStockArguments ResStock Arguments @@ -257,7 +257,7 @@ geometry_garage_protrusion Geometry: Garage Protrusion - The fraction of the garage that is protruding from the living space. Only applies to single-family detached units. + The fraction of the garage that is protruding from the conditioned space. Only applies to single-family detached units. Double Frac true @@ -4290,9 +4290,9 @@ false - hot_tub_present - Hot Tub: Present - Whether there is a hot tub. + permanent_spa_present + Permanent Spa: Present + Whether there is a permanent spa. Boolean true false @@ -4309,23 +4309,23 @@ - hot_tub_pump_annual_kwh - hot_tub_pump_annual_kwh + permanent_spa_pump_annual_kwh + permanent_spa_pump_annual_kwh String false false - hot_tub_pump_usage_multiplier - hot_tub_pump_usage_multiplier + permanent_spa_pump_usage_multiplier + permanent_spa_pump_usage_multiplier String false false - hot_tub_heater_type - Hot Tub: Heater Type - The type of hot tub heater. Use 'none' if there is no hot tub heater. + permanent_spa_heater_type + Permanent Spa: Heater Type + The type of permanent spa heater. Use 'none' if there is no permanent spa heater. Choice true false @@ -4350,22 +4350,22 @@ - hot_tub_heater_annual_kwh - hot_tub_heater_annual_kwh + permanent_spa_heater_annual_kwh + permanent_spa_heater_annual_kwh String false false - hot_tub_heater_annual_therm - hot_tub_heater_annual_therm + permanent_spa_heater_annual_therm + permanent_spa_heater_annual_therm String false false - hot_tub_heater_usage_multiplier - hot_tub_heater_usage_multiplier + permanent_spa_heater_usage_multiplier + permanent_spa_heater_usage_multiplier String false false @@ -5161,7 +5161,7 @@ measure.rb rb script - 17214A3F + EE32E37A constants.rb