Skip to content

Latest commit

 

History

History
176 lines (125 loc) · 6.86 KB

changelog.md

File metadata and controls

176 lines (125 loc) · 6.86 KB

Changelog

Changes and updates to EMD are tracked by version on this page. The format of this changelog is (mostly) based on Keep a Changelog, and this the EMD package uses Semantic Versioning.

Changes should be categorised under the following types:

  • Added for new features.
  • Changed for changes in existing functionality.
  • Deprecated for soon-to-be removed features.
  • Removed for now removed features.
  • Fixed for any bug fixes.
  • Security in case of vulnerabilities.

Where appropriate, links to specific Issues & Merge Requests on our gitlab page.

Development Version

Work in progress...

git clone https://gitlab.com/emd-dev/emd.git

Added

  • Support for Python 3.9 - requirements updated and test build added !62
  • New citations page on website (and assorted website/reference fixups) !60

Stable Versions

0.4.0

pip install emd==0.4.0

Released 2021-03-30

Notes

Many changes in this revision come from the review process at JOSS

Added

  • New tutorials
  • Second layer mask sift function 65a05dd2
  • Add html printing functionality for SiftConfig 5c57781e
  • Update contribution and installation details on website - add accordions for better readability !53
  • Add new plotting functionality for HHT and Holospectra !53
  • Show warning when max_imfs is very high compared to length of time-series 4cd15291

Changed

  • Major refactor in handling of cycles analysis !56
    • Introduce Cycles class
    • Introduce _cycles_support module
  • Renamed 'References' webpage to 'API' d8fe93b5

Fixed

  • Widespread fixing of typos and mistakes in documentation & website !52
  • Make docstrings pydocstyle compliant and add pydocstyle conventions !53
  • Large number of pylint recommended fixes 271d7937
  • Indexing typo fixed in bin_by_phase c5679432
  • Improve label alignments in plot_imfs !54

0.3.3

pip install emd==0.3.3

Released 2021-02-04

Added

  • New function for computing summary stats from chains of cycles (from marcoFabus) !46

Changed

  • Major updates to tutorials !40
    • Binder notebooks added
    • New sifting tutorials added

Fixed

  • Replaced missing dependencies in setup.py !42

0.3.2

pip install emd==0.3.2

Released 2020-11-29

Added

  • Add input array shape ensurance functions and start to use in sift & cycle submodules !26
  • Add more stopping criteria to sift module !27
    • Rilling et al and fixed iterations IMF stopping criteria
    • Energy threshold sift stopping criterion

Changed

  • Refactor some options extrema detection functions !29
  • Sift throws an error if an IMF doesn't converge after a specified maximum number of iterations.
  • Refactor mask generation in mask sift. Now specifies N masks of different phases and has options for parallel processing.
  • SiftConfig yaml file also stores which type of sift the config is for !35
  • 18% increase in testing coverage (to 75% total) !30

Deprecated

  • emd.spectra.frequency_stats renamed to emd.spectra.frequency_transform. Original func kept for now.

0.3.1

pip install emd==0.3.1

Released 2020-09-06

Added

  • This changelog !18
  • support.py submodule with some helper functions for checking installs and running tests !20
  • envs subdir containing anaconda install environment config files !21
  • Options for reading and writing sift configs to yaml format !24
  • major update to webpage !12
    • Reformat page to bootstrap
    • Add & update the tutorials
    • New landing page

Fixed

  • Input array dimensions in phase_align clarified and fixed up ef28b36c
  • Extrema opts were dropped in get_next_imf !23

Changed

  • get_control_points internal refector af153ed6

0.3.0

pip install emd==0.3.0

Released on 2020-07-22

Added

  • get_cycle_stat refectored to allow general numpy and user-specified metrics to be computed
  • Logger coverage increased, particularly in cycle.py
    • Logger exit message added

Changed

  • Major SiftConfig refactor - API & syntax now much cleaner

0.2.0

pip install emd==0.2.0

Released 2020-06-05

Added

  • Tutorials on the sift, hilbert-huang and holospectrum analyses.
  • Parabolic extrema interpolation
  • Average envelope scaling in sift
  • Testing expanded to include python 3.5, 3.6, 3.7 & 3.8

Changed

  • API in sift functions updated for compatabillity with new SiftConfig
    • Expose options for extrema padding to top level sift function
    • Sift relevant util functions moved into sift.py submodule
  • Masked sift functions merged into single function
  • get_cycle_chain refactor to cleaner internal syntax

0.1.0

pip install emd==0.1.0

Released 2019-12-10

Added

  • Everything