Welcome to the reV eXchange (reVX) tool!

reVX command line tools

• reVX
• reV-ReEDS
• reV-rpm
• reV-plexos
• plexos-plants
• mean-wind-dirs
• prominent-wind-dirs
• setbacks
• offshore-assembly-areas
• offshore-dist-to-ports
• offshore-inputs

Using Eagle Env

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/envs/rev/

or

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

Installing reVX

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 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: The best guarantee you will have of a correct installation is by following the same installation process that we use for our automated test suite.

      • NOTE: If you install using conda and you want to use:

        • HSDS you will also need to install h5pyd manually: pip install h5pyd
        • Turbine Flicker you will need to install HOPP manually: pip install HOPP

      • NOTE: If you install using pip and want to run exclusion setbacks you will need to install rtree manually:

        • conda install rtree
        • pip installation instructions

Option 2: Clone repo (recommended for developers)

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

2. Create reVX environment and install package

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

   2. Run the command: conda activate revx

   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 reVX 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 reVX was installed successfully

   1. From any directory, run the following commands. This should return the

      help pages for the CLI's.

      • reVX

Recommended Citation

Update with current version and DOI:

Michael Rossol, Grant Buster, and Robert Spencer. The Renewable Energy Potential(V) eXchange Tool: reVX. https://github.com/NREL/reVX (version v0.3.20), 2021. https://doi.org/10.5281/zenodo.4507580.