TopoStats v2.1.0

The TopoStats team are pleased to announce the release of v2.1.0 🎉 . A link to the full Changelog of the commits merged since v2.0.0 can be found at the bottom of this post.

Release Highlights

• Scar removal is now available and configurable (@SylviaWhittle)
• Support for .jpk files (@MaxGamill-Sheffield)
• Support for .gwy files (@SylviaWhittle)
• Improved logging verbosity (@ns-rse)
• Area thresholding of grains (@SylviaWhittle)
• Updated bug report templates (@ns-rse)
• Median flattening quantile configurable (@SylviaWhittle)
• Dots Per Inch (DPI) of scan plots is configurable (@ns-rse)
• Improvements to documentation which is now built for multiple versions and main branch (@SylviaWhittle , @ns-rse)
• Command line option to generate sample configuration files for subsequent customisation (@ns-rse)
• Processed arrays are saved as Numpy arrays for subsequent plotting (@SylviaWhittle)

Miscellaneous

• Citation File Format file is included (@ns-rse)
• Additional pre-commit hooks (markdownlint-cli2; ruff; pyupgrade; pylint) (@ns-rse)
• pre-commit.ci is now used on pull requests to ensure code passes all pre-commit hooks for linting code prior to merging. (@ns-rse)
• Updated bug report templates (@ns-rse)
• Switched to single pyproject.toml for package configuration (@ns-rse)
• Switched from versioneer to setuptools_scm for automatic versioning (@ns-rse)
• Output is now in SI units (i.e. metres rather than nanometres) (@SylviaWhittle)

Bug fixes

Thanks to all users who reported bugs, there were quite a few (19). @SylviaWhittle and @ns-rse have worked hard to track down and correct these and we hope to have squashed them all, but expect there to be more out there waiting for you to report. Please do not hesitate to start a discussion or open a new issue.

Notebooks

We also have a set of Jupyter Notebooks available from the GitHub repository. These take you through the steps in processing scans with TopoStats that run automatically, summarising the resulting statistics using Matplotlib, and plotting the scans which are now saved as Numpy arrays.

We are working on some Notebooks to run in Google Colab, for now though you can either save the Notebooks to your computer from GitHub and run them or clone the TopoStats repository and run them from the notebook directory.

Full Changelog: v2.0.0...v2.1.0