API reference#
This section is generated from the docstrings in the source, and lists the
classes and functions of the three Fidimag packages, with their arguments. Use
the search box to find something by name: searching for minimise,
NEBM_Geodesic or Demag will take you to the page for that object.
fidimag.commonEverything that does not belong to a particular model: the meshes, the drivers and minimisers, the chain methods, the integrators, and the data and VTK saving.
fidimag.atomisticThe discrete spin model, its
Simclass and its energy classes.fidimag.microThe micromagnetic model, its
Simclass and its energy classes.
The physics behind the methods is described in the Magnetism and Numerical Methods section, which is the better place to start; this one is for looking up the arguments of something you already know you want.