Release 2024.1.0

MR for major release 2024.1.0

Prior work

• Merge !391 (merged)
• ⚠ DISABLE buggy test_z_flip (to be re-activated once the issue is sorted out)
• Investigate issue related to z-stitch test bug
• Merge !393 (merged)
• Merge !395 (merged)
• Merge !400 (merged)
• Fix #465 (closed)
• Fix #471 (closed)
• (Bonus) Add nabu-display-timings
• Ensure near and sliding-window work as expected, i.e take estimated_cor_from_motor

Documentation

• Update Documentation
  • Changelog
  • v2024_1_0.md
  • features.md
  • index.rst
  • Notebooks
  • Update CoR doc
  • APIDoc

Release candidate

• Bump version to alpha or RC
• Upload the release candidate on pypi
• Create a fresh new environment (with automatix) with this release
• Non-regression tests (with RC) - use automatix
• (Optional) invite "friendly-users" to test this RC
• Fix possible bugs encountered in the process

Release

• Bump version to final
• Build and deploy documentation
• Create and push the tag: git tag --sign -a v20XX.Y.Z && git push origin v20XX.Y.Z
• 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 venv

/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