Update docs and migration guides

NREL · Nov 14, 2024 · faa66ab · faa66ab
1 parent c726bbf
commit faa66ab
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 10 deletions.
diff --git a/docs/changelog/index.rst b/docs/changelog/index.rst
@@ -11,6 +11,7 @@ Current Migration Guide
 .. toctree::
    :titlesonly:
 
+   migration_2024_11_0
    migration_2023_11_0
 
 Changelogs
@@ -19,7 +20,7 @@ Changelogs
 .. toctree::
    :titlesonly:
 
-...changelog_2024_11_0
+   changelog_2024_11_0
    changelog_2023_11_0
    changelog_2023_10_0
    changelog_2023_06_0

diff --git a/docs/changelog/migration_2024_11_0.rst b/docs/changelog/migration_2024_11_0.rst
@@ -9,15 +9,46 @@ What's new in buildstockbatch |version|
     This document describes changes between buildstockbatch version 2023.11.0 and
     buildstockbatch version |version|
 
-General
-=======
+Major Changes
+=============
+
+Below are the major changes in this release.
+
+Eagle is retired
+----------------
 
 This version should be backwards compatible with previous versions of
 buildstockbatch except for being able to run in Eagle. Since Eagle is retired, BuildStockBatch no
 longer supports buildstock_eagle command. If you are just comming upto speed with Kestrel, you can
 use your existing yaml file by replacing 'eagle' with 'kestrel' and using buildstock_kestrel
 command instead of buildstock_eagle command. See how to run in Kestrel :ref:`kestrel-run`.
 
-See :doc:`changelog_2024_11_0` for details of this change.
+BuildStockBatch uses Python 3.11
+--------------------------------
+
+BuildStockBatch now uses Python 3.11. If you are using a version of Python
+older than 3.11 in your local buildstockbatch environment, you will need to upgrade the python
+version or create a new environment with python 3.11 (or 3.12).
+
+Timeseries files include schedules
+----------------------------------
+
+In ResStock runs, the schedules are now appended to the timeseries files.
+
+WorkflowGenerator is versioned
+------------------------------
+
+`The workflow generator needs a version specification. <https://github.com/NREL/resstock/blob/v3.3.0/project_national/national_baseline.yml#L17>`_
+Older yaml files without version specification will default to version 2024.07.18 (the assigned version before versioning was introduced).
+If you are using a custom branch of ResStock, you should use the same version of the workflow generator as that in the ResStock branch
+it is based on.
+
+Google Cloud Platform (GCP) support
+-----------------------------------
+
+BuildStockBatch now supports GCP. See :ref:`gcp-config` and  :ref:`gcp-run`.
+
+
+See :doc:`changelog_2024_11_0` for full details of what changed.
 
 
diff --git a/docs/run_sims.rst b/docs/run_sims.rst
@@ -22,8 +22,8 @@ Running a project file is straightforward. Call the ``buildstock_local`` command
 
 .. _kestrel-run:
 
-NREL HPC (Kestrel)
-~~~~~~~~~~~~~~~~~~~
+Running on NREL HPC (Kestrel)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 After you have :ref:`activated the appropriate conda environment on Kestrel <kestrel_install>`,
 you can submit a project file to be simulated by passing it to the ``buildstock_kestrel`` command.
 
@@ -74,8 +74,10 @@ fail. If most of the jobs succeeded, rather than rerun everything you can
 resubmit just the jobs that failed with the ``--rerun_failed`` command line
 argument. This will also clear out and rerun the postprocessing.
 
-Amazon Web Services
-~~~~~~~~~~~~~~~~~~~
+.. _aws-run:
+
+Running on Amazon Web Services
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Running a batch on AWS is done by calling the ``buildstock_aws`` command line
 tool.
@@ -126,8 +128,10 @@ This will clean up all the AWS resources that were created on your behalf to run
 the simulations. Your results will still be on S3 and queryable in Athena.
 
 
-Google Cloud Platform
-~~~~~~~~~~~~~~~~~~~~~
+.. _gcp-run:
+
+Running on Google Cloud Platform
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Run a project on GCP by calling the ``buildstock_gcp`` command line tool.