NREL-reVX 0.3.3

National Renewable Energy Laboratory's (NREL's) Renewable Energy Potential(V) eXchange Tool: reVX

Renewable Energy Potential(V) eXchange Tool: reVX

reVX command line tools

• reVX

• reV-ReEDS

• reV-rpm

• reV-plexos

• plexos-plants

• wind-dirs

Using Eagle Env / Module

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

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

or

source activate /shared-projects/rev/modulefiles/conda_env

or module:

module use /shared-projects/rev/modulefiles
module load reVX

NOTE: Loading the reVX module can take several minutes

Installing reVX

Option 1: Install from PIP or Conda (recommended for analysts):

1. Create a new environment:

   conda create --name revx python=3.7

2. Activate directory:

   conda activate revx

3. Install reVX:

   1. pip install NREL-reVX or

   2. conda install nrel-revx --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/reVX.git

   1. enter github username

   2. enter github password

2. Install reVX environment and modules (using conda)

   1. cd into reVX repo cloned above

   2. cd into bin/$OS/

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

   4. run the command: conda activate revx

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

   6. cd back to the reVX 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. from home dir, git clone https://github.com/NREL/reV.git

   1. enter github username

   2. enter github password

4. Install reV environment and modules (using conda)

   1. cd into reV repo cloned above

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

   3. cd back to the reV repo (where setup.py is located)

   4. install pre-commit: pre-commit install

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

3. Check that reV and reVX were installed successfully

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

      • reVX

      • reV