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
devandmasterbranches. (.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.