Skip to content

Commit 7d7a4f0

Browse files
committed
Switch recommendation to micromamba from mambaforge
1 parent 6cf57b6 commit 7d7a4f0

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

docs/installation/index.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,35 +14,35 @@ Client Installation
1414
Downloading the **SimStack** client
1515
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1616

17-
If you do not have a working conda or mamba installation, please install mambaforge for your architecture from `github.com/conda-forge/miniforge <https://github.com/conda-forge/miniforge>`_.
17+
You will require a micromamba (recommended) or conda setup to use simstack. You can use your existing micromamba or conda installation. If you do not have a working micromamba for your architecture please install micromamba, e.g. via the automatic installation route `micromamba install docs <https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html>`_.
1818

19-
After installing, make sure you have the **mamba** command available in your shell and call:
19+
After installing, make sure you have the **micromamba** or **conda** command available in your shell and call:
2020

2121
.. code-block:: bash
2222
2323
# Create a new environment for the simstack client:
24-
mamba create --name=simstack simstack -c https://mamba.nanomatch-distribution.de/mamba-repo -c conda-forge
24+
micromamba create --name=simstack simstack -c https://mamba.nanomatch-distribution.de/mamba-repo -c conda-forge
2525
# Activate the environment
26-
conda activate simstack
26+
micromamba activate simstack
2727
# and run simstack:
2828
simstack
2929
3030
If you want to use your installed simstack client, just open a shell and type:
3131

3232
.. code-block:: bash
3333
34-
conda activate simstack
34+
micromamba activate simstack
3535
# and run simstack:
3636
simstack
3737
3838
Finally, if you want to update an existing simstack install:
3939

4040
.. code-block:: bash
4141
42-
conda activate simstack
43-
mamba update simstack -c https://mamba.nanomatch-distribution.de/mamba-repo -c conda-forge
42+
micromamba activate simstack
43+
micromamba update simstack -c https://mamba.nanomatch-distribution.de/mamba-repo -c conda-forge
4444
# Or if you need a specific version, example 1.2.5:
45-
mamba install simstack=1.2.5 -c https://mamba.nanomatch-distribution.de/mamba-repo -c conda-forge
45+
micromamba install simstack=1.2.5 -c https://mamba.nanomatch-distribution.de/mamba-repo -c conda-forge
4646
4747
4848
The client version requires passwordless via ``ssh`` access to communicate with the HPC. If you do not have passwordless via

docs/installation/server.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,39 +10,39 @@ Server Installation
1010
.. role:: red
1111
.. role:: green
1212

13-
This manual is verified for SimStackServer v1.3.4
13+
This manual is verified for SimStackServer v1.3.9
1414

1515
Installing the **SimStack** server
1616
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1717

18-
SimStackServer requires a Linux system. If you do not have a working conda or mamba installation, please install mambaforge for your architecture from `github.com/conda-forge/miniforge <https://github.com/conda-forge/miniforge>`_.
18+
SimStackServer requires a Linux system with a micromamba or conda install. You can use your existing micromamba or conda installation to install SimStackServer. If you do not have a working micromamba for your architecture please install micromamba, e.g. via the automatic installation route `micromamba install docs <https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html>`_. Note down the path of your `MAMBA_ROOT_PREFIX`, which is set during install. You will need to insert this into the client, when configuring.
1919

20-
After installing, make sure you have the **mamba** command available in your shell and call:
20+
After installing, make sure you have the **micromamba** command available in your shell and call:
2121

2222
.. code-block:: bash
2323
2424
# Create a new environment for simstack client:
25-
mamba create --name=simstack_server_v6 simstackserver -c https://mamba.nanomatch-distribution.de/mamba-repo -c conda-forge
25+
micromamba create --name=simstack_server_v6 simstackserver -c https://mamba.nanomatch-distribution.de/mamba-repo -c conda-forge
2626
# Activate the environment to see if it exists
27-
conda activate simstack_server_v6
27+
micromamba activate simstack_server_v6
2828
29-
Note down the path of your mambaforge install (e.g. */home/you/mambaforge*), you will need to insert this into the client, when configuring.
29+
If you want to use a full conda install (not recommended, but supported) instead, make sure your conda is updated and substitute conda with micromamba. The path you have to input in your client is the path of your conda install then.
3030

3131

3232
Example: Setting required WaNo exports
3333
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3434

35-
36-
Many WaNos require a specific export, such as **NANOMATCH** to find their executables. To set this variable, please call the following with an activated environment:
35+
Note: The next section does not apply for the newest WaNos by Nanomatch.
36+
Some WaNos require a specific export, such as **NANOMATCH** or **KIT** to find their executables. To set this variable, please call the following with an activated environment:
3737

3838
.. code-block:: bash
3939
40-
conda activate simstack_server_v6
41-
conda env config vars set NANOMATCH=/path/to/your/nanomatch/folder
40+
micromamba activate simstack_server_v6
41+
micromamba env config vars set NANOMATCH=/path/to/your/nanomatch/folder
4242
# To see if it worked:
43-
conda deactivate
44-
conda activate simstack_server_v6
45-
echo $NANOMATCH
43+
micromamba deactivate
44+
micromamba activate simstack_server_v6
45+
micromamba $NANOMATCH
4646
4747
4848
Once this is finished, continue with the client setup. If you are testing and do not have a working queueing system installed, choose ``Internal`` as queueing system.

0 commit comments

Comments
 (0)