Skip to content

buildstock-fetch

Release Build status Commit activity License

A CLI tool to simplify downloading building characteristics and load curve data from NREL's ResStock and ComStock projects. Also available as a Python library.

Installing bsf

To install the buildstock-fetch CLI tool, we recommend using uv or pipx:

uv tool install buildstock-fetch

or

pipx install buildstock-fetch

You'll then be able to access the bsf command system-wide:

bsf --help

Using bsf

To make it easy to download what you want from NREL's S3 bucket, bsf has an interactive mode. Activate it with:

bsf

Alternatively, you can tell bsf exactly what to download via CLI args:

bsf --product resstock --release_year 2022 --weather_file tmy3 --release_version 1 --states CA --file_type "hpxml metadata" --upgrade_id "0 1 2" --output_directory ./CA_data

For more details about the usage, see Usage

Installing the Python library

buildstock-fetch is implemented in Python, and we expose our internal functions via a library.

If you're using Python, and you want to install the CLI only for a particular project (rather than system-wide), or you want to user the underlying library, install our PyPI package via:

pip install buildstock-fetch

or

uv add buildstock-fetch