Skip to content

Commit 3d16a78

Browse files
authored
.
1 parent eca55dd commit 3d16a78

File tree

2 files changed

+14
-42
lines changed

2 files changed

+14
-42
lines changed

docs/Installation/InstallationNotes/index.rst

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,6 @@
11
Optional Tools and Libraries
22
==============================
33

4-
CUDA
5-
-------
6-
By default Xmippp will search your CUDA installation.
7-
We recomend CUDA >=11.2. Older version of CUDA requires an older gcc
8-
(gcc-8 could be difficult to install and cause issues with the OS).
9-
Follow official `install
10-
instructions <https://developer.nvidia.com/cuda-toolkit-archive>`__. We
11-
recommend you to follow the guide for installation of CUDA 11.4 (deb
12-
(local))
13-
14-
154
DeepLearningToolkit
165
---------------------
176

@@ -120,7 +109,6 @@ Make sure you have these settings in your `configuration file <https://i2pc.gith
120109
(``xmipp-bundle/xmipp.conf``) before compiling Xmipp:
121110

122111
``XMIPP_USE_MATLAB=ON``
123-
124112
``MATLAB_DIR=<path to your MATLAB instalation>`` (usually something
125113
like: ``MATLAB_DIR=/home/user/MATLAB/R2021b``)
126114

docs/Installation/Requirements/index.rst

Lines changed: 14 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,7 @@ Requirements
33
Supported OS
44
^^^^^^^^^^^^^^^^^^^^
55

6-
We have tested Xmipp compilation on the following operating systems:
7-
- `Ubuntu 18.04 <https://github.com/I2PC/xmipp/wiki/Installing-Xmipp-on-Ubuntu-18.04>`_
8-
- `Ubuntu 20.04 <https://github.com/I2PC/xmipp/wiki/Installing-Xmipp-on-Ubuntu-20.04>`_
9-
- `Ubuntu 22.04 <https://github.com/I2PC/xmipp/wiki/Installing-Xmipp-on-Ubuntu-22.04>`_
10-
- `Centos 7 <https://github.com/I2PC/xmipp/wiki/Installing-Xmipp-on-CentOS-7-9.2009>`_
11-
Visit the OS wiki page for more details.
12-
13-
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.
147

158
Hardware requirements
169
^^^^^^^^^^^^^^^^^^^^
@@ -23,33 +16,33 @@ Software dependencies
2316
Compiler
2417
^^^^^^^^
2518

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
2730

2831
Cmake
2932
^^^^^
3033

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.
3235

3336
Cuda
3437
^^^^
3538

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>`_.
3740

3841
To install CUDA for your operating system, follow the `official install guide <https://developer.nvidia.com/cuda-toolkit-archive>`_.
3942

4043
.. warning::
4144
`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.
4245

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-
5346
Full list of dependencies
5447
^^^^^^^^^^^^^^^^^^^^^^^^^
5548

@@ -75,15 +68,6 @@ You can install these packages on Ubuntu-based systems using the following comma
7568
7669
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`:
7770

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
8771

8872
These requirements will ensure that your system is ready for installing and using Xmipp.
8973

0 commit comments

Comments
 (0)