Skip to content

Commit

Permalink
Address changes to URL path
Browse files Browse the repository at this point in the history
  • Loading branch information
Edwards, Paul committed Sep 26, 2024
1 parent 93ab4ef commit ae5f32e
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 29 deletions.
9 changes: 9 additions & 0 deletions source/docs/climate/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Climate
summary: Access data services that provide access to climate resource data.
---

# <%= current_page.data.title %>
<%= current_page.data.summary %>

<%= partial("layouts/child_links") %>
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ In cases where a very large WKT value is required, e.g. downloading the maximum
```python
import requests

url = "http://developer.nrel.gov/api/solar/psm3-5min-download.json?api_key=yourapikeygoeshere"
url = "http://developer.nrel.gov/api/climate/ncdb/v2/climate/ncdb-4km-Hourly-CONUS-v1-0-0-RCP8-5-download.json?api_key=yourapikeygoeshere"

payload = "names=2012&leap_day=false&interval=60&utc=false&full_name=Honored%2BUser&email=honored.user%40gmail.com&affiliation=NREL&mailing_list=true&reason=Academic&attributes=dhi%2Cdni%2Cwind_speed_10m_nwp%2Csurface_air_temperature_nwp&wkt=MULTIPOINT(-106.22%2032.9741%2C-106.18%2032.9741%2C-106.1%2032.9741)"
payload = "names=2012&leap_day=false&interval=60&utc=false&full_name=Honored%2BUser&email=honored.user%40gmail.com&affiliation=NREL&mailing_list=true&reason=Academic&attributes=dhi%2Cdni%2Cwind_speed&wkt=MULTIPOINT(-106.22%2032.9741%2C-106.18%2032.9741%2C-106.1%2032.9741)"

headers = {
'content-type': "application/x-www-form-urlencoded",
Expand All @@ -56,7 +56,7 @@ print(response.text)
And a CURL example of the same

```shell
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Cache-Control: no-cache" -d 'names=2009&leap_day=false&interval=60&utc=false&full_name=Honored%2BUser&[email protected]&affiliation=NREL&mailing_list=true&reason=Academic&attributes=dhi%2Cdni%2Cwind_speed_10m_nwp%2Csurface_air_temperature_nwp&wkt=MULTIPOINT(-106.22 32.9741%2C-106.18 32.9741%2C-106.1 32.9741%2C-106.06 32.9741)' "http://developer.nrel.gov/api/solar/psm3-5min-download.json?api_key=yourapikeygoeshere"
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -H "Cache-Control: no-cache" -d 'names=2009&leap_day=false&interval=60&utc=false&full_name=Honored%2BUser&[email protected]&affiliation=NREL&mailing_list=true&reason=Academic&attributes=dhi%2Cdni%2Cwind_speed&wkt=MULTIPOINT(-106.22 32.9741%2C-106.18 32.9741%2C-106.1 32.9741%2C-106.06 32.9741)' "http://developer.nrel.gov/api/solar/psm3-5min-download.json?api_key=yourapikeygoeshere"
```

<h2 id="contacts">Contact</h2>
Expand Down
17 changes: 17 additions & 0 deletions source/docs/climate/ncdb/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: National Climate Database Downloads
summary: Freely available downloads of The National Climate Database.

---

# <%= current_page.data.title %>
<%= current_page.data.summary %>

The National Climate Database (NCDB) is a high-resolution, bias-corrected climate dataset including global horizontal irradiance, direct normal irradiance, and diffuse horizontal irradiance, as well as other meteorological data. Currently, the NCDB covers the contiguous United States and provides 4-km and hourly resolution climate projections under two Representative Concentration Pathways (RCP4.5 and RCP8.5) for the years from 2006-2100. The data are publicly available at no cost to the user. These API provide access to downloading the data. Other options are detailed [here](https://climate.nrel.gov/data-sets/how-to-access-data)

<%= partial("layouts/child_links") %>


## Contact

<p>For questions about the API or the data models please contact <a href="mailto:[email protected]">[email protected]</a></p>
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: "CONUS 2006-2100 60-minute, 4km, RCP4.5"
summary: ""
url: /api/nsrdb/v2/solar/ncdb-4km-Hourly-CONUS-v1-0-0-RCP4-5-download
summary: "The National Climate Database (NCDB) is a high-resolution, bias-corrected climate dataset including global horizontal irradiance, direct normal irradiance, and diffuse horizontal irradiance, as well as other meteorological data."
detail: "The NCDB is developed using a statistical downscaling approach with Regional Climate Model (RCM)-based climate projections obtained from the North American Coordinated Regional Climate Downscaling Experiment (NA-CORDEX; https://na-cordex.org/). 0.22⁰ daily climate projections simulated by the Canadian Regional Climate Model 4 (CanRCM4) forced by the second-generation Canadian Earth System Model (CanESM2) for two Representative Concentration Pathways (RCP4.5 or moderate emissions scenario and RCP8.5 or highest baseline emission scenario) are selected as inputs to the statistical downscaling models. The National Solar Radiation Database (NSRDB) (Sengupta et al. 2018) is used to build and calibrate the statistical model. For more details please visit [the NCDB](https://climate.nrel.gov)."
url: /api/climate/ncdb/v2/climate/ncdb-4km-Hourly-CONUS-v1-0-0-RCP4-5-download
---

# <%= current_page.data.title %> <span class="url">(<%= current_page.data.url %>)</span>
Expand Down Expand Up @@ -263,7 +264,7 @@ import requests

url = "http://developer.nrel.gov<%= current_page.data.url %>.json?api_key=yourapikeygoeshere"

payload = "api_key={{API_KEY}}&attributes=winddirection_180m&names=2017&utc=true&leap_day=true&interval=60&[email protected]&wkt=POINT(-179.99 -15.94)"
payload = "api_key={{API_KEY}}&names=2017&utc=true&leap_day=true&interval=60&[email protected]&wkt=POINT(-179.99 -15.94)"

headers = {
'content-type': "application/x-www-form-urlencoded",
Expand All @@ -285,7 +286,7 @@ 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/solar/nsrdb/guide/).
For some tips and tricks to maximize data downloads please read the guide [here](/docs/climate/ncdb/guide/).

<h2 id="contacts">Contact</h2>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: "CONUS 2006-2100 60-minute, 4km, RCP8.5"
summary: ""
url: /api/nsrdb/v2/solar/ncdb-4km-Hourly-CONUS-v1-0-0-RCP8-5-download
summary: "The National Climate Database (NCDB) is a high-resolution, bias-corrected climate dataset including global horizontal irradiance, direct normal irradiance, and diffuse horizontal irradiance, as well as other meteorological data."
detail: "The NCDB is developed using a statistical downscaling approach with Regional Climate Model (RCM)-based climate projections obtained from the North American Coordinated Regional Climate Downscaling Experiment (NA-CORDEX; https://na-cordex.org/). 0.22⁰ daily climate projections simulated by the Canadian Regional Climate Model 4 (CanRCM4) forced by the second-generation Canadian Earth System Model (CanESM2) for two Representative Concentration Pathways (RCP4.5 or moderate emissions scenario and RCP8.5 or highest baseline emission scenario) are selected as inputs to the statistical downscaling models. The National Solar Radiation Database (NSRDB) (Sengupta et al. 2018) is used to build and calibrate the statistical model. For more details please visit [the NCDB](https://climate.nrel.gov)."
url: /api/climate/ncdb/v2/climate/ncdb-4km-Hourly-CONUS-v1-0-0-RCP8-5-download
---

# <%= current_page.data.title %> <span class="url">(<%= current_page.data.url %>)</span>
Expand Down Expand Up @@ -56,7 +57,7 @@ _NOTE: when using POST to submit a request the api_key must still be included as
<td class="doc-parameter-value">
<div class="doc-parameter-value-field"><strong>Type:</strong> comma delimited string array</div>
<div class="doc-parameter-value-field"><strong>Default:</strong> Returns ALL</div>
<div class="doc-parameter-value-field"><strong>Options:</strong> <em>air_temperature, air_temperature_percent_change, air_temperature_raw_change, dhi, dhi_percent_change, dhi_raw_change, dni, dni_percent_change, dni_raw_change, ghi, ghi_percent_change, ghi_raw_change, solar_zenith_angle, wind_speed, wind_speed_percent_change, wind_speed_raw_change.</em></div>
<div class="doc-parameter-value-field"><strong>Options:</strong> <em>air_temperature, dhi, dni, ghi, solar_zenith_angle, wind_speed.</em></div>
</td>
<td class="doc-parameter-description">
Each specified attribute(*) will be returned as a column in the resultant CSV download.
Expand Down Expand Up @@ -213,7 +214,6 @@ Examples may not reflect this specific dataset.
{
"inputs": {
"query": {
"attributes": "winddirection_180m",
"names": "2017",
"utc": "false",
"leap_day": "true",
Expand Down Expand Up @@ -285,7 +285,7 @@ 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/solar/nsrdb/guide/).
For some tips and tricks to maximize data downloads please read the guide [here](/docs/climate/ncdb/guide/).

<h2 id="contacts">Contact</h2>

Expand Down
17 changes: 0 additions & 17 deletions source/docs/solar/ncdb/index.html.md.erb

This file was deleted.

0 comments on commit ae5f32e

Please sign in to comment.