Stoner documentation¶
Stoner helps you analyse experimental measurements: load instrument data, keep metadata with your results, fit physical models, process images and apply analyses to collections of files. It was developed in the Condensed Matter Physics group at the University of Leeds.
Start here¶
Install Stoner for supported Python versions, Conda and pip commands, and optional features such as OCR.
Start working with measurements for a runnable example and short guides to loading, inspecting, selecting and editing data.
Plot results and fit curves for common analysis workflows.
Process collections or work with images for larger datasets.
Browse the cookbook for worked examples.
Main objects¶
Data represents a numerical measurement with
metadata, masks and column roles. DataFolder
groups measurements for filtering and bulk analysis.
ImageFile represents an image with metadata and
processing methods. ImageFolder groups images;
ImageStack stores them together in an array.
All five classes can be imported directly from Stoner.
Many analysis methods update the object in place and return it for chaining.
Consult the API reference for each method’s return value and use clone
when an independent copy is needed.
Guides and reference¶
For contributing, environment setup and documentation commands, see the developer’s guide. The source repository contains sample data, runnable examples and the maintenance plan.
