v2.4.0

[ma-sadeghi]

v2.4.0

🚀 New features

• Added polydisperse_cylinders function to beta
• Added a rectangular_pillars micro-model generator to the beta module
• Add flux and tau_from_cmap to simulations module
• Added tortuosity_gdd method to compute tortuosity using domain decomposition
• Added ramp to beta module for inclusion in generators eventually
• Added local_diff filter to beta module for inclusion in filters eventually
• Added beta module for introducing new functions which may still need tweaking
• Added pc_to_seq function
• Added pc_map_to_pc_curve function for much faster generation of pc curves from images

🍰 Enhancements

• Added several micromodels functions to the generators module
• Improved speed of cylinders 5x by using _insert_disk_at_points_parallel method instead of dilating using edt
• Sped up sphere insertions using parallelization
• Readded tic and toc functions to tools module
• Enhanced satn_profile function to accept pre-thresholded image
• Enhanced satn_profile function to throw an exception if requested saturation cannot be obtained

🔧 Maintenace

• Migrated from bump2version to hatch for resolving version number
• Refactored and updated Actions
• Deprecated Python 3.8 and 3.9
• Added linter Action: ruff
• Unified project config (pytest.ini, setup.cfg) files in pyproject.toml
• Removed pyfastnoisesimd from dependencies as it no longer works on Python 3.9+
• Migrated from setup.py to pyproject.toml
• Migrated from flat layout to the PyPA recommended src layout
• Enhanced api with type annotations and defaults
• Updated the python version coverage to include 3.11
• Tidyied up after some recent PRs
• Enhanced satn_profile function to return a Results object with data as attributes

---

This discussion was created from the release v2.4.0.