Version 1.3 release candidate

[w-k-jones]

Merging changes for the version 1.3 release from dev into main.

Changelog:

Enhancements

• Significant performance improvements for tracking Added tracking speedups #89
• Significant performance improvements for feature detection and segmentation Feature Detection Speedups #90
• Performance improvement for calculate_area Speedups for calculate area #93
• Added ability to set a user defined stub cell value instead of np.nan. Default value is -1 and stub cell values are now integers instead of floats by default Added the ability to set a custom stub cell value instead of np.nan #74
• Added deprecation warnings for parameters min_num in feature detection and d_min in tracking, and added exceptions when multiple, incompatible parameters are given (e.g. d_max and v_max) Parameter warnings #107

Bug fixes

• Fixed level parameter in segmentation, as this previously had no effect Fixed level parameter in segmentation to work and added segmentation tests #92
• Remove is comparisons for string literals Remove is comparisons with a string literal #99
• Added missing raise for exception in get_spacings added missing 'raise' in get_spacings to actually raise ValueError #105
• Remove automatic setting of matplotlib backend to agg on import Remove setting backend to agg automatically #100
• Fix deprecation warnings for changed import paths in dependencies Fix depreciation warnings that we can fix #110

Documentation

• Added recommended python style Recommended Python Style #72
• Updated author list and email addresses Update version number #109

Repository enhancements

• Black formatting of all python code and formatting check in actions Black formatting of existing code and inclusion of formatting check in workflow #78
• Pre-commit hook for black formatting Set up pre-commit for black formatting #96

Please let me know if there are any addition issues/PRs that need adding before updating the main branch!

[w-k-jones]

Changelog:

Enhancements

• Significant performance improvements for tracking Added tracking speedups #89
• Significant performance improvements for feature detection and segmentation Feature Detection Speedups #90
• Performance improvement for calculate_area Speedups for calculate area #93
• Added ability to set a user defined stub cell value instead of np.nan. Default value is -1 and stub cell values are now integers instead of floats by default Added the ability to set a custom stub cell value instead of np.nan #74
• Added deprecation warnings for parameters min_num in feature detection and d_min in tracking, and added exceptions when multiple, incompatible parameters are given (e.g. d_max and v_max) Parameter warnings #107

Bug fixes

• Fixed level parameter in segmentation, as this previously had no effect Fixed level parameter in segmentation to work and added segmentation tests #92
• Remove is comparisons for string literals Remove is comparisons with a string literal #99
• Added missing raise for exception in get_spacings added missing 'raise' in get_spacings to actually raise ValueError #105
• Remove automatic setting of matplotlib backend to agg on import Remove setting backend to agg automatically #100
• Fix deprecation warnings for changed import paths in dependencies Fix depreciation warnings that we can fix #110

Documentation

• Added recommended python style Recommended Python Style #72
• Updated author list and email addresses Update version number #109

Repository enhancements

• Black formatting of all python code and formatting check in actions Black formatting of existing code and inclusion of formatting check in workflow #78
• Pre-commit hook for black formatting Set up pre-commit for black formatting #96

[JuliaKukulies]

Looks all good to me - good job! Also tested the pre-commit since I somehow missed that one, but that was a nice addition and works well.

[JuliaKukulies]

I just thought of a small thing - will you add the changelog in the repo or do you think it is enough to have it here? Could be nice for users with a small release note and overview what is different from the previous tobac version. But maybe that is not as important for the minor releases as for the bigger ones.

[w-k-jones]

Good point, I'll create and add a changelog.md file that we can continue updating in future