sottools 0.1.2

SQUID-on-tip current imaging forward and inverse modeling

SOTtools

⚠️ SOTtools is under development — API may change between minor versions, and old code may break.

SQUID based microscopy (SOT, scanning SQUID) is a powerful tool for locally imaging current distributions by mapping their magnetic fields. Interpreting these maps, however, is difficult: the SQUID singles out one particular component of the magnetic field, and inverting these maps is a difficult task.

SOTtools is a toolkit for modeling and inverting SOT measurements. It contains:

• A set of tools for generating FEM meshes and simulating current distributions on these meshes
• Tools to compute SQUID maps from current distributions
• Tools to invert SQUID maps back to current distributions

The unique feature of SOTtools is that it is sample-aware: it natively takes into account 1D and 2D sample boundaries and confines all currents to the sample.

These inversions are possible only because the forward models are implemented fully in PyTorch, which allows for autodifferentiation. The user API, however, is fully in NumPy, the standard in scientific Python.

SOTtools is still under development and contributions are welcome.

Install

SOTtools is available on PyPI and can be installed with pip:

pip install sottools

If GPU acceleration is desired, install the PyTorch version with CUDA support first, then install SOTtools.

For easier usage with Jupyter notebooks, install the optional dependencies:

pip install sottools[jupyter]

Documentation

Documentation is available at sottools.readthedocs.io