NREL-rex 0.2.17

National Renewable Energy Laboratory's (NREL's) REsource eXtraction tool: rex

The REsource eXtraction (rex) tool

rex command line tools

• rex

• NSRDBX

• WINDX

• WaveX

• MultiYearX

• rechunk

Using Eagle Env / Module

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

conda activate /datasets/modulefiles/conda_env

or

source activate /datasets/modulefiles/conda_env

or module:

module use /datasets/modulefiles
module load rex

NOTE: Loading the rex module can take several minutes

Installing rex

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

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

   1. enter github username

   2. enter github password

2. Install reV environment and modules (using conda)

   1. cd into reV repo cloned above

   2. cd into bin/$OS/

   3. run the command: conda env create -f rex.yml. If conda can’t find any packages, try removing them from the yml file.

   4. run the command: conda activate rex

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

   6. cd back to the rex repo (where setup.py is located)

   7. install pre-commit: pre-commit install

   8. run pip install . (or pip install -e . if running a dev branch or working on the source code)

3. Check that rev was installed successfully

   1. From any directory, run the following commands. This should return the help pages for the CLI’s.

      • rex

      • NSRDB

      • WIND

      • rechunk