Skip to content

Commit

Permalink
docs: Updated installation steps to refer to miniforge and `microma…
Browse files Browse the repository at this point in the history
…mba`
  • Loading branch information
Carsopre committed Aug 30, 2024
1 parent 55577be commit 814b4f9
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/installation/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ Installation

RA2CE can be operated via the command-line interface with two commands.
Before RA2CE can be used, the correct Python environment needs to be installed
(see *environment.yml*). Anaconda is a well-known environment manager for Python
and can be used to install the correct environment and run RA2CE via its
command-line interface. It is recommended to install Anaconda, instead of
`miniconda`, so that you have all required packages already available during the
following steps.
(see *environment.yml*), this can be done with a conda environment manager such
as `miniforge <https://github.com/conda-forge/miniforge>`_ or `micromamba <https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html>`_.

.. note::
Important! In compliance with Deltares open-source policy it is recommended to use either ``miniforge`` or ``micromamba``
as they both have ``conda-forge`` as the default package channel. If you wish to use another conda distribution please
make sure the default channel is set to ``conda-forge`` to avoid issues with Deltares open-source policy.


CLI only
Expand Down

0 comments on commit 814b4f9

Please sign in to comment.