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: doc/source/installation.rst
+23-45Lines changed: 23 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,70 +1,43 @@
1
1
.. -*- coding: utf-8 -*-
2
2
3
3
====================
4
-
Installation
4
+
Installation Guide
5
5
====================
6
6
7
-
The latest versions of **MDAnalysis** can be installed using `conda` or `pip`.
8
-
Currently, the conda releases only support serial calculations.
9
-
If you plan to use the parallel OpenMP algorithms, you need to
10
-
install MDAnalysis with pip and have a working OpenMP installation.
11
-
12
-
MDAnalysis has a separate :ref:`test suite <mdanalysistests>` **MDAnalysisTests** that is required to run the test cases and examples.
13
-
The test files change less frequently, take up around 90 MB of space,
14
-
and are not needed for daily use of MDAnalysis. However, they are often used in examples,
15
-
including many in this User Guide. If you are not interested in developing
16
-
MDAnalysis or using the example files, you most likely don't need the tests. If you want to
17
-
run examples in the User Guide, install the tests.
18
-
The tests are distributed separately from the main package.
7
+
**MDAnalysis** can be installed using `conda <https://docs.conda.io/projects/conda/en/latest/>`_ (recommended), `pip <https://pip.pypa.io/en/latest/index.html>`_, or from `source <https://github.com/MDAnalysis/mdanalysis/>`_ for development.
19
8
20
9
.. note::
10
+
MDAnalysis supports **Linux**, **macOS**, and **Windows** (Python 3.8+).
11
+
If you encounter installation issues, seek help on `GitHub Discussions (Installation) <https://github.com/MDAnalysis/mdanalysis/discussions/categories/installation>`_.
21
12
22
-
If you are installing on Windows, you must have
23
-
Microsoft Visual C++ 14.0 installed. If your installation
24
-
fails with the error message:
25
-
26
-
error: Microsoft Visual C++ 14.0 is required. Get it with "Build Tools for Visual Studio": https://visualstudio.microsoft.com/downloads/
If you use ``conda`` to manage your Python environment, we highly recommend creating a new environment for MDAnalysis.
16
+
For most users, `conda<https://docs.conda.io/projects/conda/en/latest/>`_ is the easiest way to install MDAnalysis. We highly recommend creating a new environment for MDAnalysis.
42
17
This will ensure that you have a clean installation of MDAnalysis and its dependencies, and will not interfere with other packages you may have installed.
43
-
We further recommend that you install and use ``mamba``, a faster drop-in replacement for ``conda``.
44
18
45
19
.. code-block:: bash
46
20
47
21
conda create --name mdanalysis
48
22
conda activate mdanalysis
49
-
conda install -c conda-forge mamba
23
+
conda install -c conda-forge mdanalysis
50
24
51
-
To install the latest stable version of MDAnalysis via ``conda``, use the following command. This installs all dependencies needed for full analysis functionality (excluding external programs such as `HOLE`_):
25
+
To upgrade to the latest version:
52
26
53
27
.. code-block:: bash
54
28
55
-
mamba install -c conda-forge mdanalysis
29
+
conda update mdanalysis
56
30
57
-
To upgrade:
31
+
To install the **test suite** (useful for examples and validation):
58
32
59
33
.. code-block:: bash
60
34
61
-
mamba update mdanalysis
35
+
conda install MDAnalysisTests
62
36
63
-
To install the tests:
64
-
65
-
.. code-block:: bash
37
+
.. warning::
38
+
Conda installations **do not support OpenMP**.
39
+
If you need **parallel OpenMP calculations**, install MDAnalysis using `pip <https://pip.pypa.io/en/latest/index.html>`_.
66
40
67
-
mamba install -c conda-forge MDAnalysisTests
68
41
69
42
If you intend to use MDAnalysis in JupyterLab, you will have to install
70
43
an extra package for the progress bar in analysis classes:
@@ -74,21 +47,22 @@ an extra package for the progress bar in analysis classes:
The following command will install or upgrade the latest stable version of MDAnalysis via ``pip``, with core dependencies. This means that some packages required by specific analysis modules will not be installed.
52
+
53
+
If you do not use Conda or require **OpenMP support**, install MDAnalysis via `pip <https://pip.pypa.io/en/latest/index.html>`_:
80
54
81
55
.. code-block:: bash
82
56
83
57
pip install --upgrade MDAnalysis
84
58
85
-
If you need to install a fully-featured MDAnalysis, add the ``analysis`` tag. As with ``conda``, this will not install external programs such as `HOLE`_.
59
+
For full functionality with **analysis modules**:
86
60
87
61
.. code-block:: bash
88
62
89
63
pip install --upgrade MDAnalysis[analysis]
90
64
91
-
To install/upgrade tests:
65
+
To install the **test suite**:
92
66
93
67
.. code-block:: bash
94
68
@@ -102,6 +76,10 @@ an extra package for the progress bar in analysis classes:
If you are installing on **Windows**, and encounter errors related to **Microsoft Visual C++ 14.0**, install **Build Tools for Visual Studio** from `here <https://visualstudio.microsoft.com/downloads/>`_.
0 commit comments