From b56444cade5a24ade508ca9986e6ed315d6d2f60 Mon Sep 17 00:00:00 2001 From: Joe Robertson Date: Mon, 24 Jul 2023 22:01:55 -0700 Subject: [PATCH 1/7] Update hpxml wfg with new detailed_filepath yml field. --- buildstockbatch/workflow_generator/residential_hpxml.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/buildstockbatch/workflow_generator/residential_hpxml.py b/buildstockbatch/workflow_generator/residential_hpxml.py index 5ea52100..04e80013 100644 --- a/buildstockbatch/workflow_generator/residential_hpxml.py +++ b/buildstockbatch/workflow_generator/residential_hpxml.py @@ -79,6 +79,7 @@ def validate(cls, cfg): utility-bill-scenario-spec: scenario_name: str(required=True) simple_filepath: str(required=False) + detailed_filepath: str(required=False) elec_fixed_charge: num(required=False) elec_marginal_rate: num(required=False) gas_fixed_charge: num(required=False) @@ -299,6 +300,7 @@ def create_osw(self, sim_id, building_id, upgrade_idx): utility_bills_map = [ ['utility_bill_scenario_names', 'scenario_name'], ['utility_bill_simple_filepaths', 'simple_filepath'], + ['utility_bill_detailed_filepaths', 'detailed_filepath'], ['utility_bill_electricity_fixed_charges', 'elec_fixed_charge'], ['utility_bill_electricity_marginal_rates', 'elec_marginal_rate'], ['utility_bill_natural_gas_fixed_charges', 'gas_fixed_charge'], From e052515588e2a4de07c1085c5f6c062f0916bbcf Mon Sep 17 00:00:00 2001 From: Joe Robertson Date: Tue, 25 Jul 2023 13:37:00 -0700 Subject: [PATCH 2/7] Update the docs. [ci skip] --- docs/workflow_generators/residential_hpxml.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/workflow_generators/residential_hpxml.rst b/docs/workflow_generators/residential_hpxml.rst index 5b9ee956..3720d5bd 100644 --- a/docs/workflow_generators/residential_hpxml.rst +++ b/docs/workflow_generators/residential_hpxml.rst @@ -68,7 +68,8 @@ Arguments - ``utility_bills`` (optional): Add these arguments to the `BuildExistingModel`_ measure for performing utility bill calculations. - ``scenario_name``: Name of the utility bills scenario. - - ``simple_filepath``: File with all fixed charges / marginal rates for each option of a chosen parameter (e.g., State). + - ``simple_filepath``: File with all fixed charges / marginal rates for each option of a chosen parameter (e.g., State). These will override any fixed charges / marginal rates specified in the YML file. + - ``detailed_filepath``: File with electricity tariff path for each option of a chosen parameter (e.g., County). File may also contain all fixed charges / marginal rates. - ``elec_fixed_charge``: Monthly fixed charge for electricity. - ``elec_marginal_rate``: Marginal rate for electricity. Units are $/kWh. - ``gas_fixed_charge``: Monthly fixed charge for natural gas. From 29dac744493f5e533904465ab7c11890f8c8e1fb Mon Sep 17 00:00:00 2001 From: Joe Robertson Date: Wed, 26 Jul 2023 08:41:34 -0700 Subject: [PATCH 3/7] More updates to the docs. --- docs/workflow_generators/residential_hpxml.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/workflow_generators/residential_hpxml.rst b/docs/workflow_generators/residential_hpxml.rst index 3720d5bd..ef2631cb 100644 --- a/docs/workflow_generators/residential_hpxml.rst +++ b/docs/workflow_generators/residential_hpxml.rst @@ -59,7 +59,7 @@ Arguments - ``scenario_name``: Name of the emissions scenario. - ``type``: Type of emission (e.g., CO2e, NOx, etc.). - - ``elec_folder``: Folder of schedule files with hourly electricity emissions factors values. Units are kg/MWh. Path is relative to buildstock_directory's resources folder. File names must contain GEA region names. + - ``elec_folder``: Folder of schedule files with hourly electricity emissions factors values. Units are kg/MWh. Path is relative to buildstock_directory's `resources`_ folder. File names must contain GEA region names. - ``gas_value``: Annual emissions factor for natural gas. Units are lb/MBtu (million Btu). - ``propane_value``: Annual emissions factor for propane. Units are lb/MBtu (million Btu). - ``oil_value``: Annual emissions factor for fuel oil. Units are lb/MBtu (million Btu). @@ -68,8 +68,8 @@ Arguments - ``utility_bills`` (optional): Add these arguments to the `BuildExistingModel`_ measure for performing utility bill calculations. - ``scenario_name``: Name of the utility bills scenario. - - ``simple_filepath``: File with all fixed charges / marginal rates for each option of a chosen parameter (e.g., State). These will override any fixed charges / marginal rates specified in the YML file. - - ``detailed_filepath``: File with electricity tariff path for each option of a chosen parameter (e.g., County). File may also contain all fixed charges / marginal rates. + - ``simple_filepath``: File with all fixed charges / marginal rates for each option of a chosen parameter (e.g., State). These will override any fixed charges / marginal rates specified in the YML file. File path is relative to buildstock_directory's `resources`_ folder. + - ``detailed_filepath``: File with electricity tariff path for each option of a chosen parameter (e.g., County). File may also contain all fixed charges / marginal rates. File path is relative to buildstock_directory's `resources`_ folder. Electricity tariff paths are relative to the parent folder of ``detailed_filepath``. - ``elec_fixed_charge``: Monthly fixed charge for electricity. - ``elec_marginal_rate``: Marginal rate for electricity. Units are $/kWh. - ``gas_fixed_charge``: Monthly fixed charge for natural gas. @@ -137,6 +137,7 @@ Arguments .. _BuildExistingModel: https://github.com/NREL/resstock/blob/develop/measures/BuildExistingModel/measure.xml .. _ReportSimulationOutput: https://github.com/NREL/resstock/blob/develop/resources/hpxml-measures/ReportSimulationOutput/measure.xml .. _ServerDirectoryCleanup: https://github.com/NREL/resstock/blob/develop/measures/ServerDirectoryCleanup/measure.xml +.. _resources: https://github.com/NREL/resstock/blob/develop/resources .. _hpxml-build-existing-model-defaults: From 94a04eb8b3213f259355fe74d2f1cb7473cab789 Mon Sep 17 00:00:00 2001 From: Joe Robertson Date: Wed, 26 Jul 2023 08:49:04 -0700 Subject: [PATCH 4/7] Minor update. [ci skip] --- docs/workflow_generators/residential_hpxml.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/workflow_generators/residential_hpxml.rst b/docs/workflow_generators/residential_hpxml.rst index ef2631cb..0309a02e 100644 --- a/docs/workflow_generators/residential_hpxml.rst +++ b/docs/workflow_generators/residential_hpxml.rst @@ -59,7 +59,7 @@ Arguments - ``scenario_name``: Name of the emissions scenario. - ``type``: Type of emission (e.g., CO2e, NOx, etc.). - - ``elec_folder``: Folder of schedule files with hourly electricity emissions factors values. Units are kg/MWh. Path is relative to buildstock_directory's `resources`_ folder. File names must contain GEA region names. + - ``elec_folder``: Folder of schedule files with hourly electricity emissions factors values. Units are kg/MWh. Folder path is relative to buildstock_directory's `resources`_ folder. File names must contain GEA region names. - ``gas_value``: Annual emissions factor for natural gas. Units are lb/MBtu (million Btu). - ``propane_value``: Annual emissions factor for propane. Units are lb/MBtu (million Btu). - ``oil_value``: Annual emissions factor for fuel oil. Units are lb/MBtu (million Btu). From 1c537871559c8117db81ef824300a7048b15c466 Mon Sep 17 00:00:00 2001 From: Joe Robertson Date: Mon, 31 Jul 2023 12:28:43 -0700 Subject: [PATCH 5/7] More updates to docs. [ci skip] --- docs/workflow_generators/residential_hpxml.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/workflow_generators/residential_hpxml.rst b/docs/workflow_generators/residential_hpxml.rst index 0309a02e..15e9cfef 100644 --- a/docs/workflow_generators/residential_hpxml.rst +++ b/docs/workflow_generators/residential_hpxml.rst @@ -20,6 +20,7 @@ Configuration Example utility_bills: - scenario_name: Bills1 + gas_marginal_rate: 1.05 pv_compensation_type: NetMetering simulation_output_report: @@ -68,8 +69,8 @@ Arguments - ``utility_bills`` (optional): Add these arguments to the `BuildExistingModel`_ measure for performing utility bill calculations. - ``scenario_name``: Name of the utility bills scenario. - - ``simple_filepath``: File with all fixed charges / marginal rates for each option of a chosen parameter (e.g., State). These will override any fixed charges / marginal rates specified in the YML file. File path is relative to buildstock_directory's `resources`_ folder. - - ``detailed_filepath``: File with electricity tariff path for each option of a chosen parameter (e.g., County). File may also contain all fixed charges / marginal rates. File path is relative to buildstock_directory's `resources`_ folder. Electricity tariff paths are relative to the parent folder of ``detailed_filepath``. + - ``simple_filepath``: File with all fixed charge / marginal rate / PV argument values for each option of a chosen parameter (e.g., State). These will override any fixed charge / marginal rate / PV argument values specified in the YML file. Any blank fields will be defaulted. File path is relative to buildstock_directory's `resources`_ folder. + - ``detailed_filepath``: File with electricity tariff path for each option of a chosen parameter (e.g., County). File may also contain all fixed charge / marginal rate / PV argument values. These will override any fixed charge / marginal rate / PV argument values specified in the YML file. Any blank fields will be defaulted. File path is relative to buildstock_directory's `resources`_ folder. Electricity tariff paths are relative to the parent folder of the ``detailed_filepath`` file. - ``elec_fixed_charge``: Monthly fixed charge for electricity. - ``elec_marginal_rate``: Marginal rate for electricity. Units are $/kWh. - ``gas_fixed_charge``: Monthly fixed charge for natural gas. From 4ce1f53fc6641bf7290bb1a56586dc03dfbffade Mon Sep 17 00:00:00 2001 From: Joe Robertson Date: Mon, 9 Oct 2023 11:34:16 -0700 Subject: [PATCH 6/7] Update the changelog. --- docs/changelog/changelog_dev.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/changelog/changelog_dev.rst b/docs/changelog/changelog_dev.rst index cc58811b..13267607 100644 --- a/docs/changelog/changelog_dev.rst +++ b/docs/changelog/changelog_dev.rst @@ -29,3 +29,11 @@ Development Changelog No longer automatically downloads the appropriate singularity image from S3. Also added validation to ensure the image is in the correct location. + + .. change:: + :tags: general, feature + :pullreq: 382 + + For the Residential HPXML Workflow Generator, add a new ``detailed_filepath`` argument + for pointing to user-specified TSV file of electricity tariff file paths. The TSV file can contain + utility rates mapped by State, or any other parameter. From b2ad74a1e2bd088e1997dfdc7276077ecccaf64d Mon Sep 17 00:00:00 2001 From: Joe Robertson Date: Mon, 9 Oct 2023 11:34:31 -0700 Subject: [PATCH 7/7] Update the wfg docs. --- docs/workflow_generators/residential_hpxml.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/workflow_generators/residential_hpxml.rst b/docs/workflow_generators/residential_hpxml.rst index 15e9cfef..526b3440 100644 --- a/docs/workflow_generators/residential_hpxml.rst +++ b/docs/workflow_generators/residential_hpxml.rst @@ -69,8 +69,8 @@ Arguments - ``utility_bills`` (optional): Add these arguments to the `BuildExistingModel`_ measure for performing utility bill calculations. - ``scenario_name``: Name of the utility bills scenario. - - ``simple_filepath``: File with all fixed charge / marginal rate / PV argument values for each option of a chosen parameter (e.g., State). These will override any fixed charge / marginal rate / PV argument values specified in the YML file. Any blank fields will be defaulted. File path is relative to buildstock_directory's `resources`_ folder. - - ``detailed_filepath``: File with electricity tariff path for each option of a chosen parameter (e.g., County). File may also contain all fixed charge / marginal rate / PV argument values. These will override any fixed charge / marginal rate / PV argument values specified in the YML file. Any blank fields will be defaulted. File path is relative to buildstock_directory's `resources`_ folder. Electricity tariff paths are relative to the parent folder of the ``detailed_filepath`` file. + - ``simple_filepath``: TSV file with all fixed charge / marginal rate / PV argument values for each option of a chosen parameter (e.g., State). These will override any fixed charge / marginal rate / PV argument values specified in the YML file. Any blank fields will be defaulted. File path is relative to buildstock_directory's `resources`_ folder. + - ``detailed_filepath``: TSV file with electricity tariff path for each option of a chosen parameter (e.g., County). File may also contain all fixed charge / marginal rate / PV argument values. These will override any fixed charge / marginal rate / PV argument values specified in the YML file. Any blank fields will be defaulted. File path is relative to buildstock_directory's `resources`_ folder. Electricity tariff paths are relative to the parent folder of the ``detailed_filepath`` file. - ``elec_fixed_charge``: Monthly fixed charge for electricity. - ``elec_marginal_rate``: Marginal rate for electricity. Units are $/kWh. - ``gas_fixed_charge``: Monthly fixed charge for natural gas.