Skip to content

rjhanes/reV

 
 

Repository files navigation

Welcome to the Renewable Energy Potential (reV) Model!

https://codecov.io/gh/nrel/reV/branch/main/graph/badge.svg?token=U4ZU9F0K0Z

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.

Michael Rossol, Grant Buster, Mike Bannister, Robert Spencer, and Travis Williams. The Renewable Energy Potential Model (reV). https://github.com/NREL/reV (version v0.5.0), 2021. https://doi.org/10.5281/zenodo.4711470.

reV command line tools

Using Eagle Env

If you would like to run reV 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/

Launching a run

Tips

reV -c "/scratch/user/rev/config_pipeline.json" pipeline
  • Running simply generation or econ can just be done from the console:
reV -c "/scratch/user/rev/config_gen.json" generation

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

Installing reV

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 rev python=3.7
  2. Activate directory:
    conda activate rev
  3. Install reV:
    1. pip install NREL-reV or
    2. conda install nrel-rev --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 [email protected]: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

About

Renewable Energy Potential (reV) Model

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 66.1%
  • PowerBuilder 33.8%
  • Other 0.1%