Skip to content

Update default tmy endpoint from NSRDB fetcher #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mjprilliman wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Update default tmy endpoint from NSRDB fetcher #202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8e5a83a
Update default tmy endpoint from NSRDB fetcher
mjprilliman Nov 7, 2025
70668ac
Update function descriptions, examples
mjprilliman Nov 7, 2025
dc183d6
Add back geocoder
mjprilliman Nov 7, 2025
b16587d
Update tests
mjprilliman Nov 7, 2025
908c574
Update NSRDB endpoint descriptions
cpaulgilman Nov 17, 2025
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
4 changes: 3 additions & 1 deletion Examples/FetchResourceFileExample.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@

import geocoder


# replace with key and email address from https://developer.nrel.gov/signup/
sam_api_key = os.environ.get('NREL_API_KEY')
sam_email = os.environ.get('NREL_API_EMAIL')
Expand All @@ -39,7 +40,7 @@
lat = g.latlng[0]
else:
lon = -105.22
lat = 39.75
lat = 45

# --- Wind Example ---

Expand Down Expand Up @@ -83,6 +84,7 @@
nsrdbfetcher = tools.FetchResourceFiles(
tech='solar',
nrel_api_key=sam_api_key,
resource_type = 'nsrdb-GOES-tmy-v4-0-0',
nrel_api_email=sam_email)

# --- List of (lon, lat) tuples or Shapely points ---
Expand Down
1 change: 1 addition & 0 deletions Examples/nsrdb_data_query_response_39.75_-105.22.json
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion Examples/nsrdb_data_query_response_39.7_-105.1.json
View file
Open in desktop

This file was deleted.

20 changes: 10 additions & 10 deletions files/ResourceTools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,18 +315,18 @@ class FetchResourceFiles():
Default = 1.

:param str resource_type: Name of API for NSRDB solar data.
Default = 'psm3-tmy' for solar, '' for wind.
'psm3' for 30- or 60-minute single-year file
'psm3-tmy' for 60-minute TMY, TGY, or TDY typical-year file
'psm3-5min' for 5-, 30- or 60-minute single-year file
Default = 'nsrdb-GOES-tmy-v4-0-0' for solar, '' for wind.
'nsrdb-GOES-aggregated-v4-0-0' for 30- or 60-minute single-year file
'nsrdb-GOES-conus-v4-0-0' for 5-, 15-, 30- or 60-minute single-year file in CONUS region
'nsrdb-GOES-full-disc-v4-0-0' for 10-, 30- or 60-minute single-year file in GOES satellite coverage area
'nsrdb-GOES-tmy-v4-0-0' for 60-minute TMY, TGY, or TDY typical-year file
'' for WIND Toolkit

:param str resource_year: Data year, changes over time so check API documentation for latest information.
Default = 'tmy' for solar, '2014' for wind.
'1998' to '2019', etc. for NSRDB psm3
'tmy' for latest TMY file from NSRDB psm3-tmy
'tmy-2016' to 'tmy-2018', etc. for NSRDB psm3-tmy
'2018', etc. for NSRDB psm3-5min
'1998' to '2024' for specific year from NSRDB nsrdb-GOES-aggregated-v4-0-0
'tmy' for latest TMY file from NSRDB nsrdb-GOES-tmy-v4-0-0
'tmy-2022' to 'tmy-2024' for specific TMY year from NSRDB nsrdb-GOES-tmy-v4-0-0
'2007' to '2014' for WIND Toolkit

:param int resource_interval_min: Time interval of resource data in minutes. See available intervals under `resource_type` above.
Expand All @@ -340,7 +340,7 @@ class FetchResourceFiles():

def __init__(self, tech, nrel_api_key, nrel_api_email,
workers=1,
resource_type='psm3-tmy',
resource_type='nsrdb-GOES-tmy-v4-0-0',
resource_year='tmy',
resource_interval_min=60,
resource_height=100,
Expand All @@ -360,7 +360,7 @@ def __init__(self, tech, nrel_api_key, nrel_api_email,

# for backward compatibility
if resource_type == 'tmy':
resource_type = 'psm3-tmy'
resource_type = 'nsrdb-GOES-tmy-v4-0-0'
resource_year = str(resource_year)
if tech == 'pv':
tech = 'solar'
Expand Down
10 changes: 5 additions & 5 deletions tests/test_ResourceTools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ def test_resourcefilefetcher():
nrel_api_key=NREL_API_KEY,
nrel_api_email=NREL_API_EMAIL,
resource_dir=resource_dir,
resource_type='psm3',
resource_type='nsrdb-GOES-aggregated-v4-0-0',
resource_year='2018',
resource_interval_min=30)
solarfetcher.fetch(lon_lats)
Expand All @@ -151,14 +151,14 @@ def test_resourcefilefetcher():
num_timesteps = 17520
assert solar_csv.line_num == num_timesteps + 3

# --- fetch solar tgy for 2018 from psm3-tmy ---
# --- fetch solar tgy for 2018 from nsrdb-GOES-tmy-v4-0-0 ---
solarfetcher = tools.FetchResourceFiles(
tech='solar',
nrel_api_key=NREL_API_KEY,
nrel_api_email=NREL_API_EMAIL,
resource_dir=resource_dir,
resource_type='psm3-tmy',
resource_year='tgy-2018')
resource_type='nsrdb-GOES-tmy-v4-0-0',
resource_year='tgy-2024')
solarfetcher.fetch(lon_lats)

# --- read csv and confirm dimensions ---
Expand All @@ -170,7 +170,7 @@ def test_resourcefilefetcher():
num_timesteps = 8760
assert solar_csv.line_num == num_timesteps + 3

# --- fetch 5-minute data for 2018 from psm3-5min ---
# --- fetch 5-minute data for 2018 from psm4-5min ---
# this NSRDB API endpoint not working properly as of 8/21/2020
#solarfetcher = tools.FetchResourceFiles(
# tech='solar',
Expand Down
Loading