Draft: Release 2024.2.0

MR for major release 2024.2.0

Prior work

• Update Documentation
  • Changelog
  • v2024_2_0.md
  • features.md
  • index.rst
  • Notebooks
  • APIDoc
• Merge !514 (merged) (focus-psd)
• Merge !504 (merged) (MLEM)
• Merge !518 (merged) (Debian packaging)
• "Un-break" estimation API with return_relative_to_middle=True by default

Release candidate

• Bump version to alpha or RC
• Upload the release candidate on pypi
• Create a fresh new environment with this release --> mamba activate /data/scisofttmp/paleo/nabu_2024.2.0-rc1
• Non-regression tests (with RC) - use automatix
• (Optional) invite "friendly-users" to test this RC
• Fix possible bugs encountered in the process

Release

• Ensure pyproject.toml is up to date (and depends on the latest stable release of tomoscan)
• Bump version to final
• Build and deploy documentation
• Create and push the tag: git tag --sign -a v2024.2.0 && git push origin v2024.2.0
• Deploy the final wheel on pypi

Memo

Wheels and pypi

To build the wheel and sources package:

python -m build

To upload it on testpypi:

 twine upload --repository testpypi mywheel.whl sources.tar.gz

Create a fresh environment

With cvmfs-conda: push to the main or dev branch to trigger the CI

With automatix:

/scisoft/tomotools/automatix/deployment/deploy_locally.sh <env_name>

Non-regression tests

Use automatix for non-regression tests. For example:

/scisoft/tomotools/automatix/nonregression_tests/run_nonregression_test.sh cud10 /data/scisofttmp/paleo/nabu_end2end_tests/CuD10/rec_2022.2.0-rc5/CuD10_III_400C_compression02125umps_005__rec.hdf5