Skip to content

Commit 358c33f

Browse files
committed
docs: revise install instructions regarding conda
1 parent 6ceff66 commit 358c33f

File tree

1 file changed

+30
-14
lines changed

1 file changed

+30
-14
lines changed

docs/intro/installation.rst

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,35 +9,52 @@ Installation
99
Latest Version
1010
--------------
1111

12-
Recommended to learn the software, run the tutorials, and drafting **Testing Experiments**.
12+
This option is recommended to learn the software, run the tutorials, and drafting **Testing Experiments**.
1313

1414
1. Using ``conda``
1515
~~~~~~~~~~~~~~~~~~
1616

17-
To install **floatCSEP**, first a ``conda`` manager should be installed (https://conda.io). Checkout `Anaconda`, `Miniconda` or `Miniforge` (recommended). Once installed, create an environment with:
17+
First, clone the **floatCSEP** source code into a new directory by typing into a terminal:
18+
19+
.. code-block:: console
20+
21+
$ git clone https://github.com/cseptesting/floatcsep
22+
$ cd floatcsep
23+
24+
Then, let ``conda`` automatically install all required dependencies of **floatCSEP** (from its ``environment.yml`` file) into a new environment, and activate it:
1825

1926
.. code-block:: console
2027
2128
$ conda env create -n csep_env
2229
$ conda activate csep_env
2330
24-
Then, clone and install the floatCSEP source code using ``pip``
31+
.. note::
32+
33+
For this to work, you need to have ``conda`` installed (see `conda.io <https://conda.io>`_), either by installing the `Anaconda Distribution <https://docs.anaconda.com/anaconda/install/>`_,
34+
or its more minimal variants `Miniconda <https://docs.anaconda.com/miniconda/>`_ or `Miniforge <https://conda-forge.org/download>`_ (recommended).
35+
If you install `Miniforge`, we further recommend to use the ``mamba`` command instead of ``conda`` (a faster drop-in replacement).
36+
37+
38+
Lastly, install **floatCSEP** into the new environment using ``pip``:
2539

2640
.. code-block:: console
2741
28-
$ git clone https://github.com/cseptesting/floatcsep
29-
$ cd floatcsep
3042
$ pip install .
3143
3244
.. note::
3345

34-
Use the ``mamba`` command instead of ``conda`` if `Miniforge` was installed.
46+
To *update* **floatCSEP** and its dependencies at a later date, simply execute:
3547

48+
.. code-block:: console
3649
37-
2. Using ``pip`` only
50+
$ conda env update --file environment.yml
51+
$ pip install . -U
52+
53+
54+
2. Using only ``pip``
3855
~~~~~~~~~~~~~~~~~~~~~
3956

40-
To install using the ``pip`` manager only, we require to install the binary dependencies of **pyCSEP** (see `Installing pyCSEP <https://docs.cseptesting.org/getting_started/installing.html>`_}. The **floatCSEP** latest version can then be installed as:
57+
To install using the ``pip`` manager only, we require to install the binary dependencies of **pyCSEP** (see `Installing pyCSEP <https://docs.cseptesting.org/getting_started/installing.html>`_). The **floatCSEP** latest version can then be installed as:
4158

4259
.. code-block:: console
4360
@@ -50,17 +67,16 @@ To install using the ``pip`` manager only, we require to install the binary depe
5067
Latest Stable Release
5168
---------------------
5269

53-
Recommended for deploying live Floating Testing Experiments
70+
This option is recommended for deploying *Floating Testing Experiments* live.
5471

5572
1. From the ``conda-forge`` channel
5673
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5774

58-
Having a ``conda`` manager installed (https://conda.io), type in a console:
59-
75+
Having a ``conda`` manager installed (see **Note** box above), type in a console:
6076

6177
.. code-block:: console
6278
63-
$ conda env create -n csep_env
79+
$ conda create -n csep_env
6480
$ conda activate csep_env
6581
$ conda install -c conda-forge floatcsep
6682
@@ -91,7 +107,7 @@ Having installed the binary dependencies of **pyCSEP** (see `Installing pyCSEP <
91107
For Developers
92108
--------------
93109

94-
It is recommended (not obligatory) to use a ``conda`` environment to make sure your contributions do not depend on your system local libraries. For contributions to the **floatCSEP** codebase, please consider using a `fork <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo>`_ and creating pull-requests from there.
110+
It is recommended (not obligatory) to use a ``conda`` environment to make sure your contributions do not depend on your system local libraries. For contributing to the **floatCSEP** codebase, please consider `forking the repository <https://docs.github.com/articles/fork-a-repo>`_ and `create pull-requests <https://docs.github.com/articles/creating-a-pull-request>`_ from there.
95111

96112
.. code-block:: console
97113
@@ -101,4 +117,4 @@ It is recommended (not obligatory) to use a ``conda`` environment to make sure y
101117
$ cd floatcsep
102118
$ pip install .[dev]
103119
104-
This will install and configure all the unit-testing, linting and documentation packages.
120+
This will install and configure all the unit-testing, linting, and documentation packages.

0 commit comments

Comments
 (0)