Skip to content

Commit

Permalink
Minor docs updates
Browse files Browse the repository at this point in the history
The custom load shape guide was updated to reflect the new ResStock building type breakouts, and to clarify the interpretation of hourly load units. Links were updated.
  • Loading branch information
jtlangevin committed Mar 22, 2023
1 parent 96c6564 commit c1956d1
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 10 deletions.
12 changes: 7 additions & 5 deletions docs/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -581,7 +581,9 @@ In this example, the supporting CSV file path is |html-filepath| ./ecm_definitio

* *Building Type*. Applicable EnergyPlus building type; currently supported representative building types are:

* SingleFamilyHome (`ResStock`_)
* SF (`ResStock`_ single family prototype)
* MF (`ResStock`_ multi family prototype)
* MH (`ResStock`_ mobile home prototype)
* MediumOfficeDetailed or MediumOffice (`DOE Commercial Prototypes`_)
* LargeOfficeDetailed or LargeOffice (`DOE Commercial Prototypes`_)
* LargeHotel (`DOE Commercial Prototypes`_)
Expand All @@ -601,13 +603,13 @@ In this example, the supporting CSV file path is |html-filepath| ./ecm_definitio
* plug loads
* dishwasher
* clothes washing
* clothes drying
* drying
* pool heaters and pumps
* fans and pumps
* other

* *Baseline Load*. Load (in kW) for given hour of year, climate zone, net load version, building type, and end use under the baseline case.
* *Measure Load*. Load (in kW) for given hour of year, climate zone, net load version, building type, and end use after measure application.
* *Baseline Load*. Load (for residential, average hourly kW per home across all homes sampled in the representative city for the climate zone; for commercial, hourly kW per prototypical building) for given hour of year, climate zone, net load version, building type, and end use under the baseline case.
* *Measure Load*. Load (for residential, average hourly kW per home across all homes sampled in the representative city for the climate zone; for commercial, hourly kW per prototypical building) for given hour of year, climate zone, net load version, building type, and end use after measure application.
* *Relative Savings*. Calculated as: (Hourly Measure Load - Hourly Baseline Load) / (Total Annual Baseline Load).


Expand Down Expand Up @@ -648,7 +650,7 @@ A commercial load shedding and shifting ECM is :ref:`available for download <ecm
.. _ASHRAE 90.1-2016 climate zone: https://www.ashrae.org/File%20Library/Conferences/Specialty%20Conferences/2018%20Building%20Performance%20Analysis%20Conference%20and%20SimBuild/Papers/C008.pdf
.. _EIA Electricity Market Module (EMM): https://www.eia.gov/outlooks/aeo/nems/documentation/archive/pdf/m068(2018).pdf
.. _ResStock: https://resstock.readthedocs.io/en/latest/
.. _DOE Commercial Prototypes: https://www.energycodes.gov/development/commercial/prototype_models
.. _DOE Commercial Prototypes: https://www.energycodes.gov/prototype-building-models#Commercial
.. _profiles: https://drive.google.com/file/d/1gUQqqgV7F3_1wIoU0d_qRdsE3ExfFwpn/view?usp=sharing

.. _ecm-features-shorthand:
Expand Down
11 changes: 6 additions & 5 deletions docs/tutorials_web.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,15 @@ At the bottom of the landing page, a section titled "Do more with Scout" points

The latest version of the Scout source code is accessed by clicking the "`Source Code`_" button at the top right of the Landing Page and all other pages in the web interface.

.. _tuts-2-web:

.. tip::
We recommend registering an e-mail address and creating an account so that you can save your ECMs and custom analyses. To create an account, click the "Register" button on the landing page and complete the require fields.

.. note::
To change your username of password, after you are signed in, hover over your username and click "Profile". On this page you will be able to change your username and/or password.

.. _tuts-2-web:

Tutorial 2: Creating and editing ECMs
-------------------------------------

Expand Down Expand Up @@ -257,26 +258,26 @@ An "Edit ECM" form will pop up with fully populated input fields (see :ref:`crea
.. 2. Open a Terminal window (Mac) or command prompt (Windows), navigate to the Scout project directory, and enter the following command line argument:
.. **Windows** ::
**Windows** ::
.. py -3 ecm_prep.py
.. **Mac** ::
**Mac** ::
.. python3 ecm_prep.py
.. 3. On the `ECM Summaries Page`_ of the web interface, click the drop down arrow next to the "Custom ECMs" label towards the top right of the page; then click "Upload File" at the bottom of the resulting drop down window.
.. 4. When prompted to select a file to upload, navigate to the |html-filepath| ./supporting_data |html-fp-end| folder in your Scout project directory and upload the file named |html-filepath| ecm_prep.json |html-fp-end| - this file includes all the definitions for your custom set of ECMs, which were bundled in step 2. Once uploaded, the file will appear under the "Active File" label.
.. note::
note::
.. Larger files may take several seconds to upload in step 4.
.. Your custom set of ECMs will appear just as the default ECM set does on the ECM Summaries Page, and you may browse, filter, and edit the ECMs as described in :ref:`browse-default-ecms`. Switch between the default ECM set and your custom set using the toggle button towards the top right of the page.
.. _tuts-3-web:

..Results shown on the `Analysis Results Page`_ correspond to the ECM set from the `ECM Summaries Page`_.
.. Results shown on the `Analysis Results Page`_ correspond to the ECM set from the `ECM Summaries Page`_.
.. Visualizing a default set of ECM results
.. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit c1956d1

Please sign in to comment.