STAMP Documentation

Stereological Tools for Analysis of Microstructural Parameters

STAMP is a scientific Python package for quantitative 2-D microstructural analysis. It provides tools to load grain or precipitate measurements, apply stereological corrections to recover 3-D size distributions, compute descriptive statistics with confidence intervals, and generate publication-ready figures.

---

Installation

pip

pip install nanoshot-stamp

uv

uv add nanoshot-stamp

With Jupyter

pip install "nanoshot-stamp[notebooks]"

Or with uv:

uv add "nanoshot-stamp[notebooks]"

See Installation for full details including building from source.

---

Examples

Jupyter notebooks walking through the core STAMP workflow — loading measurements, applying stereological corrections, computing statistics, and generating publication-ready figures.

Examples

API Reference

Full documentation for all public functions and parameters across stamp.io, stamp.stereo, stamp.stats, stamp.plot, and stamp.pipeline.

stamp

Installation

Detailed installation instructions including optional extras and building from source.

Installation

Contributing

How to contribute — spec-driven development workflow, commit conventions, and the pre-commit checklist.

Contributing to STAMP

---

Citing STAMP

If you use STAMP in your research, please cite it:

@software{westraadt_stamp_2026,
  author  = {Westraadt, Johan},
  title   = {STAMP: Stereological Tools for Analysis of Microstructural Parameters},
  year    = {2026},
  url     = {https://github.com/jwestraadt/STAMP},
  license = {MIT}
}

Or use the Cite this repository button on GitHub (powered by CITATION.cff).

---