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/Installation/Requirements/index.rst
+64-32Lines changed: 64 additions & 32 deletions
Original file line number
Diff line number
Diff line change
@@ -29,19 +29,6 @@ Xmipp requires C++17 compatible compiler (see table below for minimum versions).
29
29
* - Clang
30
30
- 5.0
31
31
32
-
Cmake
33
-
^^^^^
34
-
35
-
Xmipp requires CMake 3.17 or above.
36
-
37
-
.. warning::
38
-
Ubuntu 20.04 only supports CMake 3.16.3.
39
-
If you experience any issues, please install CMake using Conda in the Scipion3 environment:
40
-
41
-
.. code-block:: bash
42
-
43
-
scipion3 run conda install cmake
44
-
45
32
Cuda
46
33
^^^^
47
34
@@ -56,38 +43,54 @@ To install CUDA for your operating system, follow the `official install guide <h
56
43
.. warning::
57
44
`CUDA 11.5 is not compatible with GCC - 9 <https://forums.developer.nvidia.com/t/cuda-11-5-samples-throw-multiple-error-attribute-malloc-does-not-take-arguments/192750/12>`_, please change one of these.
58
45
59
-
Full list of dependencies
60
-
^^^^^^^^^^^^^^^^^^^^^^^^^
46
+
OpenMPI
47
+
^^^^^^^^
48
+
OpenMPI
49
+
^^^^^^^
61
50
62
-
Before installing Xmipp, you need to ensure your system meets certain requirements. Below is a list of required packages and dependencies.
51
+
OpenMPI is required for parallel execution of certain Xmipp programs. It provides support for distributed computing across multiple CPUs and nodes using the Message Passing Interface (MPI).
52
+
53
+
We recommend installing **OpenMPI 3.1** or higher to ensure compatibility with all Xmipp functionalities.
54
+
55
+
.. list-table::
56
+
:header-rows: 1
57
+
:widths: 50 50
58
+
59
+
* - Package
60
+
- Minimum Version
61
+
* - OpenMPI
62
+
- 3.1
63
63
64
64
.. note::
65
-
The following explanations are available on devel and as of `Xmipp 3.25.06.0 - Rhea <https://i2pc.github.io/docs/Releases/Releases-scipion-em-xmipp/index.html#rhea>`_
65
+
On **Ubuntu-based** systems, you can install OpenMPI development files with:
If Xmipp is installed **through Scipion** `with the plugin manager or with the terminal <https://i2pc.github.io/docs/Installation/Installations/index.html#installation-with-scipion>`_ , the following packages will be automatically installed in the Scipion environment by default:
71
+
On **RHEL/CentOS-based** systems, use:
72
72
73
-
- ``cmake>=3.18,<4``
74
-
- ``hdf5>=1.18``
75
-
- ``sqlite>=3``
76
-
- ``fftw>=3``
77
-
- ``make``
78
-
- ``zlib``
79
-
- ``openjdk``
80
-
- ``libtiff``
81
-
- ``libstdcxx-ng``
82
-
- ``libjpeg-turbo``
73
+
.. code-block:: bash
74
+
75
+
yum install openmpi-devel
76
+
77
+
.. warning::
78
+
Make sure that your environment variables (e.g. ``PATH`` and ``LD_LIBRARY_PATH``) are correctly set to point to the OpenMPI installation. In some systems, MPI programs may default to incompatible versions if multiple MPI implementations coexist.
79
+
80
+
81
+
82
+
Full list of dependencies
83
+
^^^^^^^^^^^^^^^^^^^^^^^^^
84
+
85
+
Before installing Xmipp, you need to ensure your system meets certain requirements. Below is a list of required packages and dependencies.
83
86
84
87
.. note::
85
-
This automatic installation is enabled by default. To disable it, set ``default=False`` in `this file<https://github.com/I2PC/scipion-em-xmipp/blob/206832bff698a8eb40ac6b7d7cf5fbb1286d31ef/xmipp3/__init__.py#L177>`_
88
+
The following explanations are available on devel and as of `Xmipp 3.25.06.0 - Rhea<https://i2pc.github.io/docs/Releases/Releases-scipion-em-xmipp/index.html#rhea>`_
86
89
87
90
Manually Required Dependencies
88
91
""""""""""""""""""""""""""""""""""""
89
92
90
-
The following system-level packages **must be installed manually**, as they are not handled by Scipion:
93
+
The following system-level packages **must be installed manually**, as they are not handled by the Xmipp installer:
91
94
92
95
- ``GCC``: C compiler
93
96
- ``G++``: C++ compiler
@@ -117,5 +120,34 @@ Then, install the dependencies:
If Xmipp is installed **through Scipion** `with the plugin manager or with the terminal <https://i2pc.github.io/docs/Installation/Installations/index.html#installation-with-scipion>`_ , the following packages will be automatically installed in the Scipion environment by default:
127
+
128
+
- ``cmake>=3.18,<4``
129
+
- ``hdf5>=1.18``
130
+
- ``sqlite>=3``
131
+
- ``fftw>=3``
132
+
- ``make``
133
+
- ``zlib``
134
+
- ``openjdk``
135
+
- ``libtiff``
136
+
- ``libstdcxx-ng``
137
+
- ``libjpeg-turbo``
138
+
139
+
.. note::
140
+
This automatic installation is enabled by default. To disable it, set ``default=False`` in `this file <https://github.com/I2PC/scipion-em-xmipp/blob/206832bff698a8eb40ac6b7d7cf5fbb1286d31ef/xmipp3/__init__.py#L177>`_
141
+
142
+
143
+
.. note::
144
+
Xmipp requires CMake 3.17 or above. Ubuntu 20.04 only supports CMake 3.16.3.
145
+
If you experience any issues, please install CMake using Conda in the Scipion3 environment:
146
+
147
+
.. code-block:: bash
148
+
149
+
scipion3 run conda install cmake
150
+
151
+
120
152
These requirements will ensure that your system is ready for installing and using Xmipp. If you encounter a problem, please refer to known and fixed `issues <https://github.com/I2PC/xmipp/issues?q=is%3Aissue>`_. Let us know if something is not working.
0 commit comments