Merging RC_v1.4.0 into main

[freemansw1]

Release merge. Changelog added into CHANGELOG.md and below. Note that #185 will be closed when I update the feedstock.

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)

[codecov]

Codecov Report

Base: 32.49% // Head: 39.22% // Increases project coverage by +6.73% 🎉

Coverage data is based on head (365f005) compared to base (201e74f).
Patch coverage: 82.07% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #203      +/-   ##
==========================================
+ Coverage   32.49%   39.22%   +6.73%     
==========================================
  Files          11       11              
  Lines        2056     2246     +190     
==========================================
+ Hits          668      881     +213     
+ Misses       1388     1365      -23     

Flag	Coverage Δ
unittests	39.22% <82.07%> (+6.73%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
tobac/analysis.py	7.91% <ø> (ø)
tobac/centerofgravity.py	6.25% <ø> (ø)
tobac/plotting.py	3.08% <ø> (+<0.01%)	⬆️
tobac/segmentation.py	75.24% <ø> (ø)
tobac/feature_detection.py	80.76% <38.88%> (+6.67%)	⬆️
tobac/__init__.py	92.30% <66.66%> (-7.70%)	⬇️
tobac/utils.py	48.28% <70.00%> (+7.25%)	⬆️
tobac/tracking.py	65.13% <85.71%> (+4.08%)	⬆️
tobac/merge_split.py	95.41% <95.41%> (ø)
tobac/testing.py	94.55% <100.00%> (+10.38%)	⬆️
... and 5 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[JuliaKukulies]

Looks gorgeous! Thanks for putting all this together and for driving the development to this new version @freemansw1! And thanks for your great great contributions @kelcyno and @snilsn

[snilsn]

Happy to approve this, @freemansw1! Thanks to all for the great teamwork