Merge pull request #410 from NREL/cost-mult-links

Update cost multiplier link in upgrade scenarios docs

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.

docs/project_defn.rst

@@ -19,12 +19,13 @@ 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
+- ``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
 ~~~~~~~~~~~~~
@@ -46,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 <https://github.com/NREL/resstock/blob/master/resources/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 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 your custom .epw weather file to match the references in your local `options_lookup.tsv <https://github.com/NREL/resstock/blob/master/resources/options_lookup.tsv>`_ in the ``resources`` folder.
+.. _options_lookup.tsv: https://github.com/NREL/resstock/blob/main/resources/options_lookup.tsv
 
 References
 ~~~~~~~~~~
@@ -110,7 +118,7 @@ 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 <https://github.com/NREL/resstock/blob/master/resources/options_lookup.tsv>`_
+      `options_lookup.tsv <https://github.com/NREL/resstock/blob/main/resources/options_lookup.tsv>`_
       in `ResStock`_.
    -  ``apply_logic``: Logic that defines which buildings to apply the upgrade to. See
       :ref:`filtering-logic` for instructions.
@@ -122,7 +130,8 @@ 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 <https://github.com/NREL/resstock/blob/master/measures/ApplyUpgrade/measure.rb#L71-L87>`_
+          `this enumeration list in the resstock repo <https://github.com/NREL/resstock/blob/main/measures/ApplyUpgrade/resources/constants.rb#L12-L38>`_ or
+          `this enumeration list in the comstock repo <https://github.com/NREL/ComStock/blob/main/measures/ApplyUpgrade/measure.rb#L76-L93>`_
           or from the list in your branch of that repo.
    - ``lifetime``: Lifetime in years of the upgrade.