Merge pull request #516 from NREL/resstock-rename-2

Rename changes, try 2
NREL · Dec 7, 2020 · 15447ca · 15447ca
2 parents e5f1042 + 397402a
commit 15447ca
Show file tree

Hide file tree

Showing 79 changed files with 231 additions and 235 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -15,7 +15,7 @@ Not all may apply:
 - [ ] `project_testing` runs without any failures
 - [ ] No unexpected regression test changes
 - [ ] All tests are passing (green) on circleci
-- [ ] The [changelog](https://github.com/NREL/OpenStudio-BuildStock/blob/master/CHANGELOG.md) has been updated appropriately
+- [ ] The [changelog](https://github.com/NREL/resstock/blob/master/CHANGELOG.md) has been updated appropriately
 - [ ] This branch is up-to-date with master
 
 For more information on how to perform these checklist items, see the documentation's [Advanced Tutorial](https://resstock.readthedocs.io/en/latest/advanced_tutorial/index.html).
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -1,30 +1,26 @@
-The `main` branch is under active development. Find the latest release [here](https://github.com/NREL/OpenStudio-BuildStock/releases).
+<img src="https://user-images.githubusercontent.com/1276021/85608250-1ff46b80-b612-11ea-903e-4ced367e5940.jpg" width="280">
 
-OpenStudio-BuildStock
-===================
+The `develop` branch is under active development. Find the latest release [here](https://github.com/NREL/resstock/releases).
 
-[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/NREL/OpenStudio-BuildStock?include_prereleases)](https://github.com/NREL/OpenStudio-BuildStock/releases)
-[![CircleCI](https://circleci.com/gh/NREL/OpenStudio-BuildStock.svg?style=shield)](https://circleci.com/gh/NREL/OpenStudio-BuildStock)
+[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/NREL/resstock?include_prereleases)](https://github.com/NREL/resstock/releases)
+[![CircleCI](https://circleci.com/gh/NREL/resstock.svg?style=shield)](https://circleci.com/gh/NREL/resstock)
 [![Documentation Status](https://readthedocs.org/projects/resstock/badge/?version=latest)](https://resstock.readthedocs.io/en/latest/?badge=latest)
 
-<img src="https://user-images.githubusercontent.com/1276021/85608250-1ff46b80-b612-11ea-903e-4ced367e5940.jpg" width="400">
-
 [ResStock™](https://www.nrel.gov/buildings/resstock.html), built on the [OpenStudio platform](http://openstudio.net), is a project geared at modeling existing residential building stocks at national, regional, or local scales with a high-degree of granularity (e.g., one physics-based simulation model for every 200 dwelling units), using the [EnergyPlus simulation engine](http://energyplus.net). Information about ComStock™, a sister tool for modeling the commercial building stock, can be found [here](https://www.nrel.gov/buildings/comstock.html). 
 
 This repository contains:
 
-- [Housing characteristics of the U.S. residential building stock](https://github.com/NREL/OpenStudio-BuildStock/tree/master/project_national/housing_characteristics), in the form of conditional probability distributions stored as tab-separated value (.tsv) files. A visualization of the dependency structure can be found [here](https://htmlpreview.github.io/?https://github.com/NREL/OpenStudio-BuildStock/blob/master/project_national/util/dependency_wheel/dep_wheel.html).
-- [A library of housing characteristic "options"](https://github.com/NREL/OpenStudio-BuildStock/blob/master/resources/options_lookup.tsv) that translate high-level characteristic parameters into arguments for [OpenStudio Measures](https://github.com/NREL/OpenStudio-BuildStock/tree/master/resources/measures), and which are referenced by the housing characteristic .tsv files and building energy upgrades defined in project definition files
+- [Housing characteristics of the U.S. residential building stock](https://github.com/NREL/resstock/tree/master/project_national/housing_characteristics), in the form of conditional probability distributions stored as tab-separated value (.tsv) files. A visualization of the dependency structure can be found [here](https://htmlpreview.github.io/?https://github.com/NREL/resstock/blob/master/project_national/util/dependency_wheel/dep_wheel.html).
+- [A library of housing characteristic "options"](https://github.com/NREL/resstock/blob/master/resources/options_lookup.tsv) that translate high-level characteristic parameters into arguments for [OpenStudio Measures](https://github.com/NREL/resstock/tree/master/resources/measures), and which are referenced by the housing characteristic .tsv files and building energy upgrades defined in project definition files
 - Project definition files:
-  - v2.3.0 and later: [buildstockbatch YML files openable in any text editor](https://github.com/NREL/OpenStudio-BuildStock/blob/master/project_national/national.yml)
-  - v2.2.5 and prior: [Project folder openable in PAT](https://github.com/NREL/OpenStudio-BuildStock/tree/v2.2.5/project_singlefamilydetached)
-- [Building-level OpenStudio Measures](https://github.com/NREL/OpenStudio-BuildStock/tree/master/resources/measures) for automatically constructing OpenStudio Models of each representative building model
-- [Higher-level OpenStudio Measures](https://github.com/NREL/OpenStudio-BuildStock/tree/master/measures) for controlling simulation inputs and outputs
+  - v2.3.0 and later: [buildstockbatch YML files openable in any text editor](https://github.com/NREL/resstock/blob/master/project_national/national.yml)
+  - v2.2.5 and prior: [Project folder openable in PAT](https://github.com/NREL/resstock/tree/v2.2.5/project_singlefamilydetached)
+- [Building-level OpenStudio Measures](https://github.com/NREL/resstock/tree/master/resources/measures) for automatically constructing OpenStudio Models of each representative building model
+- [Higher-level OpenStudio Measures](https://github.com/NREL/resstock/tree/master/measures) for controlling simulation inputs and outputs
 
 This repository does not contain software for running ResStock simulations, which can be found as follows:
 
- - [Versions 2.2.5](https://github.com/NREL/OpenStudio-BuildStock/releases/tag/v2.2.5) and prior support the use of the publicly available [OpenStudio-PAT](https://github.com/NREL/OpenStudio-PAT) software as an interface for deploying simulations on cloud computing. Read the [documentation for v2.2.5](https://resstock.readthedocs.io/en/v2.2.5/).
- - [Versions 2.3.0](https://github.com/NREL/OpenStudio-BuildStock/releases/tag/untagged-af060c990f21d5ca539f) and later only support the use of [buildstockbatch](https://github.com/NREL/buildstockbatch), which is not yet publicly available, for deploying simulations on high-performance or cloud computing. Version 2.3.0 also removes 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/OpenStudio-BuildStock/blob/master/CHANGELOG.md) for more details. 
+ - [Versions 2.3.0](https://github.com/NREL/resstock/releases/tag/untagged-af060c990f21d5ca539f) 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/master/CHANGELOG.md) for more details. 
+ - [Versions 2.2.5](https://github.com/NREL/resstock/releases/tag/v2.2.5) and prior support the use of the publicly available [OpenStudio-PAT](https://github.com/NREL/OpenStudio-PAT) software as an interface for deploying simulations on cloud computing. Read the [documentation for v2.2.5](https://resstock.readthedocs.io/en/v2.2.5/).
 
 Note that calibration/validation of the multifamily sector, as well as timeseries output, is still ongoing, under the [End-Use Load Profile for the U.S. Building Stock project](https://www.nrel.gov/buildings/end-use-load-profiles.html).
-
diff --git a/__version__.py b/__version__.py
@@ -1,6 +1,6 @@
 __title__ = 'ResStock'
 __description__ = 'Modeling the existing building stock (residential and commercial) using OpenStudio/EnergyPlus.'
-__url__ = 'http://github.com/NREL/OpenStudio-BuildStock'
+__url__ = 'http://github.com/NREL/resstock'
 __version__ = '2.3.0'
 __author__ = 'National Renewable Energy Laboratory'
 __license__ = 'BSD-3'

diff --git a/docs/read_the_docs/source/advanced_tutorial/index.rst b/docs/read_the_docs/source/advanced_tutorial/index.rst
@@ -5,9 +5,9 @@ Advanced Tutorial
 
 This advanced tutorial describes the process for developing residential measures and testing residential building models. Reasons for wanting to develop residential measures include: customizing any of the existing residential modeling algorithms or adding new technology models.
 
-At this point in the tutorial, it is assumed that you have checked out a new branch that is up-to-date with the **master branch** of the `OpenStudio-BuildStock <https://github.com/NREL/OpenStudio-BuildStock>`_ repository. Optionally, you may have created a new project folder (i.e., copied an existing project folder) and modified the set of tsv files in its ``housing_characteristics`` folder.
+At this point in the tutorial, it is assumed that you have checked out a new branch that is up-to-date with the **master branch** of the `resstock <https://github.com/NREL/resstock>`_ repository. Optionally, you may have created a new project folder (i.e., copied an existing project folder) and modified the set of tsv files in its ``housing_characteristics`` folder.
 
-If your changes are intended to be merged into the master branch of the `OpenStudio-BuildStock <https://github.com/NREL/OpenStudio-BuildStock>`_ repository, a pull request review is required.
+If your changes are intended to be merged into the master branch of the `resstock <https://github.com/NREL/resstock>`_ repository, a pull request review is required.
 
 .. toctree::
 

diff --git a/docs/read_the_docs/source/advanced_tutorial/installer_setup.rst b/docs/read_the_docs/source/advanced_tutorial/installer_setup.rst
@@ -1,7 +1,7 @@
 Installer Setup
 ###############
 
-After you have downloaded the OpenStudio installer, you will want to install Ruby (2.2.4). This will allow you to execute rake tasks contained in the `Rakefile <https://github.com/NREL/OpenStudio-BuildStock/blob/master/Rakefile>`_. Follow the instructions below for :ref:`windows-setup` or :ref:`mac-setup`.
+After you have downloaded the OpenStudio installer, you will want to install Ruby (2.2.4). This will allow you to execute rake tasks contained in the `Rakefile <https://github.com/NREL/resstock/blob/master/Rakefile>`_. Follow the instructions below for :ref:`windows-setup` or :ref:`mac-setup`.
 
 .. _windows-setup:
 
@@ -18,7 +18,7 @@ Windows Setup
 .. literalinclude:: .gemrc
 
 3. Download the DevKit at http://rubyinstaller.org/downloads/ (e.g., DevKit-mingw64-64-4.7.2-20130224-1432-sfx.exe). Choose either the 32-bit or 64-bit version depending on which version of Ruby you installed. Run the installer and extract to a directory (e.g., C:\\RubyDevKit). Go to this directory, run ``ruby dk.rb init``, modify the config.yml file as needed, and finally run ``ruby dk.rb install``.
-4. Run ``bundle install`` from the OpenStudio-BuildStock directory. (If you get an error, check that ``git`` is in your ``PATH`` and that you are using the correct version of Ruby (2.2.4).)
+4. Run ``bundle install`` from the resstock directory. (If you get an error, check that ``git`` is in your ``PATH`` and that you are using the correct version of Ruby (2.2.4).)
 
 .. _mac-setup:
 

diff --git a/docs/read_the_docs/source/advanced_tutorial/rake_tasks.rst b/docs/read_the_docs/source/advanced_tutorial/rake_tasks.rst
@@ -1,7 +1,7 @@
 Rake Tasks
 ##########
 
-Once you have completed instructions found in :doc:`installer_setup`, you can then :ref:`use the Rakefile <using-the-rakefile>` contained at the top level of this repository (`Rakefile <https://github.com/NREL/OpenStudio-BuildStock/blob/master/Rakefile>`_). You will run rake task(s) for :ref:`performing integrity checks on project inputs <integrity-checks>`.
+Once you have completed instructions found in :doc:`installer_setup`, you can then :ref:`use the Rakefile <using-the-rakefile>` contained at the top level of this repository (`Rakefile <https://github.com/NREL/resstock/blob/master/Rakefile>`_). You will run rake task(s) for :ref:`performing integrity checks on project inputs <integrity-checks>`.
 
 .. _using-the-rakefile:
 
@@ -28,7 +28,7 @@ Run ``rake -T`` to see the list of possible rake tasks. The ``-T`` is replaced w
 Integrity Checks
 ================
 
-Run ``rake integrity_check_<project_name>``, where ``<project_name>`` matches the project you are working with. If no rake task exists for the project you are working with, extend the list of integrity check rake tasks to accommodate your project by copy-pasting and renaming the ``integrity_check_national`` rake task found in the `Rakefile <https://github.com/NREL/OpenStudio-BuildStock/blob/master/Rakefile>`_. An example for running a project's integrity checks is given below:
+Run ``rake integrity_check_<project_name>``, where ``<project_name>`` matches the project you are working with. If no rake task exists for the project you are working with, extend the list of integrity check rake tasks to accommodate your project by copy-pasting and renaming the ``integrity_check_national`` rake task found in the `Rakefile <https://github.com/NREL/resstock/blob/master/Rakefile>`_. An example for running a project's integrity checks is given below:
 
 .. code:: ruby
 

diff --git a/docs/read_the_docs/source/tutorial/installation.rst b/docs/read_the_docs/source/tutorial/installation.rst
@@ -4,7 +4,7 @@ Installation
 Download the ResStock repository
 ================================
 
-Go to the `releases page on GitHub <https://github.com/NREL/OpenStudio-BuildStock/releases>`_, select a release, and either ``git clone`` or download a zip of the repository. The ``master`` branch is under active development, so we recommend using the latest `release <https://github.com/NREL/OpenStudio-BuildStock/releases>`_ for production runs.
+Go to the `releases page on GitHub <https://github.com/NREL/resstock/releases>`_, select a release, and either ``git clone`` or download a zip of the repository. The ``master`` branch is under active development, so we recommend using the latest `release <https://github.com/NREL/resstock/releases>`_ for production runs.
 
 Developer instructions
 ======================

diff --git a/docs/read_the_docs/source/tutorial/setup_analysis_project.rst b/docs/read_the_docs/source/tutorial/setup_analysis_project.rst
@@ -38,7 +38,7 @@ This measure creates the baseline scenario. It incrementally applies OpenStudio
 **Measures to Ignore**
   **INTENDED FOR ADVANCED USERS/WORKFLOW DEVELOPERS ONLY.** Measures to exclude from the OpenStudio Workflow specified by listing one or more measure directories separated by '|'. Core ResStock measures cannot be ignored (the Build Existing Model measure will fail).
 
-.. _custom region map: https://github.com/NREL/OpenStudio-BuildStock/wiki/Custom-Region-(CR)-Map
+.. _custom region map: https://github.com/NREL/resstock/wiki/Custom-Region-(CR)-Map
 
 .. note::
 

diff --git a/docs/read_the_docs/source/upgrade_scenario_config.rst b/docs/read_the_docs/source/upgrade_scenario_config.rst
@@ -11,7 +11,7 @@ This is a human readable name for the upgrade scenario. Something like, "Replace
 Option <#>
 ==========
 
-In this field we enter the parameter and option combination to be applied. In the upgrade scenario simulations, this option will replace the option for the corresponding parameter in the baseline run. These can be found and referenced in the ``resources/options_lookup.tsv`` file in your local git repository. (You can see the most updated version `on github here <https://github.com/NREL/OpenStudio-BuildStock/blob/master/resources/options_lookup.tsv>`_, but it's recommended to use your local version as it will be synchronized with your project.) The file can be opened in a spreadsheet editor like Excel for viewing. 
+In this field we enter the parameter and option combination to be applied. In the upgrade scenario simulations, this option will replace the option for the corresponding parameter in the baseline run. These can be found and referenced in the ``resources/options_lookup.tsv`` file in your local git repository. (You can see the most updated version `on github here <https://github.com/NREL/resstock/blob/master/resources/options_lookup.tsv>`_, but it's recommended to use your local version as it will be synchronized with your project.) The file can be opened in a spreadsheet editor like Excel for viewing. 
 
 The text to enter in the field will be the Parameter Name followed by the Option Name separated by a pipe character.
 

diff --git a/docs/visualizations/regenerate_visualizations.ipynb b/docs/visualizations/regenerate_visualizations.ipynb
@@ -28,14 +28,14 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "/Users/afontani/packages/OpenStudio-BuildStock/docs/visualizations/dependencyWheels\n",
+      "/Users/afontani/packages/resstock/docs/visualizations/dependencyWheels\n",
       "3.7.4 (default, Aug 13 2019, 15:17:50) \n",
       "[Clang 4.0.1 (tags/RELEASE_401/final)]\n",
       "Creating a dependency wheel for project:\n",
       "----------------------------------------\n",
       "../../../project_national\n",
       "../../../project_testing\n",
-      "/Users/afontani/packages/OpenStudio-BuildStock/docs/visualizations\n"
+      "/Users/afontani/packages/resstock/docs/visualizations\n"
      ]
     }
    ],
@@ -61,7 +61,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "/Users/afontani/packages/OpenStudio-BuildStock/docs/visualizations/dependencyGraphs\n",
+      "/Users/afontani/packages/resstock/docs/visualizations/dependencyGraphs\n",
       "3.7.4 (default, Aug 13 2019, 15:17:50) \n",
       "[Clang 4.0.1 (tags/RELEASE_401/final)]\n",
       "Creating a dependency graphs for project:\n",
@@ -84,7 +84,7 @@
       "Average out degree:   0.5217\n",
       "Longest path length:\t 4\n",
       "Maximum levels: \t 3\n",
-      "/Users/afontani/packages/OpenStudio-BuildStock/docs/visualizations\n"
+      "/Users/afontani/packages/resstock/docs/visualizations\n"
      ]
     }
    ],

diff --git a/measures/BuildExistingModel/measure.rb b/measures/BuildExistingModel/measure.rb
@@ -15,7 +15,7 @@
 require File.join(resources_path, "weather")
 
 # in addition to the above requires, this measure is expected to run in an
-# environment with OpenStudio-Buildstock/resources/buildstock.rb loaded
+# environment with resstock/resources/buildstock.rb loaded
 
 # start the measure
 class BuildExistingModel < OpenStudio::Measure::ModelMeasure

diff --git a/project_national/README.md b/project_national/README.md
@@ -6,7 +6,7 @@ This folder contains the ResStock inputs to model the national residential build
 
 ResStock is built upon the conditional probabilites of the housing characteristics.  Each housing characteristic has a set of dependencies and dependants.  An interactive dependency and dependents visualization is provided in the links below:
 
-<a href="https://htmlpreview.github.io/?https://github.com/NREL/OpenStudio-BuildStock/blob/master/project_national/util/dependency_wheel/dep_wheel.html">National Project: Dependency Wheel</a>
+<a href="https://htmlpreview.github.io/?https://github.com/NREL/resstock/blob/master/project_national/util/dependency_wheel/dep_wheel.html">National Project: Dependency Wheel</a>
 
 ## Visualization of the Housing Characteristics as a Graph
 

diff --git a/project_national/national.yml b/project_national/national.yml
@@ -1,6 +1,6 @@
 schema_version: 0.2
 stock_type: residential
-buildstock_directory: ../../OpenStudio-BuildStock # Relative to this file or absolute
+buildstock_directory: ../../resstock # Relative to this file or absolute
 project_directory: project_national # Relative to buildstock_directory
 output_directory: /scratch/<username>/outputs/project_national
 weather_files_url: https://data.nrel.gov/system/files/128/ResStock_TMY3.zip
@@ -40,8 +40,8 @@ postprocessing:
     region_name: 'us-west-2'
     s3:
       bucket: resbldg-datasets
-      prefix: OpenStudio-BuildStock
+      prefix: resstock
     athena:
       glue_service_role: service-role/AWSGlueServiceRole-default
-      database_name: OpenStudio-BuildStock
+      database_name: resstock
       max_crawling_time: 300 #time to wait for the crawler to complete before aborting it
diff --git a/project_testing/README.md b/project_testing/README.md
@@ -6,7 +6,7 @@ This folder contains the ResStock inputs to test our OpenStudio measures workflo
 
 ResStock is built upon the conditional probabilites of the housing characteristics.  Each housing characteristic has a set of dependencies and dependants.  An interactive dependency and dependents visualization is provided in the links below:
 
-<a href="https://htmlpreview.github.io/?https://github.com/NREL/OpenStudio-BuildStock/blob/master/project_testing/util/dependency_wheel/dep_wheel.html">Testing Project: Dependency Wheel</a>
+<a href="https://htmlpreview.github.io/?https://github.com/NREL/resstock/blob/master/project_testing/util/dependency_wheel/dep_wheel.html">Testing Project: Dependency Wheel</a>
 
 ## Visualization of the Housing Characteristics as a Graph