Release 0.1

[sk1p]

TODO

• Update the README #20
• Add/replace/update example notebooks; rest in More example notebooks #93
  • Simple stack reconstruction Finalize API for v0.1 and some cleanups #94
• Add high-level documentation, for both UDF and non-UDF reconstruction paths, full workflows for magnetic imaging? moved to after release
• Ensure functions are consistent (one example: aperture building functions: fft-shifted or not?)
• publish example data on zenodo: https://zenodo.org/records/15222400
• Add parameters to from_hologram function for selecting the filter order (line filter and rest of the aperture)
• Add missing features
• Fix remaining bugs (to be discussed)
• Should the reconstruction UDF consume a HoloParams object, instead of being passed individual parameters? discussion: no
• Some parts of Efficient stack reconstruction and averaging #45 that are definitely needed? Basically done in Stack alignment helper function #84
• Integration tests, CI with real data #91
• Release scripts, secrets in CI etc.

/cc @malika576 @jvvas

[sk1p]

Here's a recent code coverage report: https://app.codecov.io/gh/LiberTEM/LiberTEM-holo/commit/52c2778e14c60558d59003b08df2c3436cea6786/tree/src/libertem_holo/base?dropdown=coverage

Short summary:

• align: correlators are missing tests
• filters: missing GPU coverage (needs running of tests on a system with a GPU → JSC)
• reconstr: phase shifting holography methods need tests

[sk1p]

v0.1.0rc2 is now up at https://pypi.org/project/libertem-holo/

[sk1p]

Done, published v0.1 both on pypi and conda-forge. Documentation updates are still WIP, I'll leave this issue open until then.