The Stoner Python Package User Guide

• Introduction and Installation
  • Introduction
    • Getting the Stoner Package
    • Getting the Latest Development Code
  • Using the Development Version of the Stoner Package
  • Documentation
  • Package Options
• Loading and Examining Data
  • Loading a data file
    • The Various Flavours of the DataFile Class
    • Loading Data from a string or iterable object
    • Constructing DataFile s from Scratch
  • Examining and Basic Manipulations of Data
    • Data Structure
    • Marking Columns as Dimensions: the magic setas attribute
    • Printing the Complete DataFile
    • Working with columns of data
    • Working with complete rows of data
    • Special Magic When Working with Subsets of Data
    • Manipulating the metadata
    • More on Indexing the data
  • Modifying Data
    • Appending data
    • Working with Columns of Data
    • Deleting Rows of Data
    • Deleting Columns of Data
    • Sorting Data
    • Saving Data
    • Exporting Data to pandas
• Plotting Data
  • Quick Plots
  • Types of Plot
    • Plotting 2D data
    • Plotting 3D Data
    • Plotting 3D Scalar Fields
    • Plotting Vector Fields
  • Very Quick Plotting
  • Getting More Control on the Figure
    • Setting Axes Labels, Plot Titles and Legends
    • Plotting on Second Y (or X) Axes
  • Plot Templates
    • Making Multi-plot Figures
• Curve Fitting Data
  • Introduction
    • Why Use the Stoner Package Fitting Wrappers?
  • Simple polynomial Fits
  • Fitting Arbitrary Functions
    • Common features of the Function Fitting Methods
    • Simple function fitting
    • Fitting with limits
    • Orthogonal distance regression
    • Differential Evolution Algorithm
  • Included Fitting Models
    • Elementary Models
    • Thermal Physics Models
    • Tunnelling Electron Transport Models
    • Magnetism Related Models
    • Peak Models
    • Superconductivity Related Models
    • Other Electrical Transport Models
  • Making Fitting Models
  • Advanced Fitting Topics
    • Fitting In More than 1D
    • Non-linear curve fitting with initialisation file
• Further Manipulating and Analysis of Data
  • Normalising and Basic Maths Operations
  • Splitting Data Up
  • More AnalysisMixin Functions
    • Applying an arbitrary function through the data
    • Basic Data Inspection
  • Data Reduction Methods
    • (Re)Binning Data
    • Smoothing and Filtering Data
    • Stitching Datasets together
    • Thresholding, Interpolating and Extrapolation of Data
    • Smoothing and Differentiating Data
    • Peak Finding
• Working with Lots of Data Files
  • Basic Operations
    • Building a (virtual) Folder of Data
    • More Options on Reading the Files on Disk
    • Other Options
    • Manipulating the File List in a Folder
    • Getting a List of Files
  • Doing Something With Each File
  • Working on the Metadata
  • Sorting, Filtering and Grouping Data Files
    • Sorting
    • Filtering
    • Selecting Data
    • Grouping
  • Reducing Data
• Working with images
  • Introduction
    • ImageFile
    • Loading an Image
    • Examining and manipulating the ImageFile
    • Common Functions
    • ImageFile Representation
  • ImageArray: A numpy array like class
  • Working with Lots of Images: ImageFolder and ImageStack
• Cookbook
  • The Util module
    • The Data Class
    • Splitting Data into rising and falling values
    • Analysis of Hysteresis Loops
    • Formatting Error Values
  • Fitting Tricks
    • Fitting 3D Data
    • Fitting to Minimize a Function
  • Other Recipes
    • Extract X-Y(Z) from X-Y-Z data
    • Mapping X-Y-Z data to Z(X,Y) data
    • Sampling a A 3D Surface function
    • Quickly Sectioning a 3D dataset
• Converting Scripts from older versions
  • Python Version Support
  • Data class versus DataFile, AnalysisFile, PlotFile
  • Stoner.PlotFormats and Stoner.Plot modules removed
  • Stoner.Folders Module deprecated
  • Stoner.Fit Module deprecated
  • Stoner.FileFormats Module deprecated
  • Stoner.Image changes
    • Deprecated Image functions
  • Stoner.DataFolder/Stoner.ImageFolder changes
• Developing and Extending
  • Understanding the Class Structure
  • Adding New Data File Types
• Credits