Installation

---

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 (recommended for analysts):

1. Create a new environment:

   conda create --name rev python=3.11

2. Activate directory:

   conda activate rev

3. Install reV:

   1. pip install NREL-reV or

      • NOTE: If you install using conda and want to use HSDS you will also need to install HSDS dependencies: pip install NREL-reV[hsds]

Option 2: Clone repo (recommended for developers)

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

2. Create reV environment and install package

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

   2. Run the command: conda activate rev

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

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

      • reV

reV Ecosystem

The reV model suite comes with a set of tools that can be used alongside the core model to assist with data preparation and analysis:

• reVX - Collection of helper methods to pre- and post- process geospatial reV data (e.g. setback layers, inclusion masks, etc.)

• rex - Library to assist with reV-style data I/O, especially resource data

• reVRt (Coming soon!) - reV routing tool used to compute transmission costs

• NRWAL - Equation Library for detailed cost analysis (offshore, hydrogen, etc.)

• reVeal (Coming soon!) - reV extension for load analysis and land characterization

• reVReports - Tool for generating publication-ready maps of reV supply curve outputs

• reView - Dashboard for interactive visualization of reV supply curve outputs

• reV tutorial - Collection of tutorials for learning how to use reV

• gaps - Underlying reV pipeline job submission and management system

reV command line tools

• reV

• reV template-configs

• reV batch

• reV pipeline

• reV project-points

• reV bespoke

• reV generation

• reV econ

• reV collect

• reV multiyear

• reV supply-curve-aggregation

• reV supply-curve

• reV rep-profiles

• reV hybrids

• reV nrwal

• reV qa-qc

• reV script

• reV status

• reV reset-status

Launching a run

Tips

• Only use a screen session if running the pipeline module: screen -S rev

• Full pipeline execution

reV pipeline -c "/scratch/user/rev/config_pipeline.json"

• Running simply generation or econ can just be done from the console:

reV generation -c "/scratch/user/rev/config_gen.json"

General Run times and Node configuration on Eagle

• WTK Conus: 10-20 nodes per year walltime 1-4 hours

• NSRDB Conus: 5 nodes walltime 2 hours

Eagle node requests

Recommended Citation

Please cite both the technical paper and the software with the version and DOI you used:

Maclaurin, Galen J., Nicholas W. Grue, Anthony J. Lopez, Donna M. Heimiller, Michael Rossol, Grant Buster, and Travis Williams. 2019. “The Renewable Energy Potential (reV) Model: A Geospatial Platform for Technical Potential and Supply Curve Modeling.” Golden, Colorado, United States: National Renewable Energy Laboratory. NREL/TP-6A20-73067. https://doi.org/10.2172/1563140.

Buster, G., Pinchuk, P., Rossol, M., Benton, B., Gleason, M., Stanley, A. P., Spencer, R., Bannister, M., & Williams, T. (2020). reV (Version 0.14.5) [Computer software]. https://github.com/NREL/reV

Command Line Tools

---

• reV

• reV template-configs

• reV batch

• reV pipeline

• reV project-points

• reV bespoke

• reV generation

• reV econ

• reV collect

• reV multiyear

• reV supply-curve-aggregation

• reV supply-curve

• reV rep-profiles

• reV hybrids

• reV nrwal

• reV qa-qc

• reV script

• reV status

• reV reset-status