The National Solar Radiation Database (NSRDB) software includes all the methods for the irradiance data processing pipeline. To get started, check out the NSRDB command line interface (CLI). Refer to the NREL website and the original journal article for more information on the NSRDB. For details on NSRDB variable units, datatypes, and attributes, see the NSRDB variable meta data.
The PXS All-Sky Irradiance Model
The PXS All-Sky Irradiance Model is the main physics package that calculates surface irradiance variables.
The NSRDB Data Model
The NSRDB Data Model is the data aggregation framework that sources, processes, and prepares data for input to All-Sky.
The MLClouds Model
The MLClouds Model is used to predict missing cloud properties (a.k.a. Gap Fill). The NSRDB interface with MLClouds can be found here.
Installation
Option 1: Install from PIP (recommended for analysts):
Create a new environment: conda create --name nsrdb python=3.9
Activate environment: conda activate nsrdb
Install nsrdb: pip install NREL-nsrdb
Option 2: Clone repo (recommended for developers)
from home dir, git clone git@github.com:NREL/nsrdb.git
- Create nsrdb environment and install package
Create a conda env: conda create -n nsrdb
Run the command: conda activate nsrdb
cd into the repo cloned in 1.
Prior to running pip below, make sure the branch is correct (install from main!)
Install nsrdb and its dependencies by running: pip install . (or pip install -e . if running a dev branch or working on the source code)
Optional: Set up the pre-commit hooks with pip install pre-commit and pre-commit install
NSRDB Versions
Version |
Effective Date |
Data Years* |
Notes |
|---|---|---|---|
4.1.1 |
10/28/24 |
None |
Integration with extended MLClouds models. Extended models can perform both cloud type and cloud property predictions. |
4.1.0 |
7/9/24 |
None |
Complete CLI refactor. |
4.0.0 |
5/1/23 |
GOES: 1998-2023. Meteosat: 2005-2022. |
Integrated an improved direct normal irradiance model (FARMS-DNI), described in the paper “Integration of a physics-based direct normal irradiance (DNI) model to enhance the National Solar Radiation Database (NSRDB)” |
3.2.3 |
4/13/23 |
None |
Fixed MERRA interpolation issue #51 and deprecated python 3.7/3.8. Added changes to accommodate pandas v2.0.0. |
3.2.2 |
2/25/2022 |
1998-2021 |
Implemented a model for snowy albedo as a function of temperature from MERRA2 based on the paper “A comparison of simulated and observed fluctuations in summertime Arctic surface albedo” by Becky Ross and John E. Walsh |
3.2.1 |
1/12/2021 |
2021 |
Implemented an algorithm to re-map the parallax and shading corrected cloud coordinates to the nominal GOES coordinate system. This fixes the issue of PC cloud coordinates conflicting with clearsky coordinates. This also fixes the strange pattern that was found in the long term means generated from PC data. |
3.2.0 |
3/17/2021 |
2020 |
Enabled cloud solar shading coordinate adjustment by default, enabled MLClouds machine learning gap fill method for missing cloud properties (cloud fill flag #7) |
3.1.2 |
6/8/2020 |
2020 |
Added feature to adjust cloud coordinates based on solar position and shading geometry. |
3.1.1 |
12/5/2019 |
2018+, TMY/TDY/TGY-2018 |
Complete refactor of TMY processing code. |
3.1.0 |
9/23/2019 |
2018+ |
Complete refactor of NSRDB processing code for NSRDB 2018 |
3.0.6 |
4/23/2019 |
1998-2017 |
Missing data for all cloud properties gap filled using heuristics method |
3.0.5 |
4/8/2019 |
1998-2017 |
Cloud pressure attributes and scale/offset fixed for 2016 and 2017 |
3.0.4 |
3/29/2019 |
1998-2017 |
Aerosol optical depth patched with physical range from 0 to 3.2 |
3.0.3 |
2/25/2019 |
1998-2017 |
Wind data recomputed to fix corrupted data in western extent |
3.0.2 |
2/25/2019 |
1998-2017 |
Air temperature data recomputed from MERRA2 with elevation correction |
3.0.1 |
2018 |
2017+ |
Moved from timeshift of radiation to timeshift of cloud properties. |
3.0.0 |
2018 |
1998-2017 |
Initial release of PSM v3
|
2.0.0 |
2016 |
1998-2015 |
Initial release of PSM v2 (use of FARMS, downscaling of ancillary data introduced to account for elevation, NSRDB website distribution developed)
|
1.0.0 |
2015 |
2005-2012 |
Initial release of PSM v1 (no FARMS)
|
Recommended Citation
Update with current version and DOI:
Grant Buster, Brandon Benton, Mike Bannister, Yu Xie, Aron Habte, Galen Maclaurin, Manajit Sengupta. National Solar Radiation Database (NSRDB). https://github.com/NREL/nsrdb (version v4.0.0), 2023. DOI: 10.5281/zenodo.10471523
Acknowledgments
This work (SWR-23-77) was authored by the National Renewable Energy Laboratory, operated by Alliance for Sustainable Energy, LLC, for the U.S. Department of Energy (DOE) under Contract No. DE-AC36-08GO28308. Funding provided by the DOE Grid Deployment Office (GDO), 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 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 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 nonexclusive, paid-up, irrevocable, worldwide license to publish or reproduce the published form of this work, or allow others to do so, for U.S. Government purposes.
*Note: The “Data Years” column shows which years of NSRDB data were updated at the time of version release. However, each NSRDB file should be checked for the version attribute, which should be a more accurate record of the actual data version.
2 maintainers
Metadata
2 maintainers
Release files for NREL-nsrdb 4.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nrel_nsrdb-4.1.2-py3-none-any.whl | Python 3 | none | any | Details |
Release files / nrel_nsrdb-4.1.2-py3-none-any.whl
| Download URL | nrel_nsrdb-4.1.2-py3-none-any.whl |
|---|---|
| Size | 10.0 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
39854c11e5a9831fe3c638f95babfd2a7faff4f4da9d5e65aab9aecb467e0920
|
|
BLAKE2b-256 checksum How to use checksums |
91987c766b5435dee89a5bcae06f5520b5557a2ede4d87eb4272e1e1662dc37f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 25, 2025.
Transparency log
