diff --git a/README.md b/README.md index 753258efdf..7fa27b7768 100644 --- a/README.md +++ b/README.md @@ -18,5 +18,5 @@ This repository contains: Software for running ResStock simulations: - - [Versions 2.3.0](https://github.com/NREL/resstock/releases/tag/v2.3.0) and later only support the use of [buildstockbatch](https://github.com/NREL/buildstockbatch) for deploying simulations on high-performance or cloud computing. Version 2.3.0 also removed separate projects for single-family detached and multifamily buildings, in lieu of a combined `project_national` representing the U.S. residential building stock. See the [changelog](https://github.com/NREL/resstock/blob/main/CHANGELOG.md) for more details. + - [Versions 2.3.0](https://github.com/NREL/resstock/releases/tag/v2.3.0) and later only support the use of [buildstockbatch](https://github.com/NREL/buildstockbatch) for deploying simulations on high-performance or cloud computing. Version 2.3.0 also removed separate projects for single-family detached and multifamily buildings, in lieu of a combined `project_national` representing the U.S. residential building stock. See the [changelogs](https://resstock.readthedocs.io/en/latest/changelog/index.html) for more details. - For large-scale production runs of ResStock, it is recommended that buildstockbatch is used. For smaller-scale tests, [`run_analysis.rb`](https://github.com/NREL/resstock/blob/develop/workflow/run_analysis.rb) can be used. Information about the workflow can be found in ResStock's [documentation](https://resstock.readthedocs.io/en/latest/basic_tutorial/run_project.html#using-run-analysis-rb).