rex documentation

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: the Wind Integration National Dataset (WIND Toolkit), and the National Solar Radiation Database (NSRDB)

rex command line tools

Using Eagle Env

If you would like to run rex on Eagle (NREL’s HPC) you can use a pre-compiled conda env:

conda activate /shared-projects/rev/modulefiles/conda/envs/rev/

or

source activate /shared-projects/rev/modulefiles/conda/envs/rev/

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
Install rex:
1. pip install NREL-rex or
2. conda install nrel-rex --channel=nrel
  - NOTE: If you install using conda and want to use HSDS you will also need to install h5pyd manually: pip install h5pyd

Option 2: Clone repo (recommended for developers)

from home dir, git clone git@github.com:NREL/rex.git
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)
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

Recommended Citation

Update with current version and DOI:

Michael Rossol, Grant Buster. The REsource Extraction Tool (rex). https://github.com/NREL/rex (version v0.2.43), 2021. https://doi.org/10.5281/zenodo.4499033.