Skip to main content
Ctrl+K
ubermag  documentation - Home ubermag  documentation - Home
  • Demo
  • Installation
  • Documentation
  • Changelog
  • Help
  • Contributing
  • News
  • GitHub
  • Demo
  • Installation
  • Documentation
  • Changelog
  • Help
  • Contributing
  • News
  • GitHub

Section Navigation

  • Getting started
    • Python basics
    • Jupyter lab
    • Our first ubermag simulation
    • Magnetisation field
    • Energy equation
    • Dynamics equation
    • Analysing simulation results: Domain wall pair conversion
    • Unit Conversions
  • Examples
    • Standard problem 3
    • Standard problem 4
    • Standard problem 5
    • FMR standard problem
    • Deriving energy values
    • Calculating a stray field using an airbox method
    • Skyrmion in a disk
    • Current induced domain wall motion using STT
    • Choosing runner
    • Energy term computations
    • Field operations 2
    • Simulation at finite temperature
    • Fixed subregions
    • Hysteresis simulations
    • Multiple energy terms of the same class
    • Negative exchange energy constant
    • Periodic boundary conditions
    • RKKY energy term
    • Sine-hysteresis
    • Both spatially and time varying field
    • Spatially varying parameters 1
    • Spatially varying parameters 2
    • Time-varying field
    • Time-dependent fields and currents
  • Package documentation
    • discretisedfield
      • Region basics
      • Region visualisation
      • Region facing surfaces
      • Mesh basics
      • Mesh visualisation
      • Mesh plane and line
      • Mesh subregions
      • Mesh widgets
      • Mesh pad
      • Mesh boundary conditions
      • Defining a uniform field
      • Spatially varying fields
      • Field normalisation
      • Field Valid
      • Field operations
      • Visualising field using matplotlib
      • Field visualisation using k3d
      • Field visualisation using pyvista
      • Visualising field using holoviews
      • Reading and writing fields
      • FFT Tutorial with discretisedfield
      • Importing/Exporting field from/to xarray.DataArray
      • Field rotation
      • Field tools
      • Line object
      • ovf2vtk tool
    • mag2exp
      • DC magnetometry
      • Torque magnetometry
      • Lorentz Transmission Electron Microscopy
      • Using Rotations with mag2exp
      • Magnetic Force Microscopy
      • X-ray Holography
      • Small Angle X-ray Scattering
      • Small Angle Neutron Scattering
    • micromagneticdata
      • Analysing simulation results
      • Interactive plots
    • micromagneticmodel
      • Deriving an energy term
      • Deriving a dynamics term
      • Term parameters
      • Energy terms and energy equation
      • Dynamics terms and dynamics equation
      • Multiple energy terms of the same class
      • Deriving evolver and driver classes
      • Defining micromagnetic system
      • Constants
    • micromagnetictests
      • Usage
    • mumax3c
    • oommfc
      • Tutorial 01: Zeeman energy term
      • Tutorial 02: Exchange energy term
      • Tutorial 03: Uniaxial anisotropy energy term
      • Tutorial 04: Dzyaloshinskii-Moriya energy term
      • Tutorial 05: Cubic anisotropy energy term
      • MinDriver steps
      • Custom directory name
      • Controlling the default runner
      • Running simulations in parallel
      • Verbosity levels
    • ubermagtable
      • Table basics
      • Table merge
      • Table visualisation
      • Table widgets
      • Table interactive plot
      • Table FFT
    • ubermagutil
      • Imposing typesystem on a class
      • Constant attributes
      • Parameter descriptor
      • Defining otherwise type
      • Extracting the SI prefix
      • inherit_docs decorator
      • Hysteresis values
      • Logging control
    • ubermag
      • Collecting debug information
      • HDF5 specification in Ubermag
    • Compatibility
  • API Reference
    • discretisedfield
      • Field
      • FieldRotator
      • Line
      • Mesh
      • Region
      • discretisedfield.integrate
      • discretisedfield.interact
      • discretisedfield.test
    • mag2exp
      • mag2exp.test
    • micromagneticdata
      • AbstractDrive
      • CombinedDrive
      • Data
      • Drive
      • Mumax3Drive
      • OOMMFDrive
      • micromagneticdata.test
    • micromagneticmodel
      • CubicAnisotropy
      • DMI
      • Damping
      • Demag
      • Driver
      • Dynamics
      • DynamicsTerm
      • Energy
      • EnergyTerm
      • Evolver
      • Exchange
      • ExternalDriver
      • ExternalRunner
      • MagnetoElastic
      • Precession
      • RKKY
      • Slonczewski
      • System
      • UniaxialAnisotropy
      • Zeeman
      • ZhangLi
      • micromagneticmodel.test
    • micromagnetictests
      • micromagnetictests.get_tests
      • micromagnetictests.test
    • mumax3c
      • mumax3c.runner
      • MinDriver
      • RelaxDriver
      • TimeDriver
      • mumax3c.delete
      • mumax3c.test
      • mumax3c.test_docker
    • oommfc
      • oommfc.runner
      • CGEvolver
      • Driver
      • EulerEvolver
      • HysteresisDriver
      • MinDriver
      • RungeKuttaEvolver
      • SpinTEvolver
      • SpinXferEvolver
      • TimeDriver
      • UHH_ThetaEvolver
      • Xf_ThermHeunEvolver
      • Xf_ThermSpinXferEvolver
      • oommfc.compute
      • oommfc.delete
      • oommfc.test
      • oommfc.test_docker
    • ubermag
      • ubermag.debug_info
      • ubermag.test
    • ubermagtable
      • Table
      • ubermagtable.interact
      • ubermagtable.test
    • ubermagutil
      • ubermagutil.changedir
      • ubermagutil.hysteresis_values
      • ubermagutil.inherit_docs
      • ubermagutil.setup_logging
      • ubermagutil.test
  • FAQ
  • Documentation
  • API Reference

API Reference#

discretisedfield

Finite-difference fields.

mag2exp

Simulate experimental measurements.

micromagneticdata

Analyse micromagnetic data.

micromagneticmodel

Domain-specific language for computational magnetism.

micromagnetictests

Test computational magnetism tools.

mumax3c

Mumax3 calculator.

oommfc

OOMMF calculator.

ubermag

Meta package for the Ubermag project.

ubermagtable

Manipulation of tabular data.

ubermagutil

Utilities used across Ubermag.

previous

Compatibility: Ubermag - OOMMF - mumax3

next

discretisedfield

This Page

  • Show Source

© Copyright 2016–2024, Ubermag developers.

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.1.