-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into hide_output_dirs
- Loading branch information
Showing
647 changed files
with
568,210 additions
and
81,533 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,3 +13,4 @@ | |
.vscode/ | ||
.DS_Store | ||
**/.ipynb_checkpoints/* | ||
**/data/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/read_the_docs/source/advanced_tutorial/installer_setup.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,3 +23,4 @@ ResStock Documentation | |
tutorial/index | ||
advanced_tutorial/index | ||
upgrade_scenario_config | ||
outputs/index |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
.. _default_outputs: | ||
|
||
Default Outputs | ||
=============== | ||
|
||
The default set of outputs include housing characteristics, annual simulation outputs, and upgrade cost information. | ||
|
||
Housing Characteristics | ||
*********************** | ||
|
||
Default characteristics include sampled properties for each dwelling unit. | ||
|
||
.. csv-table:: | ||
:file: ../../../../test/base_results/outputs/characteristics.csv | ||
|
||
Simulation Output | ||
***************** | ||
|
||
Default annual simulation outputs include energy consumptions (total, by fuel, and by end use), hot water uses, building loads, unmet hours, and peak building electricity/loads. | ||
|
||
See the OpenStudio-HPXML Workflow Outputs section on `Annual Outputs <https://openstudio-hpxml.readthedocs.io/en/latest/workflow_outputs.html#annual-outputs>`_ for more information about annual outputs. | ||
|
||
.. csv-table:: | ||
:file: ../../../../test/base_results/outputs/simulation_outputs.csv | ||
|
||
.. _upgrade-costs: | ||
|
||
Upgrade Costs | ||
************* | ||
|
||
Upgrade cost multipliers include: | ||
|
||
.. csv-table:: | ||
:file: ../../../../test/base_results/outputs/cost_multipliers.csv | ||
|
||
Other upgrade cost information includes: | ||
|
||
.. list-table:: | ||
|
||
* - upgrade_costs.option_<#>_name | ||
* - upgrade_costs.option_<#>_cost_usd | ||
* - upgrade_costs.option_<#>_lifetime_yrs | ||
* - upgrade_costs.upgrade_cost_usd | ||
|
||
where <#> represents any of the defined option numbers. | ||
See :doc:`../upgrade_scenario_config` for more information. | ||
|
||
Note that the name, cost, and lifetime information will only be populated when applicable for a given upgrade option (i.e., when the apply logic evaluates as true). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
.. _available_outputs: | ||
|
||
Available Outputs | ||
================= | ||
|
||
ResStock generates a default set of housing characteristics, simulation output, and upgrade cost outputs. | ||
ResStock optionally generates outputs related to timeseries data, component loads, emissions, utility bills, and quantities of interest. | ||
|
||
.. toctree:: | ||
|
||
default_outputs | ||
optional_outputs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
.. _optional_outputs: | ||
|
||
Optional Outputs | ||
================ | ||
|
||
Optional outputs include annual component loads, emissions, utility bills, and quantities of interest. | ||
Additionally, timeseries outputs can be requested. | ||
|
||
To be generated, some optional outputs need only a single switch enabled (e.g., component loads). | ||
Others need additional input arguments specified (e.g., emissions, utility bills). | ||
|
||
Note that enabling a set of optional outputs will by default generate the entire set. | ||
For example, requesting emissions outputs will result in columns for totals by fuel *and* by end use. | ||
There is currently no way to request totals by fuel while excluding totals by end use. | ||
|
||
Component Loads | ||
*************** | ||
|
||
Component loads represent the estimated contribution of different building components to the annual heating/cooling building loads. | ||
|
||
.. csv-table:: | ||
:file: ../../../../test/base_results/outputs/component_loads.csv | ||
|
||
These outputs require that only a single switch is enabled. | ||
See the `Residential HPXML Workflow Generator <https://buildstockbatch.readthedocs.io/en/latest/workflow_generators/residential_hpxml.html>`_ documentation page (i.e., ``build_existing_model`` section) for more information. | ||
|
||
See the OpenStudio-HPXML Workflow Outputs section on `Annual Component Building Loads <https://openstudio-hpxml.readthedocs.io/en/latest/workflow_outputs.html#annual-component-building-loads>`_ for more information about component loads. | ||
|
||
Emissions | ||
********* | ||
|
||
Optional emissions outputs include annual total, by fuel, and by end use, for each emissions scenario requested. | ||
See the `Residential HPXML Workflow Generator <https://buildstockbatch.readthedocs.io/en/latest/workflow_generators/residential_hpxml.html>`_ documentation page (i.e., ``emissions`` section) for more information on how to request emissions outputs by scenario. | ||
|
||
See the OpenStudio-HPXML Workflow Outputs section on `Annual Emissions <https://openstudio-hpxml.readthedocs.io/en/latest/workflow_outputs.html#annual-emissions>`_ for more information about annual emissions. | ||
|
||
For the example below, the "LRMER_MidCase_15" emissions scenario was requested. | ||
See the list of available emissions scenario choices at https://github.com/NREL/resstock/tree/develop/resources/data/cambium. | ||
|
||
.. csv-table:: | ||
:file: ../../../../test/base_results/outputs/emissions.csv | ||
|
||
Utility Bills | ||
************* | ||
|
||
Optional utility bill outputs include annual fixed and marginal costs (total, by fuel type), and PV credits for electricity, for each utility bill scenario requested. | ||
See the `Residential HPXML Workflow Generator <https://buildstockbatch.readthedocs.io/en/latest/workflow_generators/residential_hpxml.html>`_ documentation page (i.e., ``utility_bills`` section) for more information on how to request utility bill outputs by scenario. | ||
|
||
See the OpenStudio-HPXML Workflow Outputs section on `Utility Bill Outputs <https://openstudio-hpxml.readthedocs.io/en/latest/workflow_outputs.html#utility-bill-outputs>`_ for more information about utility bill outputs. | ||
|
||
.. csv-table:: | ||
:file: ../../../../test/base_results/outputs/utility_bills.csv | ||
|
||
Quantities of Interest | ||
********************** | ||
|
||
These outputs require that only a single switch is enabled. | ||
See the `Residential HPXML Workflow Generator <https://buildstockbatch.readthedocs.io/en/latest/workflow_generators/residential_hpxml.html>`_ documentation page (i.e., ``reporting_measures`` section) for more information on how to request quantities of interest outputs. | ||
|
||
.. csv-table:: | ||
:file: ../../../../test/base_results/outputs/qoi_report.csv | ||
|
||
Timeseries | ||
********** | ||
|
||
Specifying any timeseries frequency other than "none" results in, by default, end use consumptions and total loads timeseries output requests. | ||
See the `Residential HPXML Workflow Generator <https://buildstockbatch.readthedocs.io/en/latest/workflow_generators/residential_hpxml.html>`_ documentation page (i.e., ``simulation_output_report`` section) for more information on how to request various timeseries outputs (or override default requests). | ||
|
||
See the OpenStudio-HPXML Workflow Outputs section on `Timeseries Outputs <https://openstudio-hpxml.readthedocs.io/en/latest/workflow_outputs.html#timeseries-outputs>`_ for more information on timeseries outputs. |
Oops, something went wrong.