Docs Tests Linter PyPi PythonV Conda Licence CodeCov Zeonodo

What is rex?

rex stands for REsource eXtraciton tool.

rex enables the efficient and scalable extraction, manipulation, and computation with NRELs 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 NREL’s datasets, see the primer on NREL 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 NREL 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):

  1. Create a new environment:

    conda create --name rex

  2. Activate directory:

    conda activate rex

  3. Basic rex install:

    1. pip install NREL-rex

    2. or conda install nrel-rex --channel=nrel

  4. Install for users outside of NREL that want to access data via HSDS or S3 as per the instructions here:

    1. pip install NREL-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)

  1. from home dir, git clone git@github.com:NREL/rex.git

  2. Create rex environment and install package

    1. Create a conda env: conda create -n rex

    2. Run the command: conda activate rex

    3. cd into the repo cloned in 1.

    4. prior to running pip below, make sure the branch is correct (install from main!)

    5. Install rex and its dependencies by running: pip install . (or pip install -e . if running a dev branch or working on the source code)

  3. Check that rex was installed successfully

    1. 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

Project links

Data verified by PyPI on Jul 11, 2025
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

4 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for bnb32 from gravatar.com bnb32 Avatar for grantbuster-nrel from gravatar.com grantbuster-nrel Avatar for mrossol_nrel from gravatar.com mrossol_nrel
+1 more Avatar for ppinchuk-nrel from gravatar.com ppinchuk-nrel

Credits

Author: Michael Rossol

Maintainer: Grant Buster

GitHub Statistics

Data verified by PyPI on Jul 11, 2025
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

BSD-3-Clause
View SPDX License List

Requires

Python >=3.9

Provides Extra

test dev hsds build

Tags

rex NREL

Classifiers

Report project as malware

Release files for NREL-rex 0.4.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for NREL-rex 0.4.3
File Size Uploaded
nrel_rex-0.4.3.tar.gz 152.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for NREL-rex 0.4.3
File Interpreter ABI Platform
nrel_rex-0.4.3-py3-none-any.whl 177.5 kB Python 3 none any Details

Total release size: 329.7 kB

Release files / nrel_rex-0.4.3.tar.gz

Download URL nrel_rex-0.4.3.tar.gz
Size 152.1 kB
Tags Source
SHA-256 checksum
How to use checksums 		64d99795e7c9a901252321af288000c6d5bccea8e80fa47ad540f39b2a507ba7
BLAKE2b-256 checksum
How to use checksums 		4c4e28f828fb5999f9d495a68b4705422747a3641a536667fbc9b97c57662437
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		Yes
Uploaded via twine/6.1.0 CPython/3.12.9

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 Jul 11, 2025.

Transparency log
Identity
Publishing platform
GitHub Actions
Publishing repository
github.com/NREL/rex
Publishing commit
github.com/NREL/rex/tree/f18517444433cdb7732dd70c7c7d131f12a1f863
Workflow
Publishing configuration
github.com/NREL/rex/blob/f18517444433cdb7732dd70c7c7d131f12a1f863/.github/workflows/publish_to_pypi.yml
Publishing logs
github.com/NREL/rex/actions/runs/16231504795/attempts/1
Artifact
Subject
nrel_rex-0.4.3.tar.gz
SHA-256 checksum
64d99795e7c9a901252321af288000c6d5bccea8e80fa47ad540f39b2a507ba7 Verifying attestations

Release files / nrel_rex-0.4.3-py3-none-any.whl

Download URL nrel_rex-0.4.3-py3-none-any.whl
Size 177.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums 		9e44813f5f022990d3d33a7aab0685522b40c651539b227e29ce9aaa239ac886
BLAKE2b-256 checksum
How to use checksums 		a066404e1cea32ebd39f519d757b7c0c9e5a71e0ce2bac4a70d2098d3ab248f3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		Yes
Uploaded via twine/6.1.0 CPython/3.12.9

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 Jul 11, 2025.

Transparency log
Identity
Publishing platform
GitHub Actions
Publishing repository
github.com/NREL/rex
Publishing commit
github.com/NREL/rex/tree/f18517444433cdb7732dd70c7c7d131f12a1f863
Workflow
Publishing configuration
github.com/NREL/rex/blob/f18517444433cdb7732dd70c7c7d131f12a1f863/.github/workflows/publish_to_pypi.yml
Publishing logs
github.com/NREL/rex/actions/runs/16231504795/attempts/1
Artifact
Subject
nrel_rex-0.4.3-py3-none-any.whl
SHA-256 checksum
9e44813f5f022990d3d33a7aab0685522b40c651539b227e29ce9aaa239ac886 Verifying attestations

Release history Release notifications | RSS feed

This release

0.4.3 This release

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.5

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.100

2 release files

0.2.99

2 release files

0.2.98

2 release files

0.2.97

2 release files

0.2.96

2 release files

0.2.91

2 release files

0.2.90

2 release files

0.2.89

2 release files

0.2.88

2 release files

0.2.87

2 release files

0.2.86

2 release files

0.2.85

2 release files

0.2.84

2 release files

0.2.83

2 release files

0.2.82

2 release files

0.2.81

2 release files

0.2.80

2 release files

0.2.79

2 release files

0.2.78

2 release files

0.2.77

2 release files

0.2.76

2 release files

0.2.75

2 release files

0.2.74

2 release files

0.2.73

2 release files

0.2.72

2 release files

0.2.71

2 release files

0.2.70

2 release files

0.2.69

2 release files

0.2.68

2 release files

0.2.67

2 release files

0.2.66

2 release files

0.2.64

2 release files

0.2.63

2 release files

0.2.62

2 release files

0.2.61

2 release files

0.2.60

2 release files

0.2.59

2 release files

0.2.58

2 release files

0.2.57

2 release files

0.2.56

2 release files

0.2.55

2 release files

0.2.54

2 release files

0.2.53

2 release files

0.2.52

2 release files

0.2.51

2 release files

0.2.50

2 release files

0.2.49

2 release files

0.2.48

2 release files

0.2.47

2 release files

0.2.46

2 release files

0.2.45

2 release files

0.2.44

2 release files

0.2.43

2 release files

0.2.42

2 release files

0.2.41

2 release files

0.2.40

2 release files

0.2.39

2 release files

0.2.38

2 release files

0.2.37

2 release files

0.2.36

2 release files

0.2.35

2 release files

0.2.33

2 release files

0.2.32

2 release files

0.2.31

2 release files

0.2.30

2 release files

0.2.29

2 release files

0.2.28

2 release files

0.2.27

2 release files

0.2.26

2 release files

0.2.25

2 release files

0.2.24

2 release files

0.2.23

2 release files

0.2.22

2 release files

0.2.21

2 release files

0.2.20

2 release files

0.2.19

2 release files

0.2.18

2 release files

0.2.17

2 release files

0.2.16

2 release files

0.2.15

2 release files

0.2.14

2 release files

0.2.13

2 release files

0.2.12

2 release files

0.2.11

2 release files

0.2.10

2 release files

0.2.9

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.13

2 release files

0.1.12

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page