Skip to content

Commit

Permalink
Update the wfg docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
joseph-robertson committed Oct 9, 2023
1 parent 4ce1f53 commit b2ad74a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/workflow_generators/residential_hpxml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit b2ad74a

Please sign in to comment.