Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ body:
attributes:
label: Charge code
placeholder: >
If you are at NREL and fixing this bug is urgent, please provide a charge code
If you are at NLR and fixing this bug is urgent, please provide a charge code
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ body:
attributes:
label: Charge code
placeholder: >
If you are at NREL and implementing this feature is urgent, please provide a charge code
If you are at NLR and implementing this feature is urgent, please provide a charge code
29 changes: 14 additions & 15 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -7,49 +7,48 @@ type: software
authors:
- family-names: Buster
given-names: Grant
affiliation: National Renewable Energy Laboratory
affiliation: National Laboratory of the Rockies
orcid: 'https://orcid.org/0000-0001-8616-8100'
- family-names: Pinchuk
given-names: Pavlo
affiliation: National Renewable Energy Laboratory
affiliation: National Laboratory of the Rockies
orcid: 'https://orcid.org/0000-0003-4736-4728'
- family-names: Rossol
given-names: Michael
affiliation: National Renewable Energy Laboratory
affiliation: National Laboratory of the Rockies
orcid: 'https://orcid.org/0000-0001-9351-8404'
- family-names: Benton
given-names: Brandon
affiliation: National Renewable Energy Laboratory
affiliation: National Laboratory of the Rockies
orcid: "https://orcid.org/0009-0008-9931-2050"
- family-names: Gleason
given-names: Michael
affiliation: National Renewable Energy Laboratory
affiliation: National Laboratory of the Rockies
orcid: "https://orcid.org/0009-0003-5916-6726"
- family-names: Stanley
given-names: Andrew P.J.
affiliation: National Renewable Energy Laboratory
affiliation: National Laboratory of the Rockies
orcid: "https://orcid.org/0000-0002-0677-3413"
- family-names: Spencer
given-names: Robert
affiliation: National Renewable Energy Laboratory
affiliation: National Laboratory of the Rockies
- family-names: Bannister
given-names: Michael
affiliation: National Renewable Energy Laboratory
affiliation: National Laboratory of the Rockies
- family-names: Williams
given-names: Travis
affiliation: National Renewable Energy Laboratory
affiliation: National Laboratory of the Rockies
orcid: 'https://orcid.org/0000-0003-0973-1865'
identifiers:
- type: doi
value: 10.5281/zenodo.4501716
repository-code: 'https://github.com/NREL/reV'
abstract: >-
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 a variety of technologies, including but not
limited to, geothermal (GT), pumped storage hydropower (PSH),
solar photovoltaics (PV), concentrating solar power (CSP),
reV is an open-source geospatial techno-economic tool that
estimates energy technical potential (capacity and generation),
system cost, and supply curves for a variety of technologies,
including but not limited to, geothermal (GT), pumped storage
hydropower (PSH), solar photovoltaics (PV), concentrating solar power (CSP),
wind energy, etc. 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
Expand Down
9 changes: 4 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,8 @@

.. 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),
**reV** is an open-source geospatial techno-economic tool that
estimates energy technical potential (capacity and generation),
system cost, and supply curves for a variety of technologies, including
but not limited to, geothermal (GT), pumped storage hydropower (PSH),
solar photovoltaics (PV), concentrating solar power (CSP), wind energy, etc.
Expand All @@ -58,7 +57,7 @@ equally well-suited for regional infrastructure and deployment planning and anal


For a detailed description of reV capabilities and functionality, see the
`NREL reV technical report <https://www.nrel.gov/docs/fy19osti/73067.pdf>`_.
`NLR reV technical report <https://www.nrel.gov/docs/fy19osti/73067.pdf>`_.

How does reV work?
==================
Expand All @@ -69,7 +68,7 @@ A full reV execution consists of one or more compute modules
strung together using a `pipeline framework <https://nrel.github.io/reV/_cli/reV%20pipeline.html>`_,
or configured using `batch <https://nrel.github.io/reV/_cli/reV%20batch.html>`_.

A typical reV workflow begins with input wind/solar/geothermal resource data
A typical reV workflow begins with input resource data
(following the `rex data format <https://nrel.github.io/rex/misc/examples.nsrdb.html#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.
Expand Down
2 changes: 1 addition & 1 deletion conda.recipe/meta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,6 @@ requirements:
about:
home: "https://github.com/NREL/reV"
license: BSD 3-Clause
summary: "The Renewable Energy Potential (reV) Model"
summary: "The reV Model"
doc_url: "https://nrel.github.io/reV"
dev_url: "https://github.com/NREL/reV"
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

project = 'reV'
copyright = '2018, Alliance for Sustainable Energy, LLC'
author = 'NREL: Galen MacLaurin, Michael Rossol, Grant Buster'
author = 'NLR: Galen MacLaurin, Michael Rossol, Grant Buster'

pkg = os.path.dirname(os.path.abspath(os.path.dirname(__file__)))
pkg = os.path.dirname(pkg)
Expand Down
6 changes: 3 additions & 3 deletions examples/aws_pcluster/README.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Running reV on AWS Parallel Cluster HPC Infrastructure
======================================================

reV was originally designed to run on the NREL high performance computer (HPC), but you can now run reV on AWS using the NREL renewable energy resource data (the NSRDB and WTK) that lives on S3. This example will guide you through how to set up reV on an AWS HPC environment with dynamically scaled EC2 compute resources and input resource data sourced from S3 (optionally via HSDS).
reV was originally designed to run on the NLR high performance computer (HPC), but you can now run reV on AWS using the NLR resource data (the NSRDB and WTK) that lives on S3. This example will guide you through how to set up reV on an AWS HPC environment with dynamically scaled EC2 compute resources and input resource data sourced from S3 (optionally via HSDS).

If you plan on only running reV for a handful of sites (less than 100), first check out our `running reV locally example <https://nrel.github.io/reV/misc/examples.running_locally.html>`_ or `running with HSDS example <https://github.com/NREL/reV/tree/main/examples/running_with_hsds>`_, which will be a lot easier to get started with. Larger reV jobs require you stand up your own AWS parallel cluster and HSDS server. Very small jobs can be run locally using the NREL HSDS developer API.
If you plan on only running reV for a handful of sites (less than 100), first check out our `running reV locally example <https://nrel.github.io/reV/misc/examples.running_locally.html>`_ or `running with HSDS example <https://github.com/NREL/reV/tree/main/examples/running_with_hsds>`_, which will be a lot easier to get started with. Larger reV jobs require you stand up your own AWS parallel cluster and HSDS server. Very small jobs can be run locally using the NLR HSDS developer API.

Note that everything should be done in AWS region us-west-2 (Oregon) since this is where the NSRDB and WTK data live on S3.

Expand Down Expand Up @@ -50,7 +50,7 @@ Setting up an AWS Parallel Cluster
Notes on Running reV in the AWS Parallel Cluster
------------------------------------------------

#. If you use the NREL developer API key for HSDS and don't configure a custom HSDS Service you will almost certainly see 503 errors from too many requests being processed. See the instructions below to configure an HSDS Service.
#. If you use the NLR developer API key for HSDS and don't configure a custom HSDS Service you will almost certainly see 503 errors from too many requests being processed. See the instructions below to configure an HSDS Service.
#. AWS EC2 instances usually have twice as many vCPUs as physical CPUs due to a default of two threads per physical CPU (at least for the c5 instances) (see ``disable_hyperthreading = false``). The pcluster framework treats each thread as a "node" that can accept one reV job. For this reason, it is recommended that you scale the ``"nodes"`` entry in the reV generation config file but keep ``"max_workers": 1``. For example, if you use two ``c5.2xlarge`` instances in your compute fleet, this is a total of 16 vCPUs, each of which can be thought of as a HPC "node" that can run one process at a time.
#. If you setup an HSDS local server but the parallel cluster ends up sending too many requests (some nodes but not all will see 503 errors), you can try upping the ``max_task_count`` in the ``~/hsds/admin/config/override.yml`` file.
#. If your HSDS local server nodes run out of memory (monitor with ``docker stats``), you can try upping the ``dn_ram`` or ``sn_ram`` options in the ``~/hsds/admin/config/override.yml`` file.
Expand Down
4 changes: 2 additions & 2 deletions examples/marine_energy/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ reV Marine Energy Example
=========================

This example leverages the new SAM marine hydrokinetic (MHK) energy models, the
NREL hindcast wave data, the MHK cost models in NRWAL, and the integration of
NLR hindcast wave data, the MHK cost models in NRWAL, and the integration of
everything in to reV for large scale spatiotemporal analysis. The configs in
this example run a batched project that estimates the spatiotemporal capacity
factors and costs associated with three common wave energy reference models in
the Atlantic and Pacific Oceans.

National Renewable Energy Laboratory. (2020). High Resolution Ocean Surface
National Laboratory of the Rockies. (2020). High Resolution Ocean Surface
Wave Hindcast (US Wave) Data [data set]. Retrieved from
https://dx.doi.org/10.15473/1647329.

Expand Down
2 changes: 1 addition & 1 deletion examples/running_locally/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Run reV locally
and `reV Econ <https://nrel.github.io/reV/_autosummary/reV.econ.econ.Econ.html#reV.econ.econ.Econ>`_
can be run locally using resource .h5 files stored locally.

For users outside of NREL: you can now point reV directly to filepaths on S3! This will stream small amounts of data from S3 directly
For users outside of NLR: you can now point reV directly to filepaths on S3! This will stream small amounts of data from S3 directly
to your computer without having to setup an IO server like HSDS. See the example for reading data directly from S3
`here <https://nrel.github.io/rex/misc/examples.fsspec.html>`_ and try the example below with resource file paths from S3.

Expand Down
6 changes: 3 additions & 3 deletions examples/running_with_hsds/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ the `HDF Group <https://www.hdfgroup.org/>`_ and is hosted on Amazon Web
Services (AWS) using a combination of EC2 (Elastic Compute) and S3 (Scalable
Storage Service). You can read more about the HSDS service
`in this slide deck <https://www.slideshare.net/HDFEOS/hdf-cloud-services>`_.
You can use the NREL developer API as the HSDS endpoint for small workloads
You can use the NLR developer API as the HSDS endpoint for small workloads
or stand up your own HSDS local server (instructions further below) for an
enhanced parallelized data experience.

For general information on where to get started accessing NREL data from outside of NREL, see the `rex docs <https://nrel.github.io/rex/misc/examples.nrel_data.html#data-location-external-users>`_.
For general information on where to get started accessing NLR data from outside of NLR, see the `rex docs <https://nrel.github.io/rex/misc/examples.nrel_data.html#data-location-external-users>`_.

You might also be interested in these examples of how to set up your own `local HSDS server <https://nrel.github.io/rex/misc/examples.hsds.html#setting-up-a-local-hsds-server>`_ and how to run reV on an `AWS parallel cluster <https://nrel.github.io/reV/misc/examples.aws_pcluster.html>`_.

Expand Down Expand Up @@ -39,7 +39,7 @@ creating a configuration file at ``~/.hscfg``:

To get your own API key, visit https://developer.nrel.gov/signup/

Please note that our HSDS service is for demonstration purposes only. The API in the example above is hosted on an NREL server and will have limits on the amount of data you can access via HSDS. It is common to get an error: ``OSError: Error retrieving data: None errors`` if you attempt to access too much data or if the server is busy. Here are two references for scaling reV using HSDS and AWS:
Please note that our HSDS service is for demonstration purposes only. The API in the example above is hosted on an NLR server and will have limits on the amount of data you can access via HSDS. It is common to get an error: ``OSError: Error retrieving data: None errors`` if you attempt to access too much data or if the server is busy. Here are two references for scaling reV using HSDS and AWS:

#. `Setup your own HSDS server on your personal computer <https://nrel.github.io/rex/misc/examples.hsds.html#>`_
#. `Run reV on the AWS Parallel Cluster Infrastructure <https://nrel.github.io/reV/misc/examples.aws_pcluster.html>`_
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ build-backend = 'setuptools.build_meta'
[project]
name="NREL-reV"
dynamic = ["version"]
description = "National Renewable Energy Laboratory's (NREL's) Renewable Energy Potential(V) Model: reV"
description = "National Laboratory of the Rockies' (NLR's) reV model"
readme = {file = "README.rst", content-type = "text/x-rst"}
authors = [
{name = "Galen Maclaurin", email = "galen.maclaurin@nrel.gov"},
Expand All @@ -18,7 +18,7 @@ maintainers = [
{name = "Paul Pinchuk", email = "ppinchuk@nrel.gov"},
]
license = "BSD-3-Clause"
keywords = ["reV", "NREL"]
keywords = ["reV", "NLR"]
requires-python = ">= 3.9"
classifiers=[
"Development Status :: 4 - Beta",
Expand Down
7 changes: 4 additions & 3 deletions reV/SAM/SAM.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
"""reV-to-SAM interface module.

Wraps the NREL-PySAM library with additional reV features.
Wraps the NLR-PySAM library with additional reV features.
"""

import copy
Expand Down Expand Up @@ -405,8 +405,9 @@ def __setitem__(self, key, value):
logger.exception(msg)
raise SAMInputError(msg)

if (key == "total_installed_cost" and isinstance(value, str)
and value.casefold() == "windbos"):
value_is_windbos = (isinstance(value, str)
and value.casefold() == "windbos")
if (key == "total_installed_cost" and value_is_windbos):
# "windbos" is a special reV key to tell reV to compute
# total installed costs using WindBOS module. If detected,
# don't try to set it as a PySAM attribute
Expand Down
2 changes: 1 addition & 1 deletion reV/SAM/econ.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
"""reV-to-SAM econ interface module.

Wraps the NREL-PySAM lcoefcr and singleowner modules with
Wraps the NLR-PySAM lcoefcr and singleowner modules with
additional reV features.
"""
import logging
Expand Down
2 changes: 1 addition & 1 deletion reV/SAM/generation.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
"""reV-to-SAM generation interface module.

Wraps the NREL-PySAM pvwattsv5, windpower, and tcsmolensalt modules with
Wraps the NLR-PySAM pvwattsv5, windpower, and tcsmolensalt modules with
additional reV features.
"""

Expand Down
4 changes: 2 additions & 2 deletions reV/bespoke/bespoke.py
Original file line number Diff line number Diff line change
Expand Up @@ -1562,7 +1562,7 @@ def __init__(self, excl_fpath, res_fpath, tm_dset, objective_function,
However, unlike ``reV`` generation, bespoke analysis is
performed on the supply-curve grid resolution, and the plant
layout is optimized for every supply-curve point based on an
optimization objective specified by the user. See the NREL
optimization objective specified by the user. See the NLR
publication on the bespoke methodology for more information.

See the documentation for the ``reV`` SAM class (e.g.
Expand All @@ -1583,7 +1583,7 @@ def __init__(self, excl_fpath, res_fpath, tm_dset, objective_function,
uniquely defined (i.e.only appear once and in a single
input file).
res_fpath : str
Unix shell style path to wind resource HDF5 file in NREL WTK
Unix shell style path to wind resource HDF5 file in NLR WTK
format. Can also be a path including a wildcard input like
``/h5_dir/prefix*suffix`` to run bespoke on multiple years
of resource data. Can also be an explicit list of resource
Expand Down
2 changes: 1 addition & 1 deletion reV/supply_curve/sc_aggregation.py
Original file line number Diff line number Diff line change
Expand Up @@ -684,7 +684,7 @@ def __init__(self, excl_fpath, tm_dset, econ_fpath=None,
Total included area for each supply curve point in km2. This
is based on the nominal area of each exclusion pixel which
by default is calculated from the exclusion profile
attributes. The NREL reV default is 0.0081 km2 pixels
attributes. The NLR reV default is 0.0081 km2 pixels
(90m x 90m). The area sum considers partial inclusions.
latitude : float
Supply curve point centroid latitude coordinate, in degrees
Expand Down
Loading