Skip to content

Commit fdfc0c4

Browse files
committed
add NREL_DEVELOPER_EMAIL to env, docs
1 parent 3074192 commit fdfc0c4

2 files changed

Lines changed: 7 additions & 3 deletions

File tree

docs/src/index.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,16 @@ REopt evaluations for all system types except GHP (see below) can be performed u
1010
(active_env) pkg> add REopt JuMP HiGHS
1111
```
1212

13-
### Add NREL developer API key for PV and Wind
13+
### Add NREL developer API key for PV, CST, and Wind
1414
If you don't have an NREL developer network API key, [sign up here on https://developer.nrel.gov to get one (free)](https://developer.nrel.gov/signup); this is required to load PV and Wind resource profiles from PVWatts and the Wind Toolkit APIs from within REopt.jl.
1515
Assign your API key to the expected environment variable:
1616
```julia
1717
ENV["NREL_DEVELOPER_API_KEY"]="your API key"
1818
```
19-
before running PV or Wind scenarios.
19+
before running PV or Wind scenarios, and also assign your email to the expected environment variable as well before running CST scenarios:
20+
```julia
21+
ENV["NREL_DEVELOPER_EMAIL"]="your contact email"
22+
```
2023

2124
### Additional package loading for GHP
2225
GHP evaluations must load in the [`GhpGhx.jl`](https://github.com/NREL/GhpGhx.jl) package separately because it has a more [restrictive license](https://github.com/NREL/GhpGhx.jl/blob/main/LICENSE.md) and is not a registered Julia package.

test/.env

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
NREL_DEVELOPER_API_KEY="X3Fd4msuCdRGpgelMSjr8FYXfgdjWSuHHMdZE8Ta"
2-
URDB_API_KEY="2qt5uihpKXdywTj3uMIhBewxY9K4eNjpRje1JUPL"
2+
URDB_API_KEY="2qt5uihpKXdywTj3uMIhBewxY9K4eNjpRje1JUPL"
3+
NREL_DEVELOPER_EMAIL="reopt@nrel.gov"

0 commit comments

Comments
 (0)