Installation

---

NOTE: The installation instruction below assume that you have python installed on your machine and are using conda as your package/environment manager.

1. Create a new environment:

   conda create --name revx python=3.11

2. Activate your new environment:

   conda activate revx

3. Clone the repo:

   From your home directory /home/{user}/ or another directory that you have permissions in, run the command git clone git@github.com:NREL/reVX.git and then go into your cloned repository: cd reVX

4. Install reVX:

   1. Follow the installation commands installation process that we use for our automated test suite here. Make sure that you call pip install --no-build-isolation -e . from within the cloned repository directory e.g. /home/{user}/reVX/. Don’t forget to run pip install --upgrade setuptools, especially if you run into any build errors.

      • 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

      • NOTE: If you install using pip and want to run shadow flicker exclusions, make sure you:

        • Use Python 3.10 or 3.11: conda create --name revx python=3.11

        • Install the flicker dependency: pip install -e .[flicker]

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.

Command Line Tools

---

• reVX

• reV-rpm

• reV-plexos

• plexos-plants

• mean-wind-dirs

• prominent-wind-dirs

• setbacks

• offshore-assembly-areas

• offshore-dist-to-ports

• offshore-inputs