All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Changelog entries for the development version are available at https://lumispy.readthedocs.io/en/latest/changelog.html
.. towncrier-draft-entries:: |release| [UNRELEASED]
- Implement correct casting of :class:`~.signals.luminescence_transientspec.LumiTransientSpectrum` to either :class:`~.signals.luminescence_spectrum.LumiSpectrum` or :class:`~.signals.luminescence_transient.LumiTransient` when the signal dimension is reduced - previously, a :class:`~hyperspy.api.signals.Signal1D` object was returned. (#205)
- Add functions :meth:`~.signals.luminescence_transientspec.LumiTransientSpectrum.spec2nav` and :meth:`~.signals.luminescence_transientspec.LumiTransientSpectrum.time2nav` to convert either signal dimension to a navigation dimension for efficient iteration over the respective axes. (#223)
- Fix axis conversion for two signal dimensions (e.g. streak camera maps) (#205)
- Various updates and improvements of the documentation (#188, #193, #196, #206, #213 , #218, #224)
- Use
towncrier
to manage changelog (#211)
- Align supported python versions (3.8-3.12) to HyperSpy 2.0 (#202)
- Fix intersphinx links to documentation of HyperSpy 2.0 and add linkchecker workflow (#203)
- CI, lint, test fixes ( #187, #209, #216)
- Streamline project files and release workflow to match HyperSpy ecosystem:
- Migrate to
pyproject.toml
fromsetup.py
- Use
setuptools-scm
to set version at build time - Adapt release workflow, e.g. mine doi only after successful upload (#211)
- Migrate to
- Add support for python 3.13 and drop support for python 3.8, update tests workflows (#225)
- Use GitHub code scanning (CodeQL) for integrity check as it replaces LGTM
- Added a centroid/center of mass functionality to analyse peak position of a spectrum (both in utils` and in LumiSpectrum`)
- Add documentation of signal tools
- Replace
sphinx.ext.imgmath
bysphinx.ext.mathjax
to fix the math rendering in the ReadTheDocs build - fix external references in the documentation
- Improved documentation
- Use lgtm.com to check code integrity
- Fix conversion to Raman shift (relative wavenumber) and make
jacobian=False
default;fix inplace=False
for axis conversions - Fix
to_eV
andto_invcm
, as slicing with .isig[] was failing on converted signals s.remove_negative
now defaults toinplace=False
(previouslyTrue
)
- Use
softprops/action-gh-release
action instead of deprecatedcreate-release
, pin action to a commit SHA
- Set up read the docs documentation
- Added metadata convention
- Add proper handling of variance on Jacobian transformation during axis conversion (eV, invcm)
- Account for the general availability of non-uniform axes with the HyperSpy v1.7 release
- Make
LumiTransient
1D and add 2DLumiTransientSpectrum
class - Add python 3.10 build, remove python 3.6
- Fix error in background dimensions that allows compatibility for updated
map
in HyperSpy (failing integration tests) - Fix for links in PyPi
- Deprecate
exposure
argument ofs.scale_by_exposure
in favor ofintegration_time
in line with metadata convention - Add deprecation warning to
remove_background_from_file
- Mentions of the now deleted
non_uniform_axes
branch in HyperSpy updated to RELEASE_next_minor - Change 'master' to 'main' branch
- Updated/corrected badges and other things in README.md and other documentation files
- This project now keeps a Changelog
- Added signal-hierarchy for time-resolved luminescence
- Added GitHub action for release
- Created logo
- Consistent black-formatting
- fixed join_spectra
- fixed tests
- The first release, basic functionality implemented