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.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ If applicable, add screenshots to help explain your problem.
Add any other context about the problem here.

**Charge code**
If you are at NREL and fixing this bug is urgent, please provide a charge code for our time.
If you are at NLR and fixing this bug is urgent, please provide a charge code for our time.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/documentation_improvement.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ body:
options:
- label: >
I have checked that the issue still exists on the latest versions of the docs
on `main` [here](https://nrel.github.io/sup3r/)
on `main` [here](https://natlabrockies.github.io/sup3r/)
required: true
- type: textarea
id: location
attributes:
label: Location of the documentation
description: >
Please provide the location of the documentation,
placeholder: https://nrel.github.io/sup3r/_autosummary/sup3r.cli.html#sup3r.cli
placeholder: https://natlabrockies.github.io/sup3r/_autosummary/sup3r.cli.html#sup3r.cli
validations:
required: true
- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ A clear and concise description of any alternative solutions or features you've
Add any other context or screenshots about the feature request here.

**Charge code**
If you are at NREL, please provide a task number for the developers to implement this feature.
If you are at NLR, please provide a task number for the developers to implement this feature.

**Urgency / Timeframe**
When do you need this feature by? How urgent is it related to other feature requests you've made?
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/installation_issue.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ body:
label: Installation check
options:
- label: >
I have read the [installation guide](https://nrel.github.io/sup3r/misc/installation.html).
I have read the [installation guide](https://natlabrockies.github.io/sup3r/misc/installation.html).
required: true
- type: input
id: platform
Expand Down
16 changes: 8 additions & 8 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -7,36 +7,36 @@ type: software
authors:
- family-names: Benton
given-names: Brandon
affiliation: NREL
affiliation: NLR
orcid: "https://orcid.org/0009-0008-9931-2050"
- family-names: Buster
given-names: Grant
affiliation: NREL
affiliation: NLR
orcid: "https://orcid.org/0000-0001-8616-8100"
- family-names: Hassanaly
given-names: Malik
affiliation: NREL
affiliation: NLR
orcid: "https://orcid.org/0000-0002-0425-9090"
- family-names: Pinchuk
given-names: Pavlo
affiliation: NREL
affiliation: NLR
orcid: "https://orcid.org/0000-0003-4736-4728"
- family-names: Podgorny
given-names: Slater
affiliation: NREL
affiliation: NLR
orcid: "https://orcid.org/0009-0008-4903-411X"
- family-names: Glaws
given-names: Andrew
affiliation: NREL
affiliation: NLR
orcid: "https://orcid.org/0000-0002-7268-1883"
- family-names: King
given-names: Ryan
affiliation: NREL
affiliation: NLR
orcid: "https://orcid.org/0000-0002-0591-7139"
identifiers:
- type: doi
value: 10.5281/zenodo.6808547
repository-code: 'https://github.com/NREL/sup3r'
repository-code: 'https://github.com/NatLabRockies/sup3r'
abstract: >-
The Super Resolution for Renewable Resource Data (sup3r)
software uses generative adversarial networks to create
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
BSD 3-Clause License

Copyright (c) 2022, Alliance for Sustainable Energy LLC, All rights reserved.
Copyright (c) 2022, Alliance for Energy Innovation LLC, All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Expand Down
90 changes: 45 additions & 45 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
.. image:: https://raw.githubusercontent.com/NREL/sup3r/main/docs/source/_static/sup3r_github_banner.jpg
.. image:: https://raw.githubusercontent.com/NatLabRockies/sup3r/main/docs/source/_static/sup3r_github_banner.jpg
:width: 750
:alt: sup3r banner

|Docs| |Tests| |Linter| |PyPi| |PythonV| |Codecov| |Zenodo|

.. |Docs| image:: https://github.com/NREL/sup3r/workflows/Documentation/badge.svg
:target: https://nrel.github.io/sup3r/
.. |Docs| image:: https://github.com/NatLabRockies/sup3r/workflows/Documentation/badge.svg
:target: https://natlabrockies.github.io/sup3r/

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

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

.. |PyPi| image:: https://img.shields.io/pypi/pyversions/NREL-sup3r.svg
:target: https://pypi.org/project/NREL-sup3r/
.. |PyPi| image:: https://img.shields.io/pypi/pyversions/NLR-sup3r.svg
:target: https://pypi.org/project/NLR-sup3r/

.. |PythonV| image:: https://badge.fury.io/py/NREL-sup3r.svg
:target: https://badge.fury.io/py/NREL-sup3r
.. |PythonV| image:: https://badge.fury.io/py/NLR-sup3r.svg
:target: https://badge.fury.io/py/NLR-sup3r

.. |Codecov| image:: https://codecov.io/gh/nrel/sup3r/branch/main/graph/badge.svg
:target: https://codecov.io/gh/nrel/sup3r
.. |Codecov| image:: https://codecov.io/gh/NatLabRockies/sup3r/branch/main/graph/badge.svg
:target: https://codecov.io/gh/NatLabRockies/sup3r

.. |Zenodo| image:: https://zenodo.org/badge/422324608.svg
:target: https://zenodo.org/badge/latestdoi/422324608


Developed by NREL, Sup3r is open-source software that transforms coarse,
Developed by NLR, Sup3r is open-source software that transforms coarse,
low-resolution data into actionable and accessible hyper-local data at
unprecedented speed and scale.

Expand All @@ -43,17 +43,17 @@ Getting Started

Here are some options to get started with sup3r:

#. Learn `how to install sup3r <https://nrel.github.io/sup3r/#installing-sup3r>`_.
#. Learn `how sup3r works <https://nrel.github.io/sup3r/#how-it-works>`_.
#. Learn about our `current applications of sup3r <https://nrel.github.io/sup3r/#applications-of-sup3r>`_.
#. Learn about the methods and validation of sup3r from `our publications <https://nrel.github.io/sup3r/index.html#publications>`_.
#. To access output datasets, see `our data records <https://nrel.github.io/sup3r/#data-records>`_ from previous applications.
#. To get started running sup3r software, check out our `test suite <https://github.com/NREL/sup3r/tree/main/tests>`_ that uses the software on small pieces of test data.
#. To get started loading in data for training or inference, start with the `data handler object <https://nrel.github.io/sup3r/_autosummary/sup3r.preprocessing.data_handlers.base.DataHandler.html#sup3r.preprocessing.data_handlers.base.DataHandler>`_ that is our basic data structure that opens NREL .h5 and other .nc data files.
#. To get started with model training, check out our `training tests <https://github.com/NREL/sup3r/blob/main/tests/training/test_train_gan.py>`_ that initialize and train a basic GAN on small test data.
#. To get started with model inference, check out our `forward pass tests <https://github.com/NREL/sup3r/blob/main/tests/forward_pass/test_forward_pass.py>`_ that run a simple inference on small test data. Alternatively, see the examples linked below.
#. To see previous examples of sup3r code, configs, pretrained models, and data, see our `published examples <https://github.com/NREL/sup3r/tree/main/examples>`_.
#. To setup full runs on an HPC environment, check out the sup3r command line interface `(CLI) <https://nrel.github.io/sup3r/_cli/sup3r.html#sup3r>`_.
#. Learn `how to install sup3r <https://natlabrockies.github.io/sup3r/#installing-sup3r>`_.
#. Learn `how sup3r works <https://natlabrockies.github.io/sup3r/#how-it-works>`_.
#. Learn about our `current applications of sup3r <https://natlabrockies.github.io/sup3r/#applications-of-sup3r>`_.
#. Learn about the methods and validation of sup3r from `our publications <https://natlabrockies.github.io/sup3r/index.html#publications>`_.
#. To access output datasets, see `our data records <https://natlabrockies.github.io/sup3r/#data-records>`_ from previous applications.
#. To get started running sup3r software, check out our `test suite <https://github.com/NatLabRockies/sup3r/tree/main/tests>`_ that uses the software on small pieces of test data.
#. To get started loading in data for training or inference, start with the `data handler object <https://natlabrockies.github.io/sup3r/_autosummary/sup3r.preprocessing.data_handlers.base.DataHandler.html#sup3r.preprocessing.data_handlers.base.DataHandler>`_ that is our basic data structure that opens NLR .h5 and other .nc data files.
#. To get started with model training, check out our `training tests <https://github.com/NatLabRockies/sup3r/blob/main/tests/training/test_train_gan.py>`_ that initialize and train a basic GAN on small test data.
#. To get started with model inference, check out our `forward pass tests <https://github.com/NatLabRockies/sup3r/blob/main/tests/forward_pass/test_forward_pass.py>`_ that run a simple inference on small test data. Alternatively, see the examples linked below.
#. To see previous examples of sup3r code, configs, pretrained models, and data, see our `published examples <https://github.com/NatLabRockies/sup3r/tree/main/examples>`_.
#. To setup full runs on an HPC environment, check out the sup3r command line interface `(CLI) <https://natlabrockies.github.io/sup3r/_cli/sup3r.html#sup3r>`_.


How it Works
Expand All @@ -62,7 +62,7 @@ Sup3r uses a generative machine learning approach to produce synthetic
high-resolution spatiotemporal energy resource data from coarse, low-resolution
inputs. The process is described step-by-step below.

.. image:: https://raw.githubusercontent.com/NREL/sup3r/main/docs/source/_static/Sup3rCC_Top_Graphic_v2.jpg
.. image:: https://raw.githubusercontent.com/NatLabRockies/sup3r/main/docs/source/_static/Sup3rCC_Top_Graphic_v2.jpg
:width: 750
:alt: Sup3r climate downscaling overview graphic

Expand Down Expand Up @@ -93,7 +93,7 @@ important for downstream applications such as power system operational
modeling, where fine-scale spatial structure and high-frequency temporal
dynamics matter as much as statistical accuracy.

.. image:: https://raw.githubusercontent.com/NREL/sup3r/main/docs/source/_static/Sup3r_training_flow_chart.jpg
.. image:: https://raw.githubusercontent.com/NatLabRockies/sup3r/main/docs/source/_static/Sup3r_training_flow_chart.jpg
:width: 600
:alt: Sup3r training flow chart

Expand All @@ -120,7 +120,7 @@ meteorological variables. Sup3r has been proven to generate output that
reproduces the large-scale dynamics in the data from Step 2 while capturing
realistic physics at the finest scales.

.. image:: https://raw.githubusercontent.com/NREL/sup3r/main/docs/source/_static/Sup3r_inference_flow_chart.jpg
.. image:: https://raw.githubusercontent.com/NatLabRockies/sup3r/main/docs/source/_static/Sup3r_inference_flow_chart.jpg
:width: 600
:alt: Sup3r inference flow chart

Expand All @@ -137,7 +137,7 @@ conditions. Notably, Sup3rCC does not represent real historical weather events,
unlike Sup3rWind or Sup3rUHI (described below).

To learn more about Sup3rCC, check out the publication list below or the
`Sup3rCC example <https://github.com/NREL/sup3r/tree/main/examples/sup3rcc>`_.
`Sup3rCC example <https://github.com/NatLabRockies/sup3r/tree/main/examples/sup3rcc>`_.

Sup3rWind
---------
Expand All @@ -151,7 +151,7 @@ developers worldwide.

To learn more about Sup3rWind, check out the publication list below or the
`Sup3rWind example
<https://github.com/NREL/sup3r/tree/main/examples/sup3rwind>`_.
<https://github.com/NatLabRockies/sup3r/tree/main/examples/sup3rwind>`_.

Sup3rUHI
--------
Expand All @@ -161,7 +161,7 @@ humidity time series. It supports both historical analysis and future scenario
modeling, enabling precise, data-driven planning for high-risk heat events.

To learn more about Sup3rUHI, check out the publication list below or the
`Sup3rUHI repo <https://github.com/NREL/sup3ruhi>`_.
`Sup3rUHI repo <https://github.com/NatLabRockies/sup3ruhi>`_.


Installing sup3r
Expand All @@ -178,7 +178,7 @@ Option 1: Install from PIP (recommended for analysts):

2. Activate environment: ``conda activate sup3r``

3. Install sup3r: ``pip install NREL-sup3r``
3. Install sup3r: ``pip install NLR-sup3r``

4. Run this if you want to train models on GPUs: ``pip install tensorflow[and-cuda]``

Expand All @@ -187,7 +187,7 @@ Option 1: Install from PIP (recommended for analysts):
Option 2: Clone repo (recommended for developers)
-------------------------------------------------

1. Run ``git clone git@github.com:NREL/sup3r.git``
1. Run ``git clone git@github.com:NatLabRockies/sup3r.git``
2. ``cd sup3r``.
3. Make sure the branch is correct (install from main!)
4. If you are using conda, create and activate a new environment:
Expand All @@ -207,8 +207,8 @@ Update with current version and DOI:

Brandon Benton, Grant Buster, Guilherme Pimenta Castelao, Malik Hassanaly,
Pavlo Pinchuk, Slater Podgorny, Andrew Glaws, and Ryan King. Super Resolution
for Renewable Resource Data (sup3r). https://github.com/NREL/sup3r (version
v0.2.3), 2025. https://doi.org/10.5281/zenodo.15586596
for Renewable Resource Data (sup3r). https://github.com/NatLabRockies/sup3r (version
v0.2.7), 2025. https://doi.org/10.5281/zenodo.15586596

Publications
============
Expand All @@ -234,21 +234,21 @@ https://doi.org/10.1073/pnas.1918964117
Data Records
============
Super-Resolution for Renewable Energy Resource Data with Climate Change Impacts
(Sup3rCC). [Data set]. Open Energy Data Initiative (OEDI). National Renewable
Energy Laboratory (NREL). https://doi.org/10.25984/1970814
(Sup3rCC). [Data set]. Open Energy Data Initiative (OEDI). National Laboratory of the
Rockies (NLR). https://doi.org/10.25984/1970814

Super-Resolution for Renewable Energy Resource Data with Wind from Reanalysis
(Sup3rWind). [Data set]. Open Energy Data Initiative (OEDI). National Renewable
Energy Laboratory. https://data.openei.org/submissions/8455
(Sup3rWind). [Data set]. Open Energy Data Initiative (OEDI). National Laboratory of
the Rockies. https://data.openei.org/submissions/8455

Super-Resolution for Renewable Resource Data and Urban Heat Islands (Sup3rUHI).
[Data set]. Open Energy Data Initiative (OEDI). National Renewable Energy Lab
(NREL). https://data.openei.org/submissions/6220
[Data set]. Open Energy Data Initiative (OEDI). National Laboratory of the Rockies
(NLR). https://data.openei.org/submissions/6220

Acknowledgments
===============

This work was authored by the National Renewable Energy Laboratory, operated
This work was authored by the National Laboratory of the Rockies, operated
for the U.S. Department of Energy (DOE) under Contract No. DE-AC36-08GO28308.
This research was supported by the Grid Modernization Initiative of the U.S.
Department of Energy (DOE) as part of its Grid Modernization Laboratory
Expand All @@ -262,10 +262,10 @@ Energy Security, and Emergency Response (CESER), the DOE Advanced Scientific
Computing Research (ASCR) program, the DOE Solar Energy Technologies Office
(SETO), the DOE Wind Energy Technologies Office (WETO), the United States
Agency for International Development (USAID), and the Laboratory Directed
Research and Development (LDRD) program at the National Renewable Energy
Laboratory. The research was performed using computational resources sponsored
Research and Development (LDRD) program at the National Laboratory of the Rockies.
The research was performed using computational resources sponsored
by the Department of Energy's Office of Energy Efficiency and Renewable Energy
and located at the National Renewable Energy Laboratory. The views expressed in
and located at the National Laboratory of the Rockies. The views expressed in
the article do not necessarily represent the views of the DOE or the U.S.
Government. The U.S. Government retains and the publisher, by accepting the
article for publication, acknowledges that the U.S. Government retains a
Expand Down
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
# -- Project information -----------------------------------------------------

project = 'sup3r'
copyright = '2022, Alliance for Sustainable Energy, LLC'
copyright = '2022, Alliance for Energy Innovation, LLC'
author = 'Brandon Benton, Grant Buster, Andrew Glaws, Ryan King'

pkg = os.path.dirname(os.path.abspath(os.path.dirname(__file__)))
Expand Down Expand Up @@ -122,7 +122,7 @@

html_context = {
'display_github': True,
'github_user': 'nrel',
'github_user': 'NatLabRockies',
'github_repo': 'sup3r',
'github_version': 'main',
'conf_py_path': '/docs/source/',
Expand Down
Loading
Loading