How do I use ResStock?

edit

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.

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.