reV

Enables the efficient and scalable computation of renewable energy generation, levelized cost of energy, application of geospatial exclusion layers, and generation of renewable energy supply curves.
https://github.com/NREL/reV

Category: Energy Systems
Sub Category: Renewable Energy Integration

Keywords from Contributors

solar-energy nrel renewable-energy climate-data climate-change generative-adversarial-network wind-energy solar-power technical-potential wind-power

Last synced: about 12 hours ago
JSON representation

Repository metadata

Renewable Energy Potential (reV) Model

• Host: GitHub
• URL: https://github.com/NREL/reV
• Owner: NREL
• License: bsd-3-clause
• Created: 2019-08-08T21:54:39.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2025-04-21T05:54:47.000Z (7 days ago)
• Last Synced: 2025-04-25T14:08:20.041Z (3 days ago)
• Language: Python
• Homepage: https://nrel.github.io/reV/
• Size: 357 MB
• Stars: 120
• Watchers: 15
• Forks: 55
• Open Issues: 38
• Releases: 116
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

README.rst

          .. raw:: html

    

        
                       
        
    

---------

.. image:: https://github.com/NREL/reV/workflows/Documentation/badge.svg
    :target: https://nrel.github.io/reV/

.. image:: https://github.com/NREL/reV/workflows/Pytests/badge.svg
    :target: https://github.com/NREL/reV/actions?query=workflow%3A%22Pytests%22

.. image:: https://github.com/NREL/reV/workflows/Lint%20Code%20Base/badge.svg
    :target: https://github.com/NREL/reV/actions?query=workflow%3A%22Lint+Code+Base%22

.. image:: https://img.shields.io/pypi/pyversions/NREL-reV.svg
    :target: https://pypi.org/project/NREL-reV/

.. image:: https://badge.fury.io/py/NREL-reV.svg
    :target: https://badge.fury.io/py/NREL-reV

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

.. image:: https://zenodo.org/badge/201343076.svg
   :target: https://zenodo.org/badge/latestdoi/201343076

.. image:: https://mybinder.org/badge_logo.svg
    :target: https://mybinder.org/v2/gh/nrel/reV/HEAD

|

.. inclusion-intro

**reV** (the Renewable Energy Potential model)
is an open-source geospatial techno-economic tool that
estimates renewable energy technical potential (capacity and generation),
system cost, and supply curves for solar photovoltaics (PV),
concentrating solar power (CSP), geothermal, and wind energy.
reV allows researchers to include exhaustive spatial representation
of the built and natural environment into the generation and cost estimates
that it computes.

reV is highly dynamic, allowing analysts to assess potential at varying levels
of detail — from a single site up to an entire continent at temporal resolutions
ranging from five minutes to hourly, spanning a single year or multiple decades.
The reV model can (and has been used to) provide broad coverage across large spatial
extents, including North America, South and Central Asia, the Middle East, South America,
and South Africa to inform national and international-scale analyses. Still, reV is
equally well-suited for regional infrastructure and deployment planning and analysis.


For a detailed description of reV capabilities and functionality, see the
`NREL reV technical report `_.

How does reV work?
==================
reV is a set of `Python classes and functions `_
that can be executed on HPC systems using `CLI commands `_.
A full reV execution consists of one or more compute modules
(each consisting of their own Python class/CLI command)
strung together using a `pipeline framework `_,
or configured using `batch `_.

A typical reV workflow begins with input wind/solar/geothermal resource data
(following the `rex data format `_)
that is passed through the generation module. This output is then collected across space and time
(if executed on the HPC), before being sent off to be aggregated under user-specified land exclusion scenarios.
Exclusion data is typically provided via a collection of high-resolution spatial data layers stored in an HDF5 file.
This file must be readable by reV's
`ExclusionLayers `_
class. See the `reVX Setbacks utility `_
for instructions on generating setback exclusions for use in reV.
Next, transmission costs are computed for each aggregated
"supply-curve point" using user-provided transmission cost tables.
See the `reVX transmission cost calculator utility `_
for instructions on generating transmission cost tables.
Finally, the supply curves and initial generation data can be used to
extract representative generation profiles for each supply curve point.

A visual summary of this process is given below:


.. inclusion-flowchart

.. raw:: html

    

        
    

|

.. inclusion-get-started

To get up and running with reV, first head over to the `installation page `_,
then check out some of the `Examples `_ or
go straight to the `CLI Documentation `_!
You can also check out the `guide on running GAPs models `_.

.. inclusion-install


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

1. Create a new environment:
    ``conda create --name rev python=3.9``

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 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``


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 `_

.. code-block:: bash

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

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

.. code-block:: bash

    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 `_


.. inclusion-citation


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.

Grant Buster, Michael Rossol, Paul Pinchuk, Brandon N Benton, Robert Spencer,
Mike Bannister, & Travis Williams. (2023).
NREL/reV: reV 0.8.0 (v0.8.0). Zenodo. https://doi.org/10.5281/zenodo.8247528

        

---

Owner metadata

• Name: National Renewable Energy Laboratory
• Login: NREL
• Email:
• Kind: organization
• Description:
• Website: http://www.nrel.gov
• Location: Golden, CO
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/1906800?v=4
• Repositories: 599
• Last ynced at: 2024-12-18T09:41:07.898Z
• Profile URL: https://github.com/NREL

---

GitHub Events

Total

• Create event: 25
• Release event: 9
• Issues event: 50
• Watch event: 19
• Delete event: 17
• Member event: 1
• Issue comment event: 43
• Push event: 82
• Pull request review comment event: 15
• Pull request review event: 17
• Pull request event: 34
• Fork event: 33

Last Year

• Create event: 25
• Release event: 9
• Issues event: 50
• Watch event: 19
• Delete event: 17
• Member event: 1
• Issue comment event: 43
• Push event: 82
• Pull request review comment event: 15
• Pull request review event: 17
• Pull request event: 34
• Fork event: 33

---

Committers metadata

Last synced: 8 days ago

Name	Email	Commits
grantbuster	g****r@n****v	1091
ppinchuk	p****k@n****v	1088
Michael Rossol	m****l@g****m	855
Michael Rossol	m****l@n****v	172
bnb32	b****n@n****v	42
PJ Stanley	a****y@n****v	38
Rob Spencer	r****r@n****v	24
Michael Gleason	m****o@g****m	21
mbannist	m****r@n****v	13
williamstravis	t****s@n****v	11
AWS ParallelCluster user	e****r@i****l	6
WilliamsTravis	t****2@n****v	6
Buster	g****r@n****v	4
AWS ParallelCluster user	e****r@i****l	2
AWS ParallelCluster user	e****r@i****l	1
AWS ParallelCluster user	e****r@i****l	1
Rossol, Michael	M****l@n****v	1

Committer domains:

• nrel.gov: 11
• ip-172-31-2-102.us-west-2.compute.internal: 1
• ip-172-31-2-236.us-west-2.compute.internal: 1
• ip-172-31-4-73.us-west-2.compute.internal: 1
• ip-172-31-14-230.us-west-2.compute.internal: 1

---

Issue and Pull Request metadata

Last synced: 1 day ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/NREL/reV

---

---

---

Package metadata

• Total packages: 1
• Total downloads:
  • pypi: 4,162 last-month
• Total dependent packages: 1
• Total dependent repositories: 1
• Total versions: 112
• Total maintainers: 4

---

Dependencies

Score: 16.230999960516385