tobac v1.4.0 Release

17 views
Skip to first unread message

sean.f...@colostate.edu

unread,
Nov 18, 2022, 11:53:46 AM11/18/22
to tobac

Hi tobac users, 

We are happy to announce the release of tobac v1.4.0. This is a major feature release, with many improvements to the scientific capabilities of tobac and the documentation and ease of use.

The new features headlining this release are the addition of the ability to detect feature mergers and splits (primarily contributed by Kelcy Brunner and Eric Bruning at Texas Tech), incorporation of spectral filtering for feature detection (primarily contributed by Julia Kukulies at Gothenburg), and substantial improvements to the documentation (primarily contributed by Nils Pfeifer and Fabian Senf at TROPOS and Sean Freeman at Colorado State). Other updates include bug fixes, clarifications on using some functions, and new documentation on using tobac with big data.

To update to tobac v1.4.0, you can `conda update -c conda-forge tobac` or whatever is appropriate for your package manager. Feel free to join the development efforts on GitHub here: https://github.com/tobac-project/tobac or on Slack through this link: https://join.slack.com/t/tobac-dev/shared_invite/zt-1k8tgje01-~MtaClSmEAnr_2NsJRSuYg . Also, if you know any tobac users that aren't on this mailing list, please encourage them to subscribe so that they can get the latest news.

Changelog:

Enhancements

  • Added the ability to detect feature mergers and splits (#136)
  • Added spectral filtering of input data to feature detection (#137)
  • Substantial improvements to documentation (#138, #150, #155, #173, #189, #195, #197)
  • Added a new function to combine feature dataframes when feature detection is run in parallel (#186)

Bug fixes

  • Reset the adaptive search parameters back to default when using adaptive trackpy tracking (#168)
  • Added checks to make sure that both adaptive_step and adaptive_stop are set when using adaptive tracking (#168)
  • Added error raising when trying to use the not yet implemented extrapolation feature (#177)
  • Fixed a bug where min_distance did not work in feature detection (#187)
  • Fixed a bug where feature detection output different feature locations depending on the order that thresholds are passed in (#199)

Documentation

  • Updated docstrings to NumPy format (#138, #155, #173)
  • Enabled API documentation generation (#150)
  • Enhanced documentation of feature detection and segmentation parameters (#150)
  • Added contributors to zenodo (#139)
  • Added __version__ as a parameter (#175)
  • Updated the feature detection docstrings to add clarification around units (#189)
  • Added documentation on why sometimes no features are segmented (#195)
  • Added updates to README file, including linking the google groups (#162, #197)

Repository enhancements

  • Specified the version of black to use for validating formatting during CI (#161)
  • Lowered threshold before code coverage CI fails on pull requests (#159)

Deprecations

  • Support for Python 3.6 and earlier is now deprecated and will be removed in v1.5.0 (#193)

Thanks,

The tobac dev team

Reply all
Reply to author
Forward
0 new messages