Question-and-Answer Resource for the Building Energy Modeling Community
Get started with the Help page
Ask Your Question

How do I use ResStock?

asked 2021-07-22 14:41:11 -0500

Victor_Tu's avatar

updated 2021-07-31 12:54:34 -0500

I have been trying to understand the capabilities of ResStock, however, I have an issue with understanding how to run it. I am currently using OpenStudio v2.9.0 to try and run ResStock, but I keep getting a large error message.

I was wondering if anyone could run me through the process of installing and using ResStock! I read that ResStock needs buildstockbatch v0.18 and EnergyPlus v9.2, so could that be the reason why ResStock isn't working for me?

edit retag flag offensive close merge delete

2 Answers

Sort by ยป oldest newest most voted

answered 2021-07-22 21:45:40 -0500

sashadf1's avatar

updated 2021-07-22 22:20:58 -0500

I have been using ResStock v2.2.4 for the past year! I can't help you with any of the newer versions of ResStock that don't use the ParametricAnalysisTool (PAT); everything after v2.2.5 I don't have experience with. You should download v2.2.5, since that has a few minor differences from v2.2.4 but still follows the same framework. I use OS v2.9.0 as well! I can help you install it, maybe we can set up a video call.

Which Versions of ResStock Use PAT

edit flag offensive delete link more


Great! Thanks for responding! I think a video call would be great. How can I contact you?

Victor_Tu's avatar Victor_Tu  ( 2021-07-23 11:08:30 -0500 )edit

Hey Victor; you can send me an email at and we can set something up.

sashadf1's avatar sashadf1  ( 2021-07-26 13:43:30 -0500 )edit

answered 2021-08-06 17:11:32 -0500

zel3's avatar

I also had a ton of problems setting up Resstock v2.3+, mostly because I didn't know about buildstockbatch. Here is a quick rundown of what I did:

  1. Download Resstock and Ruby using the "Advanced Tutorial" Resstock documentation. Make sure you download the correct versions of Resstock (2.4.0 currently), Ruby (2.2.4), and Ruby Devkit. I had problems with Ruby certificates, so you may have to use this link to download the correct gems.
  2. Download Buildstockbatch v0.18 and install it as you would a python package. You'll also need to download and install Docker. If everything is correct, you should be able to run buildstock_docker in the command line as a script. You'll use this to run the project .yml files contained in the resstock directory.
  3. You can run the sampling projects in Resstock locally by navigating to the directory, and using the command buildstock_docker testing.yml. Buildstock's documentation goes through each of the options you'll need and how to configure the yml file to accomplish what you want to do. One thing to note is that the example .yml file asks you to provide the path to the buildstock directory, when this should be the resstock directory.
  4. This command will sample from the given housing_characteristic distributions, generate a bunch of .idf files, then run the simulation and give a postprocessed output.
edit flag offensive delete link more


I'm stuck on step 2; I've installed the library successfully per the line of code here:

But when I run "buildstock_docker --help" it shows that it is not recognized.

Have I not installed the library correctly?

Thalib Razi's avatar Thalib Razi  ( 2022-04-11 11:33:52 -0500 )edit

If you are getting the "'buildstock_docker' is not recognized..." error, make sure you are in the buildstock directory or that you've added it to your PATH.

EDIT: Make sure to install it with like you would any other python package. This will add it to your path.

zel3's avatar zel3  ( 2022-04-12 08:58:13 -0500 )edit

I am in the buildstock directory, but no luck. When I run "python -m pip install -e . --user", I get many lines of "Requirement already satisfied: ... in c:\user\appdata\roaming\python\etc...", then:

Installing collected packages: buildstockbatch

Attempting uninstall: buildstockbatch

Found existing installation: buildstockbatch 0.19

Uninstalling buildstockbatch-0.19:

Successfully uninstalled buildstockbatch-0.19

Running develop for buildstockbatch

Successfully installed buildstockbatch

I'm very new to this, but this seems off. Any idea? Tagging @David Goldwasser

Thalib Razi's avatar Thalib Razi  ( 2022-04-12 11:59:46 -0500 )edit

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer


Question Tools



Asked: 2021-07-22 14:41:11 -0500

Seen: 361 times

Last updated: Aug 06 '21