tobac v1.5.2

[William Jones]

Dear tobac users, 

We are pleased to announce the release of tobac v1.5.2, which is now available on conda-forge. 

The main focus of this release was the addition of the bulk statistics capability, which allows for a wide range of properties of detected objects to be calculated during feature detection, segmentation or postprocessing. The new get_statistics_from_mask function is a powerful tool that allows users to apply one or more functions to one or more data fields for each detected object. For example, one could calculate the convective mass flux for each detected feature by providing fields of vertical velocity, cloud water content and area. The tool also supports numpy broadcasting, allowing 2D and 3D data to be combined.

For examples of using this new feature, please see the bulk statistics documentation

In addition to bulk statistics, there have been a number of bug fixes, documentation updates, and enhancements included in this release:

1.5.2 Changelog:

Enhancements for Users

• Let users optionally derive bulk statistics of the data points belonging to each feature. Bulk statistics can be calulcated during feature detection, segmentation or afterwards by applying one of more functions to each feature #293
• Wrapped functions now show the correct docstring #359

Bug fixes

• Fixed an out-of-bounds error that could occur when performing segmentation with PBCs #350
• Path to data in example notebooks fixed after changes to zenodo #357
• Bulk statistics updated to use multiple fields correctly and perform numpy-style broadcasting #368
• PBCs now work when using predictive tracking #376
• Fixed error with PBC distance calculation using numba if all of min_h1, max_h1, min_h2, max_h2 were not specified, even if not calculating PBCs over one of the dimensions #384

Documentation

• Documentation on use of time_cell_min in tracking added #361
• Documentation on how thresholding is applied in segmentation update #365
• References to tobac papers updated #365

Internal Enhancements

• Type hints added for feature detection #337
• Reorganisation and addition of type hints to interal utils #241
• Type hints added for segmentation #351

Repository Enhancements

• Matrix CI testing added for multiple python versions on Linux, MacOS and Windows #353
• Issue templates with checklists added #358
• Black reformatting updated to say what is wrong #362
• Pylint CI workflow added to assess code quality and compare to base branch #373

All changes: v1.5.1...v1.5.2

Full Changelog: https://github.com/tobac-project/tobac/blob/8e827e21a4d0fb2317f0bfd70544d414ea7def50/CHANGELOG.md

Thanks,

The tobac dev team