Skip to content

Commit

Permalink
update the "Manual" installation instruction on stable (#2231)
Browse files Browse the repository at this point in the history
We are now based on Miniforge3
  • Loading branch information
Preetam-Das26 authored Feb 25, 2024
1 parent dd40e3d commit d589d7e
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,15 @@ Manual
Mamba based installation
........................

We strongly recommend to start from `Mambaforge <https://mamba.readthedocs.io/en/latest/installation.html>`_,


We strongly recommend to start from `Miniforge3 <https://github.com/conda-forge/miniforge#install>`_,
a community project of the conda-forge community.

As **Beginner** start with an installation of Mambaforge
- Get `mambaforge <https://github.com/conda-forge/miniforge#mambaforge>`__ for your Operation System
As **Beginner** start with an installation of Miniforge3
- Get `Miniforge3 <https://github.com/conda-forge/miniforge#download>`__ for your Operation System

If you use already Mambaforge please read the `FAQ <https://github.com/conda-forge/miniforge#faq>`__

Install MSS
~~~~~~~~~~~
Expand All @@ -70,7 +74,7 @@ We suggest to create a mss user.
* login as mss user
* create a *src* directory in /home/mss
* cd src
* get `mambaforge <https://github.com/conda-forge/miniforge#mambaforge>`__
* get `Miniforge3 <https://github.com/conda-forge/miniforge#download>`__
* set execute bit on install script
* execute script, enable environment in .bashrc
* login again
Expand Down Expand Up @@ -99,22 +103,20 @@ Conda based installation
`Anaconda <https://www.anaconda.com/>`_ provides an enterprise-ready data analytics
platform that empowers companies to adopt a modern open data science analytics architecture.

.. warning::
Installing Mamba in Anaconda setup is not recommended. We strongly recommend to use the Mambaforge method (see above).

Please add the channel conda-forge to your defaults::

$ conda config --add channels conda-forge

The conda-forge channel must be on top of the list before the anaconda default channel.

From September 2023 libmamba is the `default installer in anaconda <https://conda.org/blog/2023-07-05-conda-libmamba-solver-rollout/>`__.

Install MSS
~~~~~~~~~~~

You must install mss into a new environment to ensure the most recent
versions for dependencies. ::

$ conda install -n base conda-libmamba-solver
$ conda create -n mssenv
$ conda activate mssenv
(mssenv) $ conda install mss=$mss_version python --solver=libmamba
Expand Down Expand Up @@ -245,4 +247,3 @@ You can start server and client by loading the image ::
$ Singularity > mswms_demodata --seed # creates in your $HOME a mss/ folder with testdata
$ Singularity > export PYTHONPATH=$HOME/mss; mswms # starts the development server
$ Singularity > mscolab db --init; mscolab start # starts the mscolab development server

0 comments on commit d589d7e

Please sign in to comment.