Skip to content

Commit

Permalink
Update docs about --env_dir flag (#715)
Browse files Browse the repository at this point in the history
* Update README.md

* Update start_install.rst
  • Loading branch information
jtmims authored Nov 22, 2024
1 parent 6deaa75 commit e808181
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 6 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,7 @@ for, the Windows Subsystem for Linux.
when micromamba is installed
- `$MICROMAMBA_EXE` is full path to the micromamba executable on your system
(e.g., /home/${USER}/.local/bin/micromamba). This is defined by the `MAMBA_EXE` environment variable on your system
- The `--env_dir` flag allows you to put the program files in a designated location `$CONDA_ENV_DIR`
(for space reasons, or if you don’t have write access).
You can omit this flag, and the environments will be installed within `$CONDA_ROOT/envs/` by default.
- All flags noted for your system above must be supplied for the script to work.

#### NOTE: The micromamba environments may differ from the conda environments because of package compatibility discrepancies between solvers
`% ./src/conda/micromamba_env_setup.sh --all --micromamba_root $MICROMAMBA_ROOT --micromamba_exe $MICROMAMBA_EXE --env_dir $CONDA_ENV_DIR` builds
Expand Down
3 changes: 0 additions & 3 deletions doc/sphinx/start_install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -192,9 +192,6 @@ environments in your conda installation. The installation process should finish

Substitute the paths identified above for <*CONDA_ROOT*> and <*CONDA_ENV_DIR*>.

If the ``--env_dir`` flag is omitted, the environment files will be installed in your system's conda's default
location (usually <*CONDA_ROOT*>/envs).

Install all the package's conda environments with micromamba by running

.. code-block:: console
Expand Down

0 comments on commit e808181

Please sign in to comment.