Skip to content

First batch of nlr.gov api changes #2157

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
brtietz wants to merge 1 commit into
base: patch
Choose a base branch
from
+40 −40
Open

First batch of nlr.gov api changes #2157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 16 additions & 16 deletions deploy/runtime/webapis.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
' This Web API configuration file is a list of URLs SAM uses for NREL API web services.
' Modifying this file may cause SAM's download features to stop working.

forum=https://sam.nrel.gov/support
android_build=https://sam.nrel.gov/sites/default/files/content/mobile/android/readme.html
cambium=https://scenarioviewer.nrel.gov/api/project/detail/?uuid=0f92fe57-3365-428a-8fe8-0afc326b3b43
forum=https://sam.nlr.gov/support
android_build=https://sam.nlr.gov/sites/default/files/content/mobile/android/readme.html
cambium=https://scenarioviewer.nlr.gov/api/project/detail/?uuid=0f92fe57-3365-428a-8fe8-0afc326b3b43
google_geocode_api=https://maps.googleapis.com/maps/api/geocode/json?&sensor=false&key=<GOOGLEAPIKEY>
google_timezone_api=https://maps.googleapis.com/maps/api/timezone/json?timestamp=1&sensor=false&key=<GOOGLEAPIKEY>
google_staticmap_api=https://maps.googleapis.com/maps/api/staticmap?<CENTER>&zoom=<ZOOM>&size=800x800&maptype=hybrid&sensor=false&format=jpg-baseline&key=<GOOGLEAPIKEY>
ios_build=https://sam.nrel.gov/sites/default/files/content/mobile/ios/readme.html
nsrdb_query=https://developer.nrel.gov/api/nsrdb/v2/solar/nsrdb-data-query.json?&api_key=<SAMAPIKEY>&wkt=POINT(<LON>%20<LAT>)
release_notes=https://nrel.github.io/SAM/doc/releasenotes.html
reopt_poll=https://developer.nrel.gov/api/reopt/stable/job/<RUN_UUID>/results/?api_key=<SAMAPIKEY>
reopt_post=https://developer.nrel.gov/api/reopt/stable/job?format=json&api_key=<SAMAPIKEY>
support_email=mailto:sam.support@nrel.gov
ios_build=https://sam.nlr.gov/sites/default/files/content/mobile/ios/readme.html
nsrdb_query=https://developer.nlr.gov/api/nsrdb/v2/solar/nsrdb-data-query.json?&api_key=<SAMAPIKEY>&wkt=POINT(<LON>%20<LAT>)
release_notes=https://natlabrockies.github.io/SAM/doc/releasenotes.html
reopt_poll=https://developer.nlr.gov/api/reopt/stable/job/<RUN_UUID>/results/?api_key=<SAMAPIKEY>
reopt_post=https://developer.nlr.gov/api/reopt/stable/job?format=json&api_key=<SAMAPIKEY>
support_email=mailto:sam.support@nlr.gov
urdb_ask=https://en.openei.org/w/index.php?title=Special:Ask&q=<QUESTION>&po=<PROPERTIES>&eq=yes&p[format]=json
urdb_companies_all=https://api.openei.org/utility_companies?version=3&format=json&api_key=<SAMAPIKEY>&scope=<SCOPE>
urdb_companies_by_lat_lon=https://developer.nrel.gov/api/utility_rates/v3.json?api_key=<SAMAPIKEY>&lat=<LAT>&lon=<LON>
urdb_companies_by_lat_lon=https://developer.nlr.gov/api/utility_rates/v3.json?api_key=<SAMAPIKEY>&lat=<LAT>&lon=<LON>
urdb_rates=https://api.openei.org/utility_rates?version=8&format=json&limit=<LIMIT>&detail=<DETAIL>&offset=<OFFSET>&ratesforutility=<UTILITYNAME>&getpage=<GUID>&api_key=<APIKEY>
urdb_view_rate=https://apps.openei.org/IURDB
wave_query_west=https://developer.nrel.gov/api/wave/v2/wave/us-west-coast-hindcast-download.csv?api_key=<SAMAPIKEY>&wkt=POINT(<LON>%20<LAT>)&interval=180&email=<USEREMAIL>&attributes=significant_wave_height,energy_period&names=<YEAR>
wave_query_atlantic=https://developer.nrel.gov/api/wave/v2/wave/us-atlantic-hindcast-download.csv?api_key=<SAMAPIKEY>&wkt=POINT(<LON>%20<LAT>)&interval=180&email=<USEREMAIL>&attributes=significant_wave_height,energy_period&names=<YEAR>
wave_query_hawaii=https://developer.nrel.gov/api/wave/v2/wave/hawaii-hindcast-download.csv?api_key=<SAMAPIKEY>&wkt=POINT(<LON>%20<LAT>)&interval=180&email=<USEREMAIL>&attributes=significant_wave_height,energy_period&names=<YEAR>
wave_query_alaska=https://developer.nrel.gov/api/wave/v2/wave/alaska-hindcast-download.csv?api_key=<SAMAPIKEY>&wkt=POINT(<LON>%20<LAT>)&interval=180&email=<USEREMAIL>&attributes=significant_wave_height,energy_period&names=<YEAR>
website=https://sam.nrel.gov
windtoolkit=https://developer.nrel.gov/api/wind-toolkit/v2/wind/wtk-download.csv?&api_key=<SAMAPIKEY>&email=<USEREMAIL>&full_name=SAM%20User&affiliation=none&reason=none&wkt=POINT(<LON>%20<LAT>)&utc=false&leap_day=false&names=<YEAR>&interval=<INTERVAL>&attributes=<ATTRS>
wave_query_west=https://developer.nlr.gov/api/wave/v2/wave/us-west-coast-hindcast-download.csv?api_key=<SAMAPIKEY>&wkt=POINT(<LON>%20<LAT>)&interval=180&email=<USEREMAIL>&attributes=significant_wave_height,energy_period&names=<YEAR>
wave_query_atlantic=https://developer.nlr.gov/api/wave/v2/wave/us-atlantic-hindcast-download.csv?api_key=<SAMAPIKEY>&wkt=POINT(<LON>%20<LAT>)&interval=180&email=<USEREMAIL>&attributes=significant_wave_height,energy_period&names=<YEAR>
wave_query_hawaii=https://developer.nlr.gov/api/wave/v2/wave/hawaii-hindcast-download.csv?api_key=<SAMAPIKEY>&wkt=POINT(<LON>%20<LAT>)&interval=180&email=<USEREMAIL>&attributes=significant_wave_height,energy_period&names=<YEAR>
wave_query_alaska=https://developer.nlr.gov/api/wave/v2/wave/alaska-hindcast-download.csv?api_key=<SAMAPIKEY>&wkt=POINT(<LON>%20<LAT>)&interval=180&email=<USEREMAIL>&attributes=significant_wave_height,energy_period&names=<YEAR>
website=https://sam.nlr.gov
windtoolkit=https://developer.nlr.gov/api/wind-toolkit/v2/wind/wtk-download.csv?&api_key=<SAMAPIKEY>&email=<USEREMAIL>&full_name=SAM%20User&affiliation=none&reason=none&wkt=POINT(<LON>%20<LAT>)&utc=false&leap_day=false&names=<YEAR>&interval=<INTERVAL>&attributes=<ATTRS>
2 changes: 1 addition & 1 deletion src/casewin.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,7 +569,7 @@ bool CaseWindow::GenerateReport( wxString pdffile, wxString templfile, VarValue

if (validfiles.Count() == 0)
{
wxMessageBox( "SAM could not find any templates valid for the current technology and financing combination.\n\nPlease contact SAM user support at sam.support@nrel.gov for more information." );
wxMessageBox( "SAM could not find any templates valid for the current technology and financing combination.\n\nPlease contact SAM user support at sam.support@nlr.gov for more information." );
return false;
}

Expand Down
16 changes: 8 additions & 8 deletions src/codegenerator.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1397,7 +1397,7 @@ bool CodeGen_c::SupportingFiles()
fprintf(f, "clean :\n");
fprintf(f, " $(RM) $(PROJ_NAME)$(EXT)\n");
fprintf(f, "help:\n");
fprintf(f, " @echo \"Please check the settings for your system.Your system may not be supported.Please contact sam.support@nrel.gov\"\n");
fprintf(f, " @echo \"Please check the settings for your system.Your system may not be supported.Please contact sam.support@nlr.gov\"\n");
fclose(f);

return true;
Expand Down Expand Up @@ -4732,7 +4732,7 @@ bool CodeGen_java::SupportingFiles()
fprintf(f, "clean :\n");
fprintf(f, " $(RM) $(RM_ALL) $(RM_JAVA)\n");
fprintf(f, "help:\n");
fprintf(f, " @echo \"Please check the settings for your system.Your system may not be supported.Please contact sam.support@nrel.gov.System: $(PF) $(VERS)\"\n");
fprintf(f, " @echo \"Please check the settings for your system.Your system may not be supported.Please contact sam.support@nlr.gov.System: $(PF) $(VERS)\"\n");
fclose(f);
// Manifest file to define main class
fn = m_folder + "/" + m_name + ".Manifest.txt";
Expand Down Expand Up @@ -5649,7 +5649,7 @@ bool CodeGen_php5::SupportingFiles()
fprintf(f, " rm sscphp.dylib\n");
fprintf(f, "\n");
fprintf(f, "help:\n");
fprintf(f, " @echo \"Please check the settings for your system.Your system may not be supported.Please contact sam.support@nrel.gov.System: $(PF) $(VERS)\"\n");
fprintf(f, " @echo \"Please check the settings for your system.Your system may not be supported.Please contact sam.support@nlr.gov.System: $(PF) $(VERS)\"\n");
fclose(f);
return true;
#elif defined(__WXGTK__)
Expand Down Expand Up @@ -5681,7 +5681,7 @@ bool CodeGen_php5::SupportingFiles()
fprintf(f, " rm sscphp.so\n");
fprintf(f, "\n");
fprintf(f, "help:\n");
fprintf(f, " @echo \"Please check the settings for your system.Your system may not be supported.Please contact sam.support@nrel.gov.System: $(PF) $(VERS)\"\n");
fprintf(f, " @echo \"Please check the settings for your system.Your system may not be supported.Please contact sam.support@nlr.gov.System: $(PF) $(VERS)\"\n");
fclose(f);
return true;
#else
Expand Down Expand Up @@ -6313,7 +6313,7 @@ bool CodeGen_php7::SupportingFiles()
fprintf(f, " rm sscphp.so\n");
fprintf(f, "\n");
fprintf(f, "help:\n");
fprintf(f, " @echo \"Please check the settings for your system.Your system may not be supported.Please contact sam.support@nrel.gov.System: $(PF) $(VERS)\"\n");
fprintf(f, " @echo \"Please check the settings for your system.Your system may not be supported.Please contact sam.support@nlr.gov.System: $(PF) $(VERS)\"\n");
fclose(f);
return true;
#else
Expand Down Expand Up @@ -6946,7 +6946,7 @@ bool CodeGen_php8::SupportingFiles()
fprintf(f, " rm sscphp.so\n");
fprintf(f, "\n");
fprintf(f, "help:\n");
fprintf(f, " @echo \"Please check the settings for your system.Your system may not be supported.Please contact sam.support@nrel.gov.System: $(PF) $(VERS)\"\n");
fprintf(f, " @echo \"Please check the settings for your system.Your system may not be supported.Please contact sam.support@nlr.gov.System: $(PF) $(VERS)\"\n");
fclose(f);
return true;
#else
Expand Down Expand Up @@ -7822,7 +7822,7 @@ bool CodeGen_ios::SupportingFiles()
{
// for iOS
wxString url = SamApp::WebApi("ios_build");
if (url.IsEmpty()) url = "https://sam.nrel.gov";
if (url.IsEmpty()) url = "https://sam.nlr.gov";
wxLaunchDefaultBrowser( url );

#if defined(__WXMSW__)
Expand Down Expand Up @@ -8290,7 +8290,7 @@ bool CodeGen_android::SupportingFiles()
fclose(f);
// library files - in readme
wxString url = SamApp::WebApi("android_build");
if (url.IsEmpty()) url = "https://sam.nrel.gov/";
if (url.IsEmpty()) url = "https://sam.nlr.gov/";
wxLaunchDefaultBrowser( url );

#if defined(__WXMSW__)
Expand Down
2 changes: 1 addition & 1 deletion src/main_add.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ bool SamApp::OnInit()
/*wxMSWSetupExceptionHandler(
wxString("SAM"),
SamApp::VersionStr(),
wxString("sam.support@nrel.gov") );
wxString("sam.support@nlr.gov") );
*/
#endif

Expand Down
20 changes: 10 additions & 10 deletions src/nsrdb.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -583,7 +583,7 @@ void NSRDBDialog::GetResources()
}

// NSRDB Data Query returns a list of links to all available files for a location
// https://developer.nrel.gov/docs/solar/nsrdb/nsrdb_data_query/
// https://developer.nlr.gov/docs/solar/nsrdb/nsrdb_data_query/
wxString url;
url = SamApp::WebApi("nsrdb_query");
url.Replace("<LAT>", wxString::Format("%lg", lat), 1);
Expand Down Expand Up @@ -684,15 +684,15 @@ void NSRDBDialog::GetResources()

/*
datasets have different available intervals in addition to 60 (all datasets have 60 minute data):
psm3 https://developer.nrel.gov/docs/solar/nsrdb/psm3-download/ 30
psm3-2-2 https://developer.nrel.gov/docs/solar/nsrdb/psm3-2-2-download/ 30
nsrdb-GOES-aggregated-v4-0-0 https://developer.nrel.gov/api/nsrdb/v2/solar/nsrdb-GOES-aggregated-v4-0-0-download 30
psm3-5min https://developer.nrel.gov/docs/solar/nsrdb/psm3-5min-download/ 5,15,30
suny-india https://developer.nrel.gov/docs/solar/nsrdb/suny-india-data-download/ 15,30
msg-iodc https://developer.nrel.gov/docs/solar/nsrdb/meteosat-download/ 15,30
msg-v1-0-0 https://developer.nrel.gov/docs/solar/nsrdb/nsrdb-msg-v1-0-0-download/ 15,30
himawari https://developer.nrel.gov/docs/solar/nsrdb/himawari-download/ 10,30
himawari7 https://developer.nrel.gov/docs/solar/nsrdb/himawari7-download/ 30
psm3 https://developer.nlr.gov/docs/solar/nsrdb/psm3-download/ 30
psm3-2-2 https://developer.nlr.gov/docs/solar/nsrdb/psm3-2-2-download/ 30
nsrdb-GOES-aggregated-v4-0-0 https://developer.nlr.gov/api/nsrdb/v2/solar/nsrdb-GOES-aggregated-v4-0-0-download 30
psm3-5min https://developer.nlr.gov/docs/solar/nsrdb/psm3-5min-download/ 5,15,30
suny-india https://developer.nlr.gov/docs/solar/nsrdb/suny-india-data-download/ 15,30
msg-iodc https://developer.nlr.gov/docs/solar/nsrdb/meteosat-download/ 15,30
msg-v1-0-0 https://developer.nlr.gov/docs/solar/nsrdb/nsrdb-msg-v1-0-0-download/ 15,30
himawari https://developer.nlr.gov/docs/solar/nsrdb/himawari-download/ 10,30
himawari7 https://developer.nlr.gov/docs/solar/nsrdb/himawari7-download/ 30
*/

#ifdef __DEBUG__
Expand Down
2 changes: 1 addition & 1 deletion src/private.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ static const char *version_label = 0; //"iscc-ge";

// NREL Developer API:
// For calls to NREL Developer APIs for weather file downloads, REopt calls, etc.
// Get an API key at https://developer.nrel.gov
// Get an API key at https://developer.nlr.gov
const char *sam_api_key = "";

// Email address used to register for NREL Developer API
Expand Down
2 changes: 1 addition & 1 deletion src/s3tool.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2411,7 +2411,7 @@ void ShadeTool::OnCommand( wxCommandEvent &evt)
case ID_VIEW_XY: m_book->SetSelection( PG_SCENE ); m_view->SetMode( m_view->TOP_VIEW ); break;
case ID_VIEW_XZ: m_book->SetSelection( PG_SCENE ); m_view->SetMode( m_view->Z_VIEW ); break;
case ID_FEEDBACK:
wxLaunchDefaultBrowser( "mailto://sam.support@nrel.gov?subject=Shade Calculator - Beta Feedback" );
wxLaunchDefaultBrowser( "mailto://sam.support@nlr.gov?subject=Shade Calculator - Beta Feedback" );
break;
case wxID_HELP:
#ifdef S3D_STANDALONE
Expand Down
2 changes: 1 addition & 1 deletion src/urdb.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ bool OpenEI::QueryUtilityCompaniesbyZipcode(const wxString &zipcode, wxArrayStri
return false;
}

// NREL Developer API to list utility companies by lat/lon https://developer.nrel.gov/docs/electricity/utility-rates-v3/
// NREL Developer API to list utility companies by lat/lon https://developer.nlr.gov/docs/electricity/utility-rates-v3/
wxString url = SamApp::WebApi("urdb_companies_by_lat_lon");
url.Replace("<LAT>", wxString::Format("%f",lat));
url.Replace("<LON>", wxString::Format("%f",lon));
Expand Down
2 changes: 1 addition & 1 deletion src/welcome.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ void WelcomeScreen::RunWelcomeScript( const wxString &script )
env.register_funcs( lk::stdlib_basic() );

// note: do not register SYSIO functions to improve security when running
// LK code downloaded directly from sam.nrel.gov in the welcome window
// LK code downloaded directly from sam.nlr.gov in the welcome window

env.register_funcs( lk::stdlib_string() );
env.register_funcs( lk::stdlib_math() );
Expand Down
Loading