Skip to content

Commit 8e07376

Browse files
authored
Merge pull request #2398 from silx-kit/Doc_1
Update index.rst
2 parents b7ea43a + 85f33e3 commit 8e07376

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

doc/source/operations/index.rst

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:Author: Jérôme Kieffer
2-
:Date: 12/09/2024
2+
:Date: 28/01/2025
33
:Keywords: Installation procedure
44
:Target: System administrators
55

@@ -22,21 +22,21 @@ Dependencies
2222

2323
PyFAI is a Python library which relies on the scientific stack (numpy, scipy, matplotlib)
2424

25-
* Python: version 3.8 or newer
25+
* Python: version 3.9 or newer
2626
* NumPy: version 1.12 or newer
2727
* SciPy: version 0.18 or newer
2828
* Matplotlib: verson 2.0 or newer
2929
* FabIO: version 0.5 or newer
3030
* h5py: version 2.10 or newer
31-
* silx: version 1.1 or newer (silx 2 for python 3.12)
31+
* silx: version 2 or newer
3232

3333
There are plenty of optional dependencies which will not prevent pyFAI from working
3434
by may impair performances or prevent tools from properly working:
3535

3636

3737
* pyopencl (for GPU computing)
3838
* fftw (for image analysis)
39-
* PyQt5 or PySide2 (for the graphical user interface)
39+
* PyQt5, PyQt6, PySide2 or PySide6 (for the graphical user interface)
4040

4141
Build dependencies:
4242
-------------------
@@ -55,7 +55,7 @@ The following compiler have been successfully tested:
5555

5656
* Linux: `gcc` and `clang` (both support OpenMP)
5757
* Windows: msvc++ (supports OpenMP)
58-
* Apple: clang modified version for mac computer without support for OpenMP, please use OpenCL for parallelization.
58+
* Apple: clang modified version for Apple computers without support for OpenMP, please use OpenCL for parallelization.
5959

6060
.. _cython: http://cython.org
6161

@@ -104,11 +104,12 @@ PyFAI comes with a test suite to ensure all core functionalities are working as
104104
105105
There are few specific options to run_tests.py:
106106

107-
* ``-x``: Disable the needing the GUI (faster)
108-
* ``-c``: Estimates the test-coverage for the project
107+
* ``-x``: Disable all tests relative to the GUI (faster)
108+
* ``-o``: Disable all tests relative to OpenCL (faster)
109+
* ``-c``: Estimates the test-coverage for the project, requires the ``coverage`` package.
109110

110111

111-
**Nota:** to run the test, an internet connection is needed as 20MB of test images need to be download.
112+
**Nota:** to run the test, an internet connection is needed as 160 MB of test images need to be download.
112113
You may have to set the environment variable *http_proxy* and *https_proxy*
113114
according to the networking environment you are in.
114115

@@ -117,7 +118,7 @@ Environment variables
117118

118119
PyFAI can use a certain number of environment variable to modify its default behavior:
119120

120-
* PYFAI_OPENCL: set to "0" to disable the use of OpenCL
121+
* PYFAI_OPENCL: set to "0" to disable the use of OpenCL, like the ``-o`` option
121122
* PYFAI_DATA: path with gui, calibrant, ...
122123
* PYFAI_TESTIMAGES: path wit test images (if absent, they get downloaded from the internet)
123124
* PYFAI_NO_LOGGING: Disable the configuration of any python logger in interactive mode

0 commit comments

Comments
 (0)