You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/intro/installation.rst
+30-14Lines changed: 30 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,35 +9,52 @@ Installation
9
9
Latest Version
10
10
--------------
11
11
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**.
13
13
14
14
1. Using ``conda``
15
15
~~~~~~~~~~~~~~~~~~
16
16
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:
Then, let ``conda`` automatically install all required dependencies of **floatCSEP** (from its ``environment.yml`` file) into a new environment, and activate it:
18
25
19
26
.. code-block:: console
20
27
21
28
$ conda env create -n csep_env
22
29
$ conda activate csep_env
23
30
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``:
Use the ``mamba`` command instead of ``conda`` if `Miniforge` was installed.
46
+
To *update* **floatCSEP** and its dependencies at a later date, simply execute:
35
47
48
+
.. code-block:: console
36
49
37
-
2. Using ``pip`` only
50
+
$ conda env update --file environment.yml
51
+
$ pip install . -U
52
+
53
+
54
+
2. Using only ``pip``
38
55
~~~~~~~~~~~~~~~~~~~~~
39
56
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:
41
58
42
59
.. code-block:: console
43
60
@@ -50,17 +67,16 @@ To install using the ``pip`` manager only, we require to install the binary depe
50
67
Latest Stable Release
51
68
---------------------
52
69
53
-
Recommended for deploying live Floating Testing Experiments
70
+
This option is recommended for deploying *Floating Testing Experiments* live.
54
71
55
72
1. From the ``conda-forge`` channel
56
73
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
57
74
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:
60
76
61
77
.. code-block:: console
62
78
63
-
$ conda env create -n csep_env
79
+
$ conda create -n csep_env
64
80
$ conda activate csep_env
65
81
$ conda install -c conda-forge floatcsep
66
82
@@ -91,7 +107,7 @@ Having installed the binary dependencies of **pyCSEP** (see `Installing pyCSEP <
91
107
For Developers
92
108
--------------
93
109
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.
95
111
96
112
.. code-block:: console
97
113
@@ -101,4 +117,4 @@ It is recommended (not obligatory) to use a ``conda`` environment to make sure y
101
117
$ cd floatcsep
102
118
$ pip install .[dev]
103
119
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