From 471dc6a7595033607d8d8a98348ae9d2d05b34d6 Mon Sep 17 00:00:00 2001 From: Joe Robertson Date: Fri, 3 Nov 2023 13:44:34 -0700 Subject: [PATCH 1/6] Update resstock and comstock links to cost multiplier types. --- docs/project_defn.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/project_defn.rst b/docs/project_defn.rst index 35d46e71..37b5912c 100644 --- a/docs/project_defn.rst +++ b/docs/project_defn.rst @@ -122,8 +122,10 @@ following properties: Since there can be multiple costs, this permits both fixed and variable costs for upgrades that depend on the properties of the baseline building. The multiplier needs to be from - `this enumeration list inthe resstock or comstock repo `_ - or from the list in your branch of that repo. + this enumeration list in the + `resstock `_ or + `comstock `_ repo or + from the list in your branch of that repo. - ``lifetime``: Lifetime in years of the upgrade. - ``package_apply_logic``: (optional) The conditions under which this package of upgrades should be performed. From fabd74846690c089a147832bd131d62a70494a55 Mon Sep 17 00:00:00 2001 From: Joe Robertson Date: Tue, 14 Nov 2023 16:14:24 -0700 Subject: [PATCH 2/6] Fix duplicate refs in docs. --- docs/project_defn.rst | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/project_defn.rst b/docs/project_defn.rst index 37b5912c..f1fc45c7 100644 --- a/docs/project_defn.rst +++ b/docs/project_defn.rst @@ -19,13 +19,12 @@ Reference the project First we tell it what project we're running with the following keys: -- ``buildstock_directory``: The absolute (or relative to this YAML file) path of the `ResStock`_ or ComStock - repository. +- ``buildstock_directory``: The absolute (or relative to this YAML file) path of the + `ResStock `_ or + `ComStock `_ repository. - ``project_directory``: The relative (to the ``buildstock_directory``) path of the project. - ``schema_version``: The version of the project yaml file to use and validate - currently the minimum version is ``0.3``. -.. _ResStock: https://github.com/NREL/resstock - Weather Files ~~~~~~~~~~~~~ @@ -111,7 +110,7 @@ following properties: - ``option``: (required) The option to apply, in the format ``parameter|option`` which can be found in `options_lookup.tsv `_ - in `ResStock`_. + in `ResStock `_. - ``apply_logic``: Logic that defines which buildings to apply the upgrade to. See :ref:`filtering-logic` for instructions. - ``costs``: A list of costs for the upgrade. @@ -122,10 +121,9 @@ following properties: Since there can be multiple costs, this permits both fixed and variable costs for upgrades that depend on the properties of the baseline building. The multiplier needs to be from - this enumeration list in the - `resstock `_ or - `comstock `_ repo or - from the list in your branch of that repo. + `this enumeration list in the resstock repo `_ or + `this enumeration list in the comstock repo `_ + or from the list in your branch of that repo. - ``lifetime``: Lifetime in years of the upgrade. - ``package_apply_logic``: (optional) The conditions under which this package of upgrades should be performed. From 0895f60964d1cf9b020a4b92c1ae7ec0d9c55888 Mon Sep 17 00:00:00 2001 From: Noel Merket Date: Thu, 16 Nov 2023 16:02:43 -0700 Subject: [PATCH 3/6] update changelog [skip ci] --- docs/changelog/changelog_dev.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/changelog/changelog_dev.rst b/docs/changelog/changelog_dev.rst index acdfd030..77eb0303 100644 --- a/docs/changelog/changelog_dev.rst +++ b/docs/changelog/changelog_dev.rst @@ -21,3 +21,10 @@ Development Changelog :tickets: 404 Cleans out the ``/tmp/scratch`` folder on Eagle at the end of each array job. + + .. change:: + :tags: documentation + :pullreq: 410 + :tickets: 408 + + Update cost multiplier link in upgrade scenarios documentation. From 7bcb6ca77b0d7b285bb0cec530fa936145be0847 Mon Sep 17 00:00:00 2001 From: Noel Merket Date: Thu, 16 Nov 2023 16:10:51 -0700 Subject: [PATCH 4/6] cleaning up links --- docs/project_defn.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/project_defn.rst b/docs/project_defn.rst index f1fc45c7..beb8b2f1 100644 --- a/docs/project_defn.rst +++ b/docs/project_defn.rst @@ -19,12 +19,14 @@ Reference the project First we tell it what project we're running with the following keys: -- ``buildstock_directory``: The absolute (or relative to this YAML file) path of the - `ResStock `_ or - `ComStock `_ repository. +- ``buildstock_directory``: The absolute (or relative to this YAML file) path of the `ResStock`_ or `ComStock`_ + repository. - ``project_directory``: The relative (to the ``buildstock_directory``) path of the project. - ``schema_version``: The version of the project yaml file to use and validate - currently the minimum version is ``0.3``. +.. _ResStock: https://github.com/NREL/resstock +.. _ComStock: https://github.com/NREL/ComStock + Weather Files ~~~~~~~~~~~~~ @@ -109,8 +111,8 @@ following properties: - ``options``: A list of options to apply as part of this upgrade. - ``option``: (required) The option to apply, in the format ``parameter|option`` which can be found in - `options_lookup.tsv `_ - in `ResStock `_. + `options_lookup.tsv `_ + in `ResStock`_. - ``apply_logic``: Logic that defines which buildings to apply the upgrade to. See :ref:`filtering-logic` for instructions. - ``costs``: A list of costs for the upgrade. From 7eba8b60ca750d7238b9df2fcb791e5fb8df7ffc Mon Sep 17 00:00:00 2001 From: Noel Merket Date: Thu, 16 Nov 2023 16:17:41 -0700 Subject: [PATCH 5/6] consolidating to one PR template [skip ci] --- .github/PULL_REQUEST_TEMPLATE/release.md | 19 ------------------- .../pull_request_template.md | 0 2 files changed, 19 deletions(-) delete mode 100644 .github/PULL_REQUEST_TEMPLATE/release.md rename .github/{PULL_REQUEST_TEMPLATE => }/pull_request_template.md (100%) diff --git a/.github/PULL_REQUEST_TEMPLATE/release.md b/.github/PULL_REQUEST_TEMPLATE/release.md deleted file mode 100644 index 239c401e..00000000 --- a/.github/PULL_REQUEST_TEMPLATE/release.md +++ /dev/null @@ -1,19 +0,0 @@ -# Release Checklist - -* [ ] Make a `release_vYYYY.MM.X` branch for your release changes. -* [ ] Update `__version__.py` to reflect the new release version. -* [ ] Create changelog for the new version. - * [ ] Copy `docs/changelog/changelog_dev.rst` to `docs/changelog/changelog_YYYY_MM_X.rst`. - * [ ] Remove the example change, update version names, and release date in `changelog_YYYY_MM_X.rst` - * [ ] Clear out the dev changelog for the next version. - * [ ] Add a link to TOC in `docs/changelog/index.rst` -* [ ] Write a migration guide for the new version. Link from TOC. -* [ ] Build docs locally and ensure they render correctly. -* [ ] Verify integration tests are working on CI -* [ ] On Eagle - * [ ] Download the new default singularity image. - * [ ] Build a new environment - * [ ] Run a test batch -* [ ] Tag release, make release in GitHub -* [ ] Update RTD to include latest release -* [ ] Build environment for release on Eagle \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/pull_request_template.md similarity index 100% rename from .github/PULL_REQUEST_TEMPLATE/pull_request_template.md rename to .github/pull_request_template.md From 1195d11ed7872b48f140c70183c303b456f25004 Mon Sep 17 00:00:00 2001 From: Noel Merket Date: Thu, 16 Nov 2023 16:45:16 -0700 Subject: [PATCH 6/6] updating to remove warning from docs build --- docs/project_defn.rst | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/project_defn.rst b/docs/project_defn.rst index beb8b2f1..6532a733 100644 --- a/docs/project_defn.rst +++ b/docs/project_defn.rst @@ -47,9 +47,16 @@ Custom Weather Files To use your own custom weather files for a specific location, this can be done in **one** of two ways: -- Rename the filename references in your local `options_lookup.tsv `_ in the ``resources`` folder to match your custom weather file names. For example, in the options_lookup tsv, the Location ``AL_Birmingham.Muni.AP.722280`` is matched to the ``weather_file_name=USA_AL_Birmingham.Muni.AP.722280.epw``. To update the weather file for this location, the `weather_file_name` field needs to be updated to match your new name specified. - -- Rename your custom .epw weather file to match the references in your local `options_lookup.tsv `_ in the ``resources`` folder. +- Rename the filename references in your local `options_lookup.tsv`_ in the + ``resources`` folder to match your custom weather file names. For example, in + the options_lookup.tsv, the Location ``AL_Birmingham.Muni.AP.722280`` is + matched to the ``weather_file_name=USA_AL_Birmingham.Muni.AP.722280.epw``. To + update the weather file for this location, the `weather_file_name` field needs + to be updated to match your new name specified. +- Rename your custom .epw weather file to match the references in your local + `options_lookup.tsv`_ in the ``resources`` folder. + +.. _options_lookup.tsv: https://github.com/NREL/resstock/blob/main/resources/options_lookup.tsv References ~~~~~~~~~~