2026 Update

See new features listed in #104

Continuous Integration and Automation:

• Added a new GitHub Actions workflow (.github/workflows/tests.yml) for linting, unit tests, import checks, integration tests, documentation builds, and version checks, covering Python 3.10–3.12 and supporting Codecov integration.
• Introduced a GitHub Actions workflow to mirror the repository to GitLab on pushes to dev and master branches. (.github/workflows/mirror.yml)
• Added a comprehensive GitLab CI pipeline (.gitlab-ci.yml) supporting environment setup with mamba, linting, unit/integration/GPU tests, and automated cleanup, with rules for merge requests and main branches.

Documentation System:

• Switched ReadTheDocs to use a conda environment (docs/environment.yml) with mambaforge and improved dependency handling for documentation builds. (.readthedocs.yaml, docs/environment.yml) [1] [2]
• Enhanced Sphinx configuration to support Jupyter notebooks via nbsphinx, enable widget/Plotly rendering, and improve notebook integration in documentation. (docs/conf.py) [1] [2]
• Expanded API documentation to include new modules for interactive widgets, plotting, 3D visualization, data browsing, and phase retrieval GUIs, reflecting the new interactive features. (docs/api.rst) [1] [2] [3]
• Linked example Jupyter notebooks into documentation for better user guidance. (docs/bcdi_pipeline_example.ipynb, docs/bcdi_reconstruction_analysis.ipynb) [1] [2]

Feature and Dependency Updates:

• Updated the README to clarify PyNX installation requirements, recommend version >=2025.1, and provide detailed installation instructions for both standard and interactive usage. [1] [2]
• The changelog now details a major overhaul of interactive 3D visualization (migration to Plotly, new colorbar controls, colormap support, animation, and improved error handling), improved dependency management, and breaking changes for interactive features. (docs/changelog.rst) [1] [2]

Project Metadata and Attribution:

• Added several new authors to the citation file (CITATION.cff) for proper credit.

These changes collectively modernize the development workflow, improve documentation quality and usability, and clarify installation and usage for both users and contributors.

v.0.2.0

What's Changed

• Ortho before phasing by @clatlan in #31
• Oversampling ratio by @clatlan in #34
• 3d surface projections by @clatlan in #36
• Generic loader class by @clatlan in #39
• Create LICENSE by @clatlan in #40
• Ampl facet analysis by @clatlan in #45
• Revert "Ampl facet analysis" to give Matthieu ownership by @clatlan in #46
• Merging amplitude and facet analysis by @Manalorca in #48
• Version 3.9 does not support the function matplotlib.cm.get_cmap() by @DSimonne in #50
• clean the matplotlib import, only use matplotlib.pyplot, remove versi… by @clatlan in #51
• New loaders by @clatlan in #54
• Add interactive plotting tool by @DSimonne in #52
• Use vector graphcs instead of png by @DSimonne in #58
• Add support for perlmutter at NERSC by @DSimonne in #69
• Add trame by @DSimonne in #79
• Refacto by @clatlan in #70

New Contributors

• @Manalorca made their first contribution in #48
• @DSimonne made their first contribution in #50

Full Changelog: v.0.1.4-beta...v.0.2.0

A python package to help Coherent Diffraction Imaging (CDI) practitioners in their analysis

New beamlines are now supported (P10 and SIXS2022).

This release also corresponds to majors changes in the way data are processed. Among them, main part of orthogonalization procedure is done prior to phase retrieval. Then the parameters are saved and the orthogonalization is done on the phased data.

New parameters are available, and useless parameters no longer exist. Centering data can now be done using multiple methods.

Initial release

First release for zenodo. Not production ready yet.