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
While compilation and execution might be possible on other systems, it might not be straightforward. 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.
6
+
We have tested Xmipp compilation on the following operating systems:Ubuntu 18.04, Ubuntu 20.04, Ubuntu 22.04 and Centos 7. While compilation and execution might be possible on other systems, it might not be straightforward. 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.
14
7
15
8
Hardware requirements
16
9
^^^^^^^^^^^^^^^^^^^^
@@ -23,33 +16,33 @@ Software dependencies
23
16
Compiler
24
17
^^^^^^^^
25
18
26
-
Xmipp requires a C++17 compatible compiler. We recommend GCC with G++; we have good experience with GCC/G++-8.4; in any case, a version >= 8.4 is required. If you use GCC/G++-10.3 and CUDA=11 and experience issues, `please change the compiler version <https://github.com/NVIDIA/nccl/issues/494>`_. If you use GCC-11 and experience issues, `please visit this <https://github.com/I2PC/xmipp/issues/583>`_. For more details about the compilation process and installation of gcc, please visit `compiler <https://github.com/I2PC/xmipp/wiki/Compiler>`_.
19
+
Xmipp requires C++17 compatible compiler (see table below for minimum versions). We have had good experience with using GCC. Clang is mostly untested. Mind that when compiling with CUDA, a `compatible compiler <https://gist.github.com/ax3l/9489132>`__ must be installed and findable (although it may not be used for non-CUDA sources) for Xmipp.
20
+
.. list-table::
21
+
:header-rows: 1
22
+
:widths: 50 50
23
+
24
+
* - Compiler
25
+
- Minimum Version
26
+
* - GCC
27
+
- 8.4
28
+
* - Clang
29
+
- 5.0
27
30
28
31
Cmake
29
32
^^^^^
30
33
31
-
Xmipp requires Cmake 3.16 or above. To update it, please `visit <https://github.com/I2PC/xmipp/wiki/Cmake-update-and-install>`_.
34
+
Xmipp requires Cmake 3.17 or above.
32
35
33
36
Cuda
34
37
^^^^
35
38
36
-
Xmipp supports Cuda 10 through 12.2. CUDA is optional but highly recommended. We recommend you to use the newest version available for your operating system; though Cuda 10.2 has the widest support among other Scipion plugins. Pay attention to the `compiler - CUDA compatibility <https://gist.github.com/ax3l/9489132>`_.
39
+
By default Xmippp will search your CUDA installation. Xmipp supports Cuda 10.2 through 12.2. CUDA is optional but highly recommended. We recommend you to use the newest version available for your operating system; though Cuda 10.2 has the widest support among other Scipion plugins. Pay attention to the `compiler - CUDA compatibility <https://gist.github.com/ax3l/9489132>`_.
37
40
38
41
To install CUDA for your operating system, follow the `official install guide <https://developer.nvidia.com/cuda-toolkit-archive>`_.
39
42
40
43
.. warning::
41
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.
42
45
43
-
OpenCV
44
-
^^^^^^
45
-
46
-
OpenCV is used for some programs: movie_optical_alignment (with GPU support) and volume_homogenizer; however, it is not required. If you installed OpenCV via apt (``sudo apt install libopencv-dev``), it should be automatically picked up by the Xmipp script.
47
-
48
-
HDF5
49
-
^^^^
50
-
51
-
We sometimes see issues regarding the HDF5 dependency. Please visit the `HDF5 Troubleshooting wiki <https://github.com/I2PC/xmipp/wiki/HDF5-Troubleshooting>`_.
52
-
53
46
Full list of dependencies
54
47
^^^^^^^^^^^^^^^^^^^^^^^^^
55
48
@@ -75,15 +68,6 @@ You can install these packages on Ubuntu-based systems using the following comma
75
68
76
69
Additionally, you need to install `scons` in the environment where Xmipp will be compiled. If you plan to run Xmipp within Scipion, you should install it in your Scipion3 environment. You can install `scons` using `pip`:
77
70
78
-
.. code-block:: bash
79
-
80
-
pip install scons
81
-
82
-
Finally, make sure to have a compatible compiler installed. You can install GCC 8 and G++ 8 using the following command:
83
-
84
-
.. code-block:: bash
85
-
86
-
sudo apt install gcc-8 g++-8
87
71
88
72
These requirements will ensure that your system is ready for installing and using Xmipp.
0 commit comments