|
| 1 | +# Setting Environment Variables |
| 2 | + |
| 3 | +H2Integrate can pull weather resource datasets (e.g. data needed for wind or solar generation) automatically for a user-provided location. |
| 4 | +To use resource datasets from the NREL developer network, you will need an NREL API key, which can be obtained from: |
| 5 | + [https://developer.nrel.gov/signup/](https://developer.nrel.gov/signup/). |
| 6 | + |
| 7 | +You will need to set the API key and the email you used to get the API key for downloading resource data from the NREL developer network. The 40 character API key is referred to in following sections as the value for the `NREL_API_KEY` environment variable. The email used to get the API key is referred to in the following sections as the value for the `NREL_API_EMAIL` environment variable. |
| 8 | + |
| 9 | +In the following sections on setting these environment variables, `'api-key-value'` should be replaced with your NREL API key and `'email-for-api-key'` should be replaced with your email address. |
| 10 | + |
| 11 | +An optional environment variable is `RESOURCE_DIR`. If set, this will be used as the default folder to save resource data to that is downloaded from the API. If setting this, please set its value as the full filepath to the folder you'd like to save resource files to, and ensure that the folder exists. |
| 12 | + |
| 13 | +The remaining sections outline different options for setting environment variables in H2Integrate: |
| 14 | +- [Save environment variables with conda (preferred)](#save-environment-variables-with-conda-preferred) |
| 15 | +- [Set environment variables with a .yaml file](#set-environment-variables-with-yaml-file) |
| 16 | +- [Set environment variables with a .env file](#set-environment-variables-with-env-file) |
| 17 | + |
| 18 | +## Save Environment Variables with Conda (Preferred) |
| 19 | + |
| 20 | +After creating the conda environment for H2Integrate, you can [save environment variables with conda](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#saving-environment-variables) within that environment. |
| 21 | +This is the preferred method for setting environment variables for H2Integrate. |
| 22 | + |
| 23 | +### Windows Instructions |
| 24 | + |
| 25 | +If you are using a Windows machine, please follow the steps documented for conda on [saving environment variables on Windows](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#win-save-env-variables). |
| 26 | +The specific variable names and values to set are listed below; use these for steps 3 and 4 from the conda installation instructions.. |
| 27 | + |
| 28 | +The `.\etc\conda\activate.d\env_vars.bat` file may look like below: |
| 29 | +```bash |
| 30 | +set NREL_API_KEY='api-key-value' |
| 31 | +set NREL_API_EMAIL='email-for-api-key' |
| 32 | +set RESOURCE_DIR=C:\path\to\my\resource\folder |
| 33 | +``` |
| 34 | + |
| 35 | +The `.\etc\conda\deactivate.d\env_vars.bat` file may look like below: |
| 36 | +```bash |
| 37 | +set NREL_API_KEY= |
| 38 | +set NREL_API_EMAIL= |
| 39 | +set RESOURCE_DIR= |
| 40 | +``` |
| 41 | + |
| 42 | +### macOS and Linux instructions |
| 43 | + |
| 44 | +If you are using a macOS or Linux machine, please follow the steps documented for conda on [saving environment variables on macOS or Linux](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#macos-linux-save-env-variables) |
| 45 | + |
| 46 | +The `./etc/conda/activate.d/env_vars.sh` file may look like below: |
| 47 | +```bash |
| 48 | +#!/bin/sh |
| 49 | +export NREL_API_KEY='api-key-value' |
| 50 | +export NREL_API_EMAIL='email-for-api-key' |
| 51 | +export RESOURCE_DIR=/path/to/my/resource/folder/ |
| 52 | +``` |
| 53 | + |
| 54 | +The `./etc/conda/deactivate.d/env_vars.sh` file may look like below: |
| 55 | +```bash |
| 56 | +#!/bin/sh |
| 57 | + |
| 58 | +unset NREL_API_KEY |
| 59 | +unset NREL_API_EMAIL |
| 60 | +unset RESOURCE_DIR |
| 61 | +``` |
| 62 | + |
| 63 | + |
| 64 | +## Set Environment Variables with .yaml file |
| 65 | + |
| 66 | +1. In `environment.yml`, add the following lines to the bottom of the file, and replace the |
| 67 | + environment variable values with your information. Be sure that |
| 68 | + "variables" has no leading spaces. |
| 69 | + |
| 70 | + ```yaml |
| 71 | + variables: |
| 72 | + NREL_API_KEY='api-key-value' |
| 73 | + NREL_API_EMAIL='email-for-api-key' |
| 74 | + RESOURCE_DIR='/path/to/my/resource/folder/' |
| 75 | + ``` |
| 76 | +
|
| 77 | +2. After that, create a conda environment and install H2Integrate and all its dependencies using the modified `environment.yml` file with the command: |
| 78 | + |
| 79 | + ```bash |
| 80 | + conda env create -f environment.yml |
| 81 | + ``` |
| 82 | + |
| 83 | +## Set Environment Variables with .env file |
| 84 | + |
| 85 | +```{note} |
| 86 | +This method only works for setting the `NREL_API_KEY` and `NREL_API_EMAIL` environment variables; this method should not be used to set the `RESOURCE_DIR` environment variable. |
| 87 | +``` |
| 88 | + |
| 89 | +The ".env" file will be looked for in all of the following locations: |
| 90 | + - H2Integrate root directory (`/path/to/H2Integrate/h2integrate/`) |
| 91 | + - parent of H2Integrate root directory (`/path/to/H2Integrate/`) (preferred location to store your environment file) |
| 92 | + - current working directory (this is not a preferred location to store your environment file) |
| 93 | +1. Choose which of the above directories you want to host your .env file, and create a file named ".env" in that folder. |
| 94 | +2. Open the ".env" file and add the environment variables: |
| 95 | + ```bash |
| 96 | + NREL_API_KEY='api-key-value' |
| 97 | + NREL_API_EMAIL='email-for-api-key' |
| 98 | + ``` |
| 99 | +3. Save and close the ".env" file. |
0 commit comments