Skip to content

Commit

Permalink
Merge pull request #529 from matthewhoffman/load_docs
Browse files Browse the repository at this point in the history
Elaborate note on not mixing envs for different branches
  • Loading branch information
xylar authored Feb 14, 2023
2 parents ef14b75 + 3088802 commit 690296e
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/developers_guide/quick_start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,14 @@ a similar command.
an incorrect and possibly unusable ``compass`` package in your conda
environment.

In general, if one wishes to switch between environments created for
different compass branches or applications, the best practice is to end
the current terminal session and start a new session with a clean
environment before executing the other compass load script. Similarly,
if you want to run a job script that itself sources the load script,
it's best to start a new terminal without having sourced a load script at
all.

If you switch to another branch, you will need to rerun
``./conda/configure_compass_env.py`` with the same arguments as above to make
sure dependencies are up to date and the ``compass`` package points to the
Expand Down

0 comments on commit 690296e

Please sign in to comment.