Home

BuildStockQuery (BSQ)

---

A library to run AWS Athena queries against BuildStock (ResStock and ComStock) runs.

Installation Instruction

Install as a library to your existing project

1. If you already have a python environment (python >= 3.10), skip to step 3.
2. Create a conda environment

conda create -n bsq_env python=3.10

3. Activate the environment

conda activate bsq_env

4. Install

Standard Installation:

pip install git+https://github.com/NREL/buildstock-query

Full Installation (required to get access to upgrades_visualizer)

pip install git+https://github.com/NREL/buildstock-query#egg=buildstock-query[full]

Development installation

If you want to contribute back to the repo, and maybe fix bugs / add functions as you work with buildstock_query, you can do this.

1. Clone the repo to your computer:

git clone https://github.com/NREL/buildstock-query

2. Navigate inside the buildstock-query clone, and checkout a new branch so you can modify/fix things

git checkout -b new_branch

or alternatively, checkout to an existing branch to use its feature (for example reviewing a PR)

git checkout existing_branch

3. Create a python environment

conda create -n bsq_env python=3.10

3. Activate your project environment (your project env needs python >= 3.10)

conda activate bsq_env

4. Do dev install of the buildstock_query in editable mode to your env. You should be at project root.

pip install -e .[dev]