diff --git a/source/docs/climate/sup3rcc/sup3rcc-conus-ecearth3-ssp585-r1i1p1f1-download.html.md.erb b/source/docs/climate/sup3rcc/sup3rcc-conus-ecearth3-ssp585-r1i1p1f1-download.html.md.erb deleted file mode 100755 index 4262f727..00000000 --- a/source/docs/climate/sup3rcc/sup3rcc-conus-ecearth3-ssp585-r1i1p1f1-download.html.md.erb +++ /dev/null @@ -1,316 +0,0 @@ ---- -title: Sup3rCC CONUS EC-Earth3 SSP585 r1i1p1f1 -summary: The Super-Resolution for Renewable Energy Resource Data with Climate Change Impacts (Sup3rCC) data is a collection of 4km hourly wind, solar, temperature, humidity, and pressure fields for the contiguous United States under various climate change scenarios. Learn more about the Sup3rCC dataset [at the GitHub repository](https://github.com/openEDI/documentation/blob/main/Sup3rCC.md) and in [this article](https://www.nlr.gov/news/detail/features/2024/nrel-unveils-groundbreaking-generative-machine-learning-model-to-simulate-future-energy-climate-impacts). -detail: "Sup3rCC is downscaled Global Climate Model (GCM) data. The downscaling process was performed using a generative machine learning approach called sup3r: Super-Resolution for Renewable Energy Resource Data. The data includes both historical and future weather years, although the historical years represent the historical climate, not the actual historical weather that we experienced. You cannot use Sup3rCC data to study historical weather events, although other sup3r datasets may be intended for this.
-
-The Sup3rCC data is intended to help researchers study the impact of climate change on energy systems with high levels of wind and solar capacity. Please note that all climate change data is only a representation of the possible future climate and contains significant uncertainty. Analysis of multiple climate change scenarios and multiple climate models can help quantify this uncertainty.
-
-Access to the entire Sup3rCC dataset as a single bulk download is available at [The Registry of Open Data on AWS](https://registry.opendata.aws/nrel-pds-sup3rcc/)." -url: /api/climate/ncdb/v2/climate/sup3rcc-conus-ecearth3-ssp585-r1i1p1f1-download ---- - -# <%= current_page.data.title %> (<%= current_page.data.url %>) -<%= current_page.data.summary %> - -<%= current_page.data.detail %> - - - -## Request URL - -
GET|POST <%= current_page.data.url %>.format?parameters
- -## Request Parameters -_NOTE: when using POST to submit a request the api_key must still be included as a query parameter in the url. All other parameters may be included in a POST request as part of the payload._ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterRequiredValueDescription
api_keyYes -
Type: string
-
Default: None
- 		-

Your developer API key. See API keys for more information.

-
wktYes -
Type: well-known text string
-
Default: None
- 		- A well-known text (WKT) representation of the geometry for which to extract data. May be a point, multipoint, or polygon geometry. When a point is passed the site nearest to that point is used. When a multipoint is passed the site nearest each point is used. This can be useful for downloading multiple sites in a single request when those sites are geographically distant from each other. When a polygon is passed all sites that intersect with the given polygon are used. -
attributesNo -
Type: comma delimited string array
-
Default: Returns ALL
-
Options: pressure_0m, dhi, dni, ghi, relativehumidity_2m, temperature_2m, winddirection_10m, winddirection_100m, winddirection_200m, windspeed_10m, windspeed_100m, windspeed_200m.
- 		- Each specified attribute(*) will be returned as a column in the resultant CSV download. -
namesYes -
Type: comma delimited string array
-
Default: None
-
Options: 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024, 2025, 2026, 2027, 2028, 2029, 2030, 2031, 2032, 2033, 2034, 2035, 2036, 2037, 2038, 2039, 2040, 2041, 2042, 2043, 2044, 2045, 2046, 2047, 2048, 2049, 2050, 2051, 2052, 2053, 2054, 2055, 2056, 2057, 2058, 2059.
- 		The year(s) for which data should be extracted.
utcNo -
Type: true or false
-
Default: true
- 		- Pass true to retrieve data with timestamps in UTC. Pass false to retrieve data with timestamps converted to local time of data point (without daylight savings time). -
leap_dayNo -
Type: true or false
-
Default: false
- 		- Pass true to retrieve data including leap day (where appropriate). Pass false to retrieve data excluding leap day. -
intervalYes -
Type:60
-
Default: None
- 		- This value determines data resolution. Either 60 minute intervals are available. -
full_nameNo -
Type: string
-
Default: None
- 		The full name of the user requesting data.
emailYes -
Type: email string
-
Default: None
- 		- An active email for the user requesting data. This email will be used to deliver the extracted data. -
affiliationNo -
Type: string
-
Default: None
- 		- The organization with which the user requesting the data is affiliated. -
reasonNo -
Type: string
-
Default: None
- 		The reason that the user is requesting the data.
mailing_listNo -
Type: true or false
-
Default: false
- 		- Pass true to add the email address to our list of recipients for the NSRDB mailing list. -
- -## Response Fields - -The response is composed of service-related informational fields and the results of the data query. - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldValueDescription
errors -
Type: string array
- 		-

A list of error messages

-
inputs -
Type: Object Hash
- 		Key: Value pairs representing all input parameters
outputs -
Type: Object Hash
- 		Upon successful completion a message will be returned informing the user that file generation is in progress and an email will be sent to the address provided in the email input field when the download is ready
- -## Data File Format - -Generated data files are formatted in accordance with the Standard Time Series Data File Format. This file format has been developed to support [SAM](https://sam.nrel.gov/) and other NLR models and is documented fully in [this PDF](https://sam.nrel.gov/sites/default/files/content/documents/pdf/wfcsv.pdf). More information on SAM file formats available on [the SAM weather page](https://sam.nrel.gov/weather). - -## Examples -Examples may not reflect this specific dataset. - -### JSON Output Format - -
GET <%= current_page.data.url %>.json?email=user@company.com&wkt=POINT%28-106.19569217545038+42.53470991129683%29&names=2015&interval=60&API_KEY=yourkeyhere
- -```JSON -{ - "inputs": { - "body": {}, - "params": { - "0": ".json" - }, - "query": { - "email": "user@company.com", - "wkt": "POINT(-106.19569217545038 42.53470991129683)", - "names": "2015", - "interval": "60" - } - }, - "metadata": { - "version": "2.0.0", - "resultset": { - "count": 1 - } - }, - "status": 200, - "outputs": { - "message": "File generation in progress. An email will be sent to user@company.com when the download is ready.", - "downloadUrl": "https://mapfiles.nrel.gov/data/climate/2d29176785d664638c792d360ee6f26e.zip" - }, - "errors": [] -} -``` - -### CSV Output Format -Direct streaming of CSV data is supported for single location, single year only. The following response example is truncated after the first few rows of data. - -
GET <%= current_page.data.url %>.csv?email=user@company.com&wkt=POINT%28-106.19569217545038+42.53470991129683%29&names=2015&interval=60&API_KEY=yourkeyhere
- -```csv -Source,Location ID,City,County,State,Country,Offshore,EEZ,Latitude,Longitude,Time Zone,Elevation,Local Time Zone,GHI Units,DNI Units,DHI Units,Temperature Units,Wind Speed Units,Relative Humidity Units,Wind Direction Units,Version -Sup3rCC,711511,-,Natrona,Wyoming,United States,0,1,42.540253,-106.2,0,2246,-7,W/m2,W/m2,W/m2,Celsius,m/s,Percent,Degrees,0.1.0 -Year,Month,Day,Hour,Minute,surface air pressure (Pa),DHI,DNI,GHI,relative humidity at 2m (%),air temperature at 2m (Celsius),wind direction at 10m (degrees),wind direction at 100m (degrees),wind direction at 200m (degrees),wind speed at 10m (m/s),wind speed at 100m (m/s),wind speed at 200m (m/s) -2015,1,1,0,0,776.5,0,0,0,61.04,-6.94,241.88,244.99,241.55,10.77,13.96,15.39 -2015,1,1,1,0,776.6,0,0,0,60.76,-6.48,246.73000000000002,247.36,254.1,9.99,13.870000000000001,14.92 -2015,1,1,2,0,776.7,0,0,0,62.410000000000004,-6.41,258.23,257.06,255.58,7.23,11.18,12.040000000000001 -2015,1,1,3,0,776.8,0,0,0,66.2,-7.57,263.61,256.44,254.06,7.0600000000000005,12.1,12.88 -2015,1,1,4,0,777,0,0,0,70.43,-7.4,251.83,249.70000000000002,249.87,8.21,13.98,15.870000000000001 -2015,1,1,5,0,777.1,0,0,0,72.97,-7.36,243.21,245.27,245.03,8.49,13.9,16.41 -... -``` - -### POST request example in Python - -```python -import requests - -url = "http://developer.nrel.gov<%= current_page.data.url %>.json?api_key=yourapikeygoeshere" - -payload = "email=user@company.com&wkt=POINT%28-106.19569217545038+42.53470991129683%29&names=2015&interval=60" - -headers = { - 'content-type': "application/x-www-form-urlencoded", - 'cache-control': "no-cache" -} - -response = requests.request("POST", url, data=payload, headers=headers) - -print(response.text) -``` - -

Rate Limits

- -Rate limits for this application are significantly less than the [standard rate limits](/docs/rate-limits){:target="_blank"} for developer.nrel.gov. This decrease in the limit is required as the data provided through this service is significantly more computationally intensive to generate and provide. These rate limits are carefully calculated to allow all users the maximum throughput that our servers can sustain. - -There are several levels of rate limiting for this service. The first limit determines how many requests a given user can make per 24 hour period. For requests utilizing the .csv format this rate limit is set at 10,000 a day at a frequency of no more than 1 per second. For all other requests this limit is set at 2000 requests per day at a frequency of no more than 1 every 2 seconds. - -Secondly each user is limited to 20 in-flight requests at any given time. - -In addition, the service has a fail-safe mechanism to prevent significant performance decreases that can be caused by unexpectedly high usage of the service. This limit will cause the service to stop accepting requests when the queue reaches a point where additional requests will significantly lower server performance. When this limit is hit, the service will error with a message describing that the request queue is full. - -For some tips and tricks to maximize data downloads please read the guide [here](/docs/climate/guide/). - -

Contact

- -

For questions about the API or the data models please contact ncdb@nlr.gov

- -

Errors

- -

Standard errors may be returned. In addition, the following service-specific errors may be returned:

- - - - - - - - - - - - - - -
HTTP Status CodeDescription
400Bad Request: When required parameters are missing.