Setting up environment variables

Several UASAL repositories and/or python packages require environment variables to be configured in order to read in a configuration correctly. In context of configuration repos such as config_stp or config_um, the environment variable is set to a remote file server (e.g. a cloned repo such as the uasal_archive) so that on package usage, the path to the file server is automatically expanded.

Environment Variable Setup

Linux / macOS

1. Check which environment variable your configuration repository is using

   Reference the README or inspect the config files for paths prepended by $, e.g. $SERVER.

2. Temporarily add the environment variable to your session

   In a terminal, type the following and press Enter:

   export ENV_VARIABLE=/path/to/server
   

3. Permanently add the environment variable

   Add the export command above to one of your shell config files:

   • ~/.bashrc

   • ~/.bash_profile

   • ~/.zshrc

   • ~/.profile

   Then apply the changes with:

   source ~/.bashrc
   

4. Verify the environment variable

   Open a new terminal and run:

   echo $ENV_VARIABLE
   

Windows

1. Check which environment variable the configuration repository is using

   Reference the README or inspect the config files for paths prepended by $.

2. Temporarily add the variable for the current Command Prompt session

   set ENV_VARIABLE=\\path\to\server
   

   Replace with the actual UNC path to your network location.

3. Permanently add the environment variable

   • Search “Environment Variables” in the Start Menu

   • Open “Edit the system environment variables” and click “Environment Variables…”

   • Under User variables or System variables, click New: - Name: ENV_VARIABLE - Value: \\path\to\server

   • Click OK to save.

4. Verify the environment variable

   Open a new Command Prompt or PowerShell window and run:

   echo %ENV_VARIABLE%