Release v0.2.0
This release includes significant new features, improvements, and bug fixes accumulated since v0.1.9 (September 2021).
New Features
CFL Stability Check
- Added CFL-style numerical stability check to prevent simulation blowup when time steps or migration rates are too large
- Migration displacement is now clamped to
cfl_factor * deltas(default 0.5) - Warnings are issued when clamping occurs, helping users tune parameters
Animation System Rewrite
- Rewrote
create_movie()to generate animations directly using matplotlib's animation framework - More efficient and flexible animation generation
Auto-Aggradation & Eclipse Export
- Added auto-aggradation feature for more realistic fluvial simulations
- Added Eclipse grid file export (
write_eclipse_grid) for reservoir modeling workflows - Improved docstrings throughout the codebase
Test Suite
- Added comprehensive test suite (
tests/test_meanderpy.py) covering:compute_curvature()- straight line, circle, sign changescompute_derivatives()- shapes, arc lengthgenerate_initial_channel()- object creation, attributesresample_centerline()- uniform spacingmigrate_one_step()- coordinate changes, CFL warning/clampingfind_cutoffs()/cut_off_cutoffs()- cutoff detectionget_channel_banks()- bank coordinatesChannel,Cutoff,ChannelBeltclasses
Package Improvements
- Added
__version__attribute to package for programmatic version access - Added
CLAUDE.mdproject guide for AI-assisted development
Bug Fixes
- Fixed deprecated
np.NaN→np.nanfor NumPy compatibility (PR #11) - Fixed
download_urltypo in setup.py (missing dot before.tar.gz)
Documentation
- Revised README with improved formatting and absolute image references
- Updated example notebook to work with latest API changes
Contributors
Thanks to contributors:
- @misaelmmorales (PR #11 - NumPy compatibility fix)
- @cyschneck (PR #10)
- @elbeejay (PR #9 - README improvements)
Installation
pip install meanderpy==0.2.0