Documentation

The documentation for Ubermag is divided into different parts.

• Getting started

This part contains a set of tutorials that introduce all basic concepts of Ubermag. We recommend that new users start here.

• Examples

This part show examples of how to solve specific physical questions using ubermag.

• Package documentation

Explanations and examples of more technical functionality of the different packages, e.g. details about plotting or mathematical operations.

• API Reference

Detailed documentation of all classes and functions of the different subpackages.

• FAQ

Short answers to common questions that might otherwise be difficult to find in the documentation.