reVX stands for the Renewable Energy Potential(V) EXchange tool.
reVX provides a set of tools to extract data from reV model outputs, as well as interfaces between reV and other renewable energy focused models, for example, ReEDS, RPM, and PLEXOS.
NOTE: The installation instruction below assume that you have python installed on your machine and are using conda as your package/environment manager.
conda create --name revx python=3.11
conda activate revx
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
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
- 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.11Install the
flickerdependency:pip install -e .[flicker]
Update with current version and DOI:
Michael Rossol, Grant Buster, and Robert Spencer. The reV eXchange Tool: reVX. https://github.com/NREL/reVX (version v0.3.20), 2021. https://doi.org/10.5281/zenodo.4507580.