From dd1eac5135aa3f24344b1cbf598ba116ffda1ddb Mon Sep 17 00:00:00 2001 From: Jerome Kieffer Date: Tue, 14 May 2024 09:06:11 +0200 Subject: [PATCH 1/4] skip test on cp38-win_amd64 --- .github/workflows/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 50c07ba21..a306b9834 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -125,7 +125,7 @@ jobs: CIBW_TEST_COMMAND: python -c "import pyFAI.test, sys; sys.exit(pyFAI.test.run_tests())" # Skip tests for emulated architectures # and Python3.8 on macos/arm64 (https://github.com/pypa/cibuildwheel/pull/1169) - CIBW_TEST_SKIP: "*-*linux_{aarch64,ppc64le,s390x} cp38-macosx_arm64" + CIBW_TEST_SKIP: "*-*linux_{aarch64,ppc64le,s390x} cp38-macosx_arm64 cp38-win_amd64" WITH_QT_TEST: "False" # skip GUI tests PYFAI_OPENCL: "False" # skip GPU tests PYFAI_LOW_MEM: "True" # skip all tests >100Mb From f3e0431b5dff70865edd8af7477fed73f6aacd8f Mon Sep 17 00:00:00 2001 From: Jerome Kieffer Date: Tue, 14 May 2024 11:18:10 +0200 Subject: [PATCH 2/4] skip all tests under windows --- .github/workflows/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a306b9834..3b702f2bb 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -125,7 +125,7 @@ jobs: CIBW_TEST_COMMAND: python -c "import pyFAI.test, sys; sys.exit(pyFAI.test.run_tests())" # Skip tests for emulated architectures # and Python3.8 on macos/arm64 (https://github.com/pypa/cibuildwheel/pull/1169) - CIBW_TEST_SKIP: "*-*linux_{aarch64,ppc64le,s390x} cp38-macosx_arm64 cp38-win_amd64" + CIBW_TEST_SKIP: "*-*linux_{aarch64,ppc64le,s390x} cp38-macosx_arm64 cp3*-win_amd64" WITH_QT_TEST: "False" # skip GUI tests PYFAI_OPENCL: "False" # skip GPU tests PYFAI_LOW_MEM: "True" # skip all tests >100Mb From c43df36e919b1578a56c92a0f04ef17fb4a8257b Mon Sep 17 00:00:00 2001 From: Jerome Kieffer Date: Thu, 16 May 2024 17:18:00 +0200 Subject: [PATCH 3/4] Upgrade the windows runner to 2022 Let's see if the binaries produced are working --- .github/workflows/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 3b702f2bb..a1d4f18a8 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -94,7 +94,7 @@ jobs: cibw_archs: "aarch64" - os: ubuntu-20.04 cibw_archs: "ppc64le" - - os: windows-2019 + - os: windows-2022 cibw_archs: "auto64" - os: macos-11 cibw_archs: "x86_64" From b43d9b31a2ac61c6684a4cbc7e1f03cbcbd649e0 Mon Sep 17 00:00:00 2001 From: Jerome Kieffer Date: Thu, 16 May 2024 17:53:48 +0200 Subject: [PATCH 4/4] Update README.rst --- README.rst | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/README.rst b/README.rst index a5e4dbe92..76fb5a8e0 100644 --- a/README.rst +++ b/README.rst @@ -33,11 +33,9 @@ As most Python packages, pyFAI is available via PIP:: pip install pyFAI[gui] -It is advised to run this in a vitural environment. -Provide the *--user* to perform an installation local to your user (not recommended). -Under UNIX, you may have to run the command via *sudo* to gain root access an -perform a system wide installation (neither recommended). - +It is advised to run this in a `vitural environment `_ . +Provide the *--user* option to perform an installation local to your user-space (**not recommended**). +Under UNIX, you may have to run the command via *sudo* to gain root access and perform a system wide installation (which is **neither recommended**). With conda .......... @@ -51,40 +49,41 @@ To install conda please see either `conda `_. Presently the source code has been distributed as a zip package. Download it one and unpack it:: unzip pyFAI-main.zip -As developement is also done on Github, -`development branch is also available `_ - All files are unpacked into the directory pyFAI-main:: cd pyFAI-main +Install dependencies:: + + pip install -r requirements.txt + Build it & test it:: python3 run_tests.py For its tests, pyFAI downloads test images from the internet. Depending on your network connection and your local network configuration, -you may have to setup a proxy configuration like this (no more needed at ESRF):: +you may have to setup a proxy configuration like this (not needed at ESRF):: export http_proxy=http://proxy.site.org:3128 Finally, install pyFAI in the virtualenv after testing it:: - pip install --upgrade . + pip install . The newest development version can also be obtained by checking out from the git repository:: git clone https://github.com/silx-kit/pyFAI.git cd pyFAI - pip install --upgrade . + pip install . If you want pyFAI to make use of your graphic card, please install `pyopencl `_ @@ -94,15 +93,12 @@ Documentation Documentation can be build using this command and Sphinx (installed on your computer):: - pip install -r requirements.txt python3 build-doc.py - Dependencies ------------ -Python 3.7, ... 3.11 are well tested and officially supported. -For python 3.12, it requires silx version 2 which is still unreleased for now. +Python 3.7, ... 3.12 are well tested and officially supported. For full functionality of pyFAI the following modules need to be installed. * ``numpy`` - http://www.numpy.org @@ -149,7 +145,9 @@ using apt-get these can be installed as:: MacOSX ------ -One needs to install `Python` (>=3.7) and `Xcode` prior to start installing pyFAI. +One needs to manually install a recent version of `Python` (>=3.7) prior to installing pyFAI. +Apple provides only an outdated version of Python 2.7 which is now incomatible. +If you want to build pyFAI from sources, you will also need `Xcode` which is available from the Apple store. The compiled extension will use only one core due to the limitation of the compiler. OpenCL is hence greately adviced on Apple systems. Then install the missing dependencies with `pip`:: @@ -160,7 +158,8 @@ Then install the missing dependencies with `pip`:: Windows ------- -Under Windows, one needs to install `Python` (>=3.7) and the Visual Studio C++ compiler. +Under Windows, one needs to install `Python` (>=3.7) prior to pyFAI. +The Visual Studio C++ compiler is also needed when building from sources. Then install the missing dependencies with `pip`:: pip install -r requirements.txt @@ -176,11 +175,12 @@ Maintainers ----------- * Jérôme Kieffer (ESRF) +* Edgar Gutierrez Fernandez (ESRF) +* Maciej Jankowski (ESRF) Contributors ------------ -* Edgar Gutierrez Fernandez (ESRF) * Valentin Valls (ESRF) * Frédéric-Emmanuel Picca (Soleil) * Thomas Vincent (ESRF)