Welcome to The REsource eXtraction (rex) tool!
What is rex?
rex stands for REsource eXtraciton tool.
rex enables the efficient and scalable extraction, manipulation, and computation with NLRs flagship renewable resource datasets such as: the Wind Integration National Dataset (WIND Toolkit), the National Solar Radiation Database (NSRDB), the Ocean Surface Wave Hindcast (US Wave) Data, and the High-resolution downscaled climate change data (Sup3rCC).
To get started accessing NLR’s datasets, see the primer on NLR Renewable Energy Resource Data or the installation instructions.
You might also want to check out the basic Resource Class that can be used to efficiently query NLR data, or our various example use cases.
Installing rex
NOTE: The installation instruction below assume that you have python installed on your machine and are using conda as your package/environment manager.
Option 1: Install from PIP or Conda (recommended for analysts):
- Create a new environment:
conda create --name rex
- Activate directory:
conda activate rex
- Basic rex install:
pip install NLR-rex
- Install for users outside of NLR that want to access data via HSDS or S3 as per the instructions here:
pip install NLR-rex[hsds] for more performant access of the data on HSDS with slightly more setup as per this hsds example. Note that the highest version of Python currently supported by hsds is Python 3.11.
Option 2: Clone repo (recommended for developers)
from home dir, git clone git@github.com:NatLabRockies/rex.git
- Create rex environment and install package
Create a conda env: conda create -n rex
Run the command: conda activate rex
cd into the repo cloned in 1.
prior to running pip below, make sure the branch is correct (install from main!)
Install rex and its dependencies by running: pip install . (or pip install -e . if running a dev branch or working on the source code)
- Check that rex was installed successfully
From any directory, run the following commands. This should return the help pages for the CLI’s.
rex
NSRDBX
WINDX
US-wave
rex command line tools
3 maintainers
Metadata
3 maintainers
Release files for NLR-rex 0.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| nlr_rex-0.6.1.tar.gz | 153.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nlr_rex-0.6.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 331.6 kB
Release files / nlr_rex-0.6.1.tar.gz
| Download URL | nlr_rex-0.6.1.tar.gz |
|---|---|
| Size | 153.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
eee1a3184eca5e1abd35d4ead4815653d29a52428b1fcaddd74a82ee3f2a4804
|
|
BLAKE2b-256 checksum How to use checksums |
4913818a6194db30018f61d7a14af75bd3c0ee52f8c40a94d25539a7ab7ae294
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 21, 2026.
Transparency logRelease files / nlr_rex-0.6.1-py3-none-any.whl
| Download URL | nlr_rex-0.6.1-py3-none-any.whl |
|---|---|
| Size | 177.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
684393fc92929a5bbdcd65779d4663703a4dc97431c2dc90bcdf2d44ab7ad094
|
|
BLAKE2b-256 checksum How to use checksums |
afed7625ac2ec0dfbd39fec03cb9aad596636ded1797035896c1e13b6bc64472
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 21, 2026.
Transparency log
