Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update changelog.rst in prevision of the release #2364

Merged
merged 4 commits into from
Jan 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 26 additions & 4 deletions doc/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,33 @@
Change-log of versions
======================

Next Version: 2025
------------------
- Refactoring of the integrator classes
- New dataclass `pyFAI.io.integration_config.WorkerConfig` which is in charge of the serialization of worker configuration.
2025.01 In time for the User-Meeting
------------------------------------

- Refactoring of the integrator classes:

* Azimuthal integrator moved to ``pyFAI.integrator.azimuthal``
* Most common code into ``pyFAI.integrator.common`` (including a lot of *deprecated* stuff)
* New sub-module dedicated to fiber/surface diffraction (``pyFAI.integrator.fiber``)
* Engine loading is now in ``pyFAI.integrator.load_engines``
* Those are all (still) sub-classes of each-other but it will change in the futrure where they will need to be **promoted** to transfer all the geometry and enable other's class feature. For example: ``ai.promote("FiberIntegrator")`` or ``ai.promote("GeometryRefinement")``

- Refactoring of the handling of the serialization of the ``pyFAI-integrate`` GUI and ``pyFAI.worker.Worker`` into a JSON file.

* Use a **dataclass** defined in ``pyFAI.io.integration_config.WorkerConfig`` to manage all parameters to configure the ``Worker``
* New format version 5, enables the handling of sigma-clip & median filtering
* Provides better compatibility with `Ewoks <https://ewoks.esrf.fr>`_

- Median filtering for 1D filtering:

* includes quantile average
* available in Python, Cython & OpenCL
* `Performances charts for sigma-clip & median filter <https://github.com/silx-kit/pyFAI/blob/main/doc/source/usage/tutorial/AzimuthalFilter.ipynb>`_.

- Tool to rebin 2d-result into 1d-result (`pyFAI.containers.rebin1d`)
- Several bug-fixes & better code coverage
- Supports python 3.8 .. 3.13. The GIL-free version on python 3.13 is untested
- Tested by the developers on Windows (amd64), linux (amd64, arm64 and ppc64le) and MacOS (amd64 and arm64). Thanks to Debian for extending this matrix.

2024.09 12/09/2024
------------------
Expand Down
4 changes: 2 additions & 2 deletions version.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@
"rc": 13,
"final": 15}

MAJOR = 2024
MINOR = 12
MAJOR = 2025
MINOR = 1
MICRO = 0
RELEV = "dev" # <16
SERIAL = 0 # <16
Expand Down
Loading