{"id":18750363,"url":"https://github.com/silx-kit/pyfai","last_synced_at":"2025-05-15T09:04:59.222Z","repository":{"id":3530158,"uuid":"4589509","full_name":"silx-kit/pyFAI","owner":"silx-kit","description":"Fast Azimuthal Integration in Python","archived":false,"fork":false,"pushed_at":"2025-04-12T05:45:52.000Z","size":557950,"stargazers_count":113,"open_issues_count":216,"forks_count":99,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-04-13T07:53:55.215Z","etag":null,"topics":["diffraction","python","science"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/silx-kit.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.txt","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSES.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2012-06-07T19:37:21.000Z","updated_at":"2025-04-12T05:45:57.000Z","dependencies_parsed_at":"2023-10-14T18:50:19.968Z","dependency_job_id":"ca664db6-4020-4b76-aa9b-89b364b9e0e3","html_url":"https://github.com/silx-kit/pyFAI","commit_stats":{"total_commits":6571,"total_committers":78,"mean_commits":84.24358974358974,"dds":0.5314259625627759,"last_synced_commit":"1099ef5d75c7f2d8002a2d742e8ee4ff9d5da5ed"},"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silx-kit%2FpyFAI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silx-kit%2FpyFAI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silx-kit%2FpyFAI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silx-kit%2FpyFAI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/silx-kit","download_url":"https://codeload.github.com/silx-kit/pyFAI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248890974,"owners_count":21178537,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["diffraction","python","science"],"created_at":"2024-11-07T17:11:32.955Z","updated_at":"2025-05-15T09:04:59.215Z","avatar_url":"https://github.com/silx-kit.png","language":"Python","readme":"pyFAI: Fast Azimuthal Integration in Python\n===========================================\n\nMain development website: https://github.com/silx-kit/pyFAI\n\n|Github Actions| |Appveyor Status| |myBinder Launcher| |Zenodo DOI| |RTD docs|\n\nPyFAI is an azimuthal integration library that tries to be fast (as fast as C\nand even more using OpenCL and GPU).\nIt is based on histogramming of the 2theta/Q positions of each (center of)\npixel weighted by the intensity of each pixel, but parallel version uses a\nSparseMatrix-DenseVector multiplication.\nNeighboring output bins get also a contribution of pixels next to the border\nthanks to pixel splitting.\nFinally pyFAI provides also tools to calibrate the experimental setup using Debye-Scherrer\nrings of a reference compound.\n\nReferences\n----------\n\n* The philosophy of pyFAI is described in the proceedings of SRI2012: https://doi.org/10.1088/1742-6596/425/20/202012\n* Implementation in parallel is described in the proceedings of EPDIC13: https://doi.org/10.1017/S0885715613000924\n* Benchmarks and optimization procedure is described in the proceedings of EuroSciPy2014: https://doi.org/10.48550/arXiv.1412.6367\n* Calibration procedures are described in J. Synch. Radiation (2020): https://doi.org/10.1107/S1600577520000776\n* Application of signal separation to diffraction image compression and serial crystallography. J. Appl. Cryst. (2025): https://doi.org/10.1107/S1600576724011038\n\nInstallation\n------------\n\nWith PIP\n........\n\nAs most Python packages, pyFAI is available via PIP::\n\n   pip install pyFAI[gui]\n\nIt is advised to run this in a `vitural environment \u003chttps://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments\u003e`_ .\nProvide the *--user* option to perform an installation local to your user-space (**not recommended**).\nUnder UNIX, you may have to run the command via *sudo* to gain root access and perform a system wide installation (which is **neither recommended**).\n\nWith conda\n..........\n\npyFAI is also available via conda::\n\n  conda install pyfai -c conda-forge\n\nTo install conda please see either `conda \u003chttps://conda.io/docs/install/quick.html\u003e`_ or `Anaconda \u003chttps://www.continuum.io/downloads\u003e`_.\n\nFrom source code\n................\n\nThe current development version of pyFAI can be downloaded from\n`Github \u003chttps://github.com/silx-kit/pyFAI/archive/main.zip\u003e`_.\nPresently the source code has been distributed as a zip package.\nDownload it one and unpack it::\n\n    unzip pyFAI-main.zip\n\nAll files are unpacked into the directory pyFAI-main::\n\n    cd pyFAI-main\n\nInstall dependencies::\n\n    pip install -r requirements.txt\n\nBuild it \u0026 test it::\n\n    python3 run_tests.py\n\nFor its tests, pyFAI downloads test images from the internet.\nDepending on your network connection and your local network configuration,\nyou may have to setup a proxy configuration like this (not needed at ESRF)::\n\n   export http_proxy=http://proxy.site.org:3128\n\nFinally, install pyFAI in the virtualenv after testing it::\n\n    pip install .\n\nThe newest development version can also be obtained by checking out from the git\nrepository::\n\n    git clone https://github.com/silx-kit/pyFAI.git\n    cd pyFAI\n    pip install .\n\nIf you want pyFAI to make use of your graphic card, please install\n`pyopencl \u003chttp://mathema.tician.de/software/pyopencl\u003e`_\n\nDocumentation\n-------------\n\nDocumentation can be build using this command and Sphinx (installed on your computer)::\n\n    python3 build-doc.py\n\nDependencies\n------------\n\nPython 3.9, ... 3.13 are well tested and officially supported.\nFor full functionality of pyFAI the following modules need to be installed.\n\n* ``numpy``      - http://www.numpy.org\n* ``scipy`` \t  - http://www.scipy.org\n* ``matplotlib`` - http://matplotlib.sourceforge.net/\n* ``fabio`` \t  - http://sourceforge.net/projects/fable/files/fabio/\n* ``h5py``\t     - http://www.h5py.org/\n* ``pyopencl``\t  - http://mathema.tician.de/software/pyopencl/\n* ``pyside6``\t  - https://wiki.qt.io/Qt_for_Python\n* ``silx``       - http://www.silx.org\n* ``numexpr``    - https://github.com/pydata/numexpr\n\nThose dependencies can simply be installed by::\n\n   pip install -r requirements.txt\n\n\nUbuntu and Debian-like Linux distributions\n------------------------------------------\n\nTo use pyFAI on Ubuntu/Debian the needed python modules\ncan be installed either through the Synaptic Package Manager\n(found in System -\u003e Administration)\nor using apt-get on from the command line in a terminal::\n\n   sudo apt-get install pyfai\n\nThe extra Ubuntu packages needed are:\n\n* ``python3-numpy``\n* ``python3-scipy``\n* ``python3-matplotlib``\n* ``python3-dev``\n* ``python3-fabio``\n* ``python3-pyopencl``\n* ``python3-qtpy``\n* ``python3-silx``\n* ``python3-numexpr``\n\nusing apt-get these can be installed as::\n\n    sudo apt-get build-dep pyfai\n\nMacOSX\n------\n\nOne needs to manually install a recent version of `Python` (\u003e=3.8) prior to installing pyFAI.\nApple provides only an outdated version of Python 2.7 which is now incomatible.\nIf you want to build pyFAI from sources, you will also need `Xcode` which is available from the Apple store.\nThe compiled extension will use only one core due to the limitation of the compiler.\nOpenCL is hence greately adviced on Apple systems.\nThen install the missing dependencies with `pip`::\n\n   pip install -r requirements.txt\n\n\nWindows\n-------\n\nUnder Windows, one needs to install `Python` (\u003e=3.8) prior to pyFAI.\nThe Visual Studio C++ compiler is also needed when building from sources.\nThen install the missing dependencies with `pip`::\n\n   pip install  -r requirements.txt\n\nGetting help\n------------\n\nA mailing-list, pyfai@esrf.fr, is available to get help on the program and how to use it.\nOne needs to subscribe by sending an email to sympa@esrf.fr with a subject \"subscribe pyfai\".\n\nMaintainers\n-----------\n\n* Jérôme Kieffer (ESRF)\n* Edgar Gutierrez Fernandez (ESRF)\n* Loïc Huder (ESRF)\n\nContributors\n------------\n\n* Valentin Valls (ESRF)\n* Frédéric-Emmanuel Picca (Soleil)\n* Thomas Vincent (ESRF)\n* Dimitris Karkoulis (Formerly ESRF)\n* Aurore Deschildre (Formerly ESRF)\n* Giannis Ashiotis (Formerly ESRF)\n* Zubair Nawaz (Formerly Sesame)\n* Jon Wright (ESRF)\n* Amund Hov (Formerly ESRF)\n* Dodogerstlin @github\n* Gunthard Benecke (Desy)\n* Gero Flucke (Desy)\n* Maciej Jankowski (ESRF)\n\nIndirect contributors (ideas...)\n--------------------------------\n\n* Peter Boesecke\n* Manuel Sánchez del Río\n* Vicente Armando Solé\n* Brian Pauw\n* Veijo Honkimaki\n\n.. |Github Actions| image:: https://github.com/silx-kit/pyFAI/actions/workflows/python-package.yml/badge.svg\n.. |Appveyor Status| image:: https://ci.appveyor.com/api/projects/status/github/silx-kit/pyfai?svg=true\n   :target: https://ci.appveyor.com/project/ESRF/pyfai\n.. |myBinder Launcher| image:: https://mybinder.org/badge_logo.svg\n   :target: https://mybinder.org/v2/gh/silx-kit/pyFAI/main?filepath=binder%2Findex.ipynb\n.. |RTD docs| image:: https://readthedocs.org/projects/pyfai/badge/?version=latest\n   :target: https://pyfai.readthedocs.io/en/latest/\n.. |Zenodo DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.832896.svg\n   :target: https://doi.org/10.5281/zenodo.832896\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsilx-kit%2Fpyfai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsilx-kit%2Fpyfai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsilx-kit%2Fpyfai/lists"}