Skip to content

setting PATH in env vars section #136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ ISIS requires these environment variables to be set in order to run correctly:
- `ISISROOT` - Directory path containing your ISIS install
- `ISISDATA` - Directory path containing the [ISIS Data Area](../../how-to-guides/environment-setup-and-maintenance/isis-data-area.md)

We also recommend setting:

- `PATH` - Where your computer looks for runnable apps, including ISIS apps.

???+ example "Setting Environmental Variables"

The **Conda Env** method is recommended, and the **Python Script** automates that method:
Expand All @@ -139,9 +143,9 @@ ISIS requires these environment variables to be set in order to run correctly:
# conda config vars set KEY=VALUE
```

1. This command sets both required variables (fill in your `ISISDATA` path):
1. This command sets both required variables and the PATH (fill in your `ISISDATA` location):

conda env config vars set ISISROOT=$CONDA_PREFIX ISISDATA=[your data path]
conda env config vars set ISISROOT=$CONDA_PREFIX ISISDATA=[your data path] PATH=$PATH:$CONDA_PREFIX/bin
Copy link
Collaborator

@Kelvinrr Kelvinrr Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

e.g., here, this would not accomplish much since $CONDA_PREFIX/bin is already in your PATH on activation.

Idk if we want to encourage people to set their PATH to another conda env after install, if you need that I imagine stacking would be better?


1. Re-activate your isis environment.
```sh
Expand All @@ -154,6 +158,10 @@ ISIS requires these environment variables to be set in order to run correctly:

=== "Python Script"

You should have your conda environment active before running this script:

conda activate isis

By default, running this script will set `ISISROOT=$CONDA_PREFIX` and `ISISDATA=$CONDA_PREFIX/data`:

python $CONDA_PREFIX/scripts/isisVarInit.py
Expand All @@ -162,6 +170,10 @@ ISIS requires these environment variables to be set in order to run correctly:

python $CONDA_PREFIX/scripts/isisVarInit.py --data-dir=[path to data directory]

Optionally, set the path variable:

conda env config vars set PATH=$PATH:$CONDA_PREFIX/bin

Now every time the isis environment is activated, `$ISISROOT` and `$ISISDATA` will be set to the values passed to isisVarInit.py.
This does not happen retroactively, so re-activate the isis environment:

Expand All @@ -176,6 +188,7 @@ ISIS requires these environment variables to be set in order to run correctly:
```sh
export ISISROOT=[path to ISIS]
export ISISDATA=[path to data]
export PATH=$PATH:[path to ISIS]/bin
```


Expand Down