Skip to content

1.7.0 - Sinuosity, Deprecation Warning
Compare
Choose a tag to compare
@cyschneck cyschneck released this 16 Aug 03:30
· 32 commits to main since this release
v1.7.0
fa39d0c

New functionality: Sinuosity

centerline-width now includes the ability to calculate the sinuosity. Sinuosity is a feature of rivers and can be indicative of meandering rivers

  • sinuosity: the total sinuosity of the river
  • incremental_sinuosity(): incremental sinuosity of the river at evenly spaced increments
Sinuosity = centerline length / straight distance from first/last point
Sinuosity = river length / straight line length of the river

Where sinuosity is broken in types:

SI < 1.05: Almost straight river
1.05 <= SI < 1.25: Winding river
1.25 <= SI < 1.5: Twisty river
1.5 <= Meandering river

Upcoming 2.0.0 Deprecation Warning

With the exception of any hot-fixes, the next release for centerline-width will be version 2.0.0. This will be a large overhaul of the package to better adhere to Pep8 Python Style best practices. This will include changes made to function and variable names. You will still be able to use the original function names, but they will now throw a DeprecationWarning and advise you to use the new function name. Eventually the old names will be deprecated and no longer usable.

All the README and documentation information will be changed to reflect the new names, but if there are any questions, feel free to submit it at the centerline-width/issues

Backwards Compatibility Conflicts

  • riverArea renamed to area for better PEP 8 clarity (most will be covered in the 2.0.0 release)
  • Distrubtion changed from setup.py to pyproject.toml

Bug fixes and README.md edits

Pytests: Tests for Python 3.10, 3.11, 3.12 against Ubuntu, macOS, Windows

Assets 2
Loading