Skip to content

Commit a63401e

Browse files
authored
.
1 parent d544b74 commit a63401e

File tree

1 file changed

+34
-29
lines changed

1 file changed

+34
-29
lines changed

docs/Installation/Requirements/index.rst

Lines changed: 34 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -59,53 +59,58 @@ To install CUDA for your operating system, follow the `official install guide <h
5959
Full list of dependencies
6060
^^^^^^^^^^^^^^^^^^^^^^^^^
6161

62-
Before installing Xmipp, you need to ensure that your system meets certain requirements. Here are the necessary packages and dependencies:
62+
Before installing Xmipp, you need to ensure your system meets certain requirements. Below is a list of required packages and dependencies.
6363

64-
- `GCC`: `compiler <https://i2pc.github.io/docs/Installation/Requirements/index.html#compiler>`_ for C
65-
- `GXX`: `Compiler <https://i2pc.github.io/docs/Installation/Requirements/index.html#compiler>`_ for C++
66-
- `libfftw3-dev`: FFTW3 library development files.
67-
- `libopenmpi-dev`: OpenMPI development files.
68-
- `libhdf5-dev`: HDF5 library development files.
69-
- `python3-numpy`: NumPy library for Python 3.
70-
- `python3-dev`: Python 3 development headers.
71-
- `libtiff5-dev`: LibTIFF development files.
72-
- `libsqlite3-dev`: SQLite3 development files.
73-
- `default-jdk`: Default Java Development Kit.
74-
- `git`: Version control system for source code management.
75-
- `cmake`: Cross-platform build system.
76-
- `libjpeg-dev`: Compress, decompress, transform JPEG images.
64+
Dependencies Automatically Installed via Scipion
65+
-------------------------------------------------
7766

67+
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:
7868

79-
You can install these packages on **Ubuntu-based** systems using the following command:
69+
- ``cmake>=3.18,<4``
70+
- ``hdf5>=1.18``
71+
- ``sqlite>=3``
72+
- ``fftw>=3``
73+
- ``make``
74+
- ``zlib``
75+
- ``openjdk``
76+
- ``libtiff``
77+
- ``libstdcxx-ng``
78+
- ``libjpeg-turbo``
8079

81-
.. Note::
82-
The the installation of the compiler is not included in the next command
80+
.. note::
81+
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>`_
8382

84-
.. code-block:: bash
83+
Manually Required Dependencies
84+
------------------------------
85+
86+
The following system-level packages **must be installed manually**, as they are not handled by Scipion:
8587

86-
sudo apt install -y libfftw3-dev libopenmpi-dev libhdf5-dev python3-numpy python3-dev libtiff5-dev libsqlite3-dev default-jdk git cmake libjpeg-dev
88+
- ``GCC``: C compiler
89+
- ``G++``: C++ compiler
90+
- ``OpenMPI`` development libraries
8791

92+
On **Ubuntu-based** systems, you can install them using:
8893

94+
.. code-block:: bash
8995
90-
Installing dependencies via **yum**
96+
sudo apt install -y gcc g++ libopenmpi-dev
9197
92-
.. Note::
93-
Note: For HDF5 to be available Extra Packages for Enterprise Linux (EPEL) repository needs to be activated in certain distros with yum install epel-release
98+
On **YUM-based** systems (e.g., CentOS, RHEL), use:
9499

95-
.. Note::
96-
Note: On CentOS-7 the gcc available by default is not compatible with Xmipp. You can enable newer gcc releases using:
100+
.. note::
101+
On CentOS 7, the default GCC version is not compatible with Xmipp. You can enable a newer GCC version using:
97102

98103
.. code-block:: bash
99-
100-
yum install centos-release-scl
101104
102-
yum install devtoolset-10
105+
yum install centos-release-scl
106+
yum install devtoolset-10
107+
scl enable devtoolset-10 bash
103108
104-
scl enable devtoolset-10 bash
109+
Then, install the dependencies:
105110

106111
.. code-block:: bash
107112
108-
yum install python3-devel python3-numpy fftw-devel openmpi-devel hdf5-devel sqlite-devel libtiff-devel libjpeg-turbo-devel java-17-openjdk-devel git cmake gcc g++
113+
yum install gcc gcc-c++ openmpi-devel
109114
110115
111116
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

Comments
 (0)