Skip to content

meanderpy v0.2.0

Latest

Choose a tag to compare

@zsylvester zsylvester released this 13 Feb 10:42

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 changes
    • compute_derivatives() - shapes, arc length
    • generate_initial_channel() - object creation, attributes
    • resample_centerline() - uniform spacing
    • migrate_one_step() - coordinate changes, CFL warning/clamping
    • find_cutoffs() / cut_off_cutoffs() - cutoff detection
    • get_channel_banks() - bank coordinates
    • Channel, Cutoff, ChannelBelt classes

Package Improvements

  • Added __version__ attribute to package for programmatic version access
  • Added CLAUDE.md project guide for AI-assisted development

Bug Fixes

  • Fixed deprecated np.NaNnp.nan for NumPy compatibility (PR #11)
  • Fixed download_url typo 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:

Installation

pip install meanderpy==0.2.0

Full Changelog

v0.1.9...v0.2.0