Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# developer.nrel.gov
# developer.nlr.gov

Have questions, feedback, or issues with the APIs available at [developer.nrel.gov](https://developer.nrel.gov/)? [Contact us](https://developer.nrel.gov/contact/) or let us know in the [issue tracker](https://github.com/NatLabRockies/developer.nrel.gov/issues).
Have questions, feedback, or issues with the APIs available at [developer.nlr.gov](https://developer.nlr.gov/)? [Contact us](https://developer.nlr.gov/contact/) or let us know in the [issue tracker](https://github.com/NatLabRockies/developer.nrel.gov/issues).

This repository stores the website content and documentation for [developer.nrel.gov](https://developer.nrel.gov). Contributions are welcome. To submit a change, fork this repo, commit your changes, and send us a [pull request](https://help.github.com/articles/using-pull-requests).
This repository stores the website content and documentation for [developer.nlr.gov](https://developer.nlr.gov). Contributions are welcome. To submit a change, fork this repo, commit your changes, and send us a [pull request](https://help.github.com/articles/using-pull-requests).

## Development

The content files to edit are in [`./source`](https://github.com/NatLabRockies/developer.nrel.gov/tree/master/source). To preview your changes you can use the [Middleman](https://middlemanapp.com) preview server. To run Middleman:

1. Install [Docker](https://www.docker.com/products/docker-desktop/) on your computer.
2. Checkout the `developer.nrel.gov` repository on your computer (`git clone https://github.com/NatLabRockies/developer.nrel.gov.git`).
2. Checkout the `developer.nlr.gov` repository on your computer (`git clone https://github.com/NatLabRockies/developer.nrel.gov.git`).
3. For NLR employees on the NLR network: Add a `docker-compose.override.yml`, with the following contents, but substituting `REPLACE_ME` with the appropriate URL (reach out to a maintainer for this value):

```yaml
Expand All @@ -20,7 +20,7 @@ The content files to edit are in [`./source`](https://github.com/NatLabRockies/d
NREL_ROOT_CERT_URL_ROOT: "REPLACE_ME"
```

4. Inside the `developer.nrel.gov` directory, run `docker compose up`.
4. Inside the `developer.nlr.gov` directory, run `docker compose up`.
5. View your changes at: http://localhost:4480/

### Linting
Expand Down
2 changes: 1 addition & 1 deletion config.rb
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ def loader
end

def make_request(path, params = {country: "all", api_key: ENV["DOCS_API_KEY"]})
MultiJson.load(RestClient.get("https://developer.nrel.gov/api/alt-fuel-stations/v1/#{path}.json", params: params))
MultiJson.load(RestClient.get("https://developer.nlr.gov/api/alt-fuel-stations/v1/#{path}.json", params: params))
end
end

Expand Down
2 changes: 1 addition & 1 deletion frontend/entrypoints/contact.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ formEl.addEventListener("submit", (event) => {
}, 0);

const hostname = window.location.hostname;
const apiHost = (hostname === 'developer.nrel.gov') ? 'developer.nrel.gov' : 'devstage.nrel.gov';
const apiHost = (hostname === 'developer.nlr.gov') ? 'developer.nlr.gov' : 'devstage.nlr.gov';

return fetch(`https://${apiHost}/api/contactor/v1.json?` + new URLSearchParams({
api_key: options.apiKey,
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "developer.nrel.gov",
"name": "developer.nlr.gov",
"version": "0.0.0",
"private": true,
"type": "module",
Expand Down
8 changes: 4 additions & 4 deletions source/docs/api-key.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ After [signing up](/signup), you'll be given your own, unique API key. This 40 c
To use your key, simply pass the key as a URL query parameter when making web service requests. For example:

```
GET https://developer.nrel.gov/api/alt-fuel-stations/v1.json?limit=1&api_key=YOUR_KEY_HERE
GET https://developer.nlr.gov/api/alt-fuel-stations/v1.json?limit=1&api_key=YOUR_KEY_HERE
```

## Ways to Pass Your API Key
Expand All @@ -27,15 +27,15 @@ Your API key may be passed to the service in a few different ways. Pick which ev
Pass the API key into the `X-Api-Key` header:

```sh
curl -H 'X-Api-Key: DEMO_KEY' 'https://developer.nrel.gov/api/alt-fuel-stations/v1.json?limit=1'
curl -H 'X-Api-Key: DEMO_KEY' 'https://developer.nlr.gov/api/alt-fuel-stations/v1.json?limit=1'
```

### GET Query Parameter

Pass the API key into the `api_key` GET query string parameter:

```sh
curl 'https://developer.nrel.gov/api/alt-fuel-stations/v1.json?limit=1&api_key=YOUR_KEY_HERE'
curl 'https://developer.nlr.gov/api/alt-fuel-stations/v1.json?limit=1&api_key=YOUR_KEY_HERE'
```

*Note:* The GET query parameter may be used for non-GET requests (such as POST and PUT).
Expand All @@ -45,5 +45,5 @@ curl 'https://developer.nrel.gov/api/alt-fuel-stations/v1.json?limit=1&api_key=Y
As an alternative, pass the API key as the username (with an empty password) using HTTP basic authentication:

```sh
curl 'https://YOUR_KEY_HERE@developer.nrel.gov/api/alt-fuel-stations/v1.json?limit=1'
curl 'https://YOUR_KEY_HERE@developer.nlr.gov/api/alt-fuel-stations/v1.json?limit=1'
```
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ summary: Access energy data on individual components or energy conservation meas

For web service details, documentation, and access, see the [Building Component Library API documentation](https://bcl.nrel.gov/documentation).

Note: Your developer.nrel.gov API key will not work for the Building Component Library API. Instead, refer to the Building Component Library documentation for access.
Note: Your developer.nlr.gov API key will not work for the Building Component Library API. Instead, refer to the Building Component Library documentation for access.
4 changes: 2 additions & 2 deletions source/docs/climate/guide.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ In cases where a very large WKT value is required, e.g. downloading the maximum
```python
import requests

url = "http://developer.nrel.gov/api/climate/ncdb/v2/climate/ncdb-4km-Hourly-CONUS-v1-0-0-RCP8-5-download.json?api_key=yourapikeygoeshere"
url = "https://developer.nlr.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&wkt=MULTIPOINT(-106.22%2032.9741%2C-106.18%2032.9741%2C-106.1%2032.9741)"

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=user@company.com&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"
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=user@company.com&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)' "https://developer.nlr.gov/api/solar/psm3-5min-download.json?api_key=yourapikeygoeshere"
```

<h2 id="contacts">Contact</h2>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ Year,Month,Day,Hour,Minute,wind direction at 180m (deg)
```python
import requests

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

payload = "api_key={{API_KEY}}&names=2017&utc=true&leap_day=true&interval=60&email=user@company.com&wkt=POINT(-179.99 -15.94)"

Expand All @@ -278,7 +278,7 @@ print(response.text)

<h2 id="rate-limits">Rate Limits</h2>

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.
Rate limits for this application are significantly less than the [standard rate limits](/docs/rate-limits){:target="_blank"} for developer.nlr.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 <em>.csv</em> 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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ Year,Month,Day,Hour,Minute,wind direction at 180m (deg)
```python
import requests

url = "http://developer.nrel.gov<%= current_page.data.url %>.json?api_key=yourapikeygoeshere"
url = "https://developer.nlr.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=user@company.com&wkt=POINT(-179.99 -15.94)"

Expand All @@ -277,7 +277,7 @@ print(response.text)

<h2 id="rate-limits">Rate Limits</h2>

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.
Rate limits for this application are significantly less than the [standard rate limits](/docs/rate-limits){:target="_blank"} for developer.nlr.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 <em>.csv</em> 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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ Year,Month,Day,Hour,Minute,surface air pressure (Pa),DHI,DNI,GHI,relative humidi
```python
import requests

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

payload = "email=user@company.com&wkt=POINT%28-106.19569217545038+42.53470991129683%29&names=2000&interval=60"

Expand All @@ -281,7 +281,7 @@ print(response.text)

<h2 id="rate-limits">Rate Limits</h2>

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.
Rate limits for this application are significantly less than the [standard rate limits](/docs/rate-limits){:target="_blank"} for developer.nlr.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 <em>.csv</em> 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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ Year,Month,Day,Hour,Minute,surface air pressure (Pa),DHI,DNI,GHI,relative humidi
```python
import requests

url = "http://developer.nrel.gov<%= current_page.data.url %>.json?api_key=yourapikeygoeshere"
url = "https://developer.nlr.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"

Expand All @@ -280,7 +280,7 @@ print(response.text)

<h2 id="rate-limits">Rate Limits</h2>

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.
Rate limits for this application are significantly less than the [standard rate limits](/docs/rate-limits){:target="_blank"} for developer.nlr.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 <em>.csv</em> 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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ Year,Month,Day,Hour,Minute,surface air pressure (Pa),DHI,DNI,GHI,relative humidi
```python
import requests

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

payload = "email=user@company.com&wkt=POINT%28-106.19569217545038+42.53470991129683%29&attributes=pressure_0m,dhi,dni,ghi,relativehumidity_2m,temperature_2m&names=2000&interval=60"

Expand All @@ -283,7 +283,7 @@ print(response.text)

<h2 id="rate-limits">Rate Limits</h2>

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.
Rate limits for this application are significantly less than the [standard rate limits](/docs/rate-limits){:target="_blank"} for developer.nlr.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 <em>.csv</em> 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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ Year,Month,Day,Hour,Minute,surface air pressure (Pa),DHI,DNI,GHI,relative humidi
```python
import requests

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

payload = "email=user@company.com&wkt=POINT%28-106.19569217545038+42.53470991129683%29&attributes=pressure_0m,dhi,dni,ghi,relativehumidity_2m,temperature_2m&names=2000&interval=60"

Expand All @@ -283,7 +283,7 @@ print(response.text)

<h2 id="rate-limits">Rate Limits</h2>

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.
Rate limits for this application are significantly less than the [standard rate limits](/docs/rate-limits){:target="_blank"} for developer.nlr.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 <em>.csv</em> 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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ Year,Month,Day,Hour,Minute,surface air pressure (Pa),DHI,DNI,GHI,relative humidi
```python
import requests

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

payload = "email=user@company.com&wkt=POINT%28-106.19569217545038+42.53470991129683%29&attributes=pressure_0m,dhi,dni,ghi,relativehumidity_2m,temperature_2m&names=2001&interval=60"

Expand All @@ -283,7 +283,7 @@ print(response.text)

<h2 id="rate-limits">Rate Limits</h2>

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.
Rate limits for this application are significantly less than the [standard rate limits](/docs/rate-limits){:target="_blank"} for developer.nlr.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 <em>.csv</em> 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.

Expand Down
Loading
Loading