From b2ad74a1e2bd088e1997dfdc7276077ecccaf64d Mon Sep 17 00:00:00 2001 From: Joe Robertson Date: Mon, 9 Oct 2023 11:34:31 -0700 Subject: [PATCH] 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.