Merge pull request #148 from NREL/weather-docs

Weather docs
NREL · May 18, 2020 · a636374 · a636374
2 parents beb9fc9 + 2fa42c3
commit a636374
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/docs/project_defn.rst b/docs/project_defn.rst
@@ -36,6 +36,21 @@ following keys:
 -  ``weather_files_path``: Where on this machine to find the zipped
    weather files. This can be absolute or relative (to this file)
 
+Weather files for Typical Meteorological Years (TMYs) can be obtained from the `NREL data catalog <https://data.nrel.gov/submissions/128>`_.
+
+Historical weather data for Actual Meteorological Years (AMYs) can be purchased in EPW format from various private companies. NREL users of buildstock batch can use NREL-owned AMY datasets by setting ``weather_files_url`` to a zip file located on `Box <https://app.box.com/s/atyl2q9v74kssjx5n14lbyhs1j6rt8ry>`_.
+
+
+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/OpenStudio-BuildStock/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 your custom .epw weather file to match the references in your local `options_lookup.tsv <https://github.com/NREL/OpenStudio-BuildStock/blob/master/resources/options_lookup.tsv>`_ in the ``resources`` folder.
+
+
 Baseline simulations
 ~~~~~~~~~~~~~~~~~~~~
 

diff --git a/project_resstock_national.yml b/project_resstock_national.yml
@@ -2,8 +2,8 @@ stock_type: residential
 buildstock_directory: ../OpenStudio-BuildStock  # Relative to this file or absolute
 project_directory: project_multifamily_beta  # Relative to buildstock_directory
 output_directory: ../national_test_outputs
-#weather_files_url: https://s3.amazonaws.com/epwweatherfiles/project_resstock_national.zip
-weather_files_path: ../project_resstock_national_weather.zip  # Relative to this file or absolute path to zipped weather files
+#weather_files_url: https://data.nrel.gov/files/128/ResStock_TMY3.zip
+weather_files_path: ../ResStock_TMY3.zip  # Relative to this file or absolute path to zipped weather files
 baseline:
   #buildstock_csv: ../OpenStudio-BuildStock/project_singlefamilydetached/housing_characteristics/buildstock.csv
   n_datapoints: 4  # Comment this line out if using a custom buildstock csv file