=====================
Package documentation
=====================

The notebooks shown here provide “technical” documentation for specific features
of the different packages. If you are new to Ubermag you should consider
first looking at :doc:`../getting-started/index` which will give a gentle
introduction into all the packages and concepts of Ubermag.

Different calculators (OOMMF and mumax\ :sup:`3`) support different feature sets. The
:doc:`compatibility` page gives an overview of the different features. It also
lists compatible versions for Ubermag, and OOMMF, and mumax\ :sup:`3`.

.. toctree::
    :maxdepth: 1
    :caption: Packages
    :hidden:

    discretisedfield
    mag2exp
    micromagneticdata
    micromagneticmodel
    micromagnetictests
    mumax3c
    oommfc
    ubermagtable
    ubermagutil
    ubermag
    Compatibility <compatibility>

All packages are licensed under: |license|

.. |license| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
              :target: https://opensource.org/licenses/BSD-3-Clause
              :height: 18px

.. list-table::
   :header-rows: 1

   * -
     - Latest release
     - Build
     - Binder
   * - :doc:`discretisedfield`
     - |df_pypi|
       |df_anaconda|
     - |df_workflow|
       |df_coverage|
     - |df_binder|
   * - :doc:`mag2exp`
     - |m2_pypi|
       |m2_anaconda|
     - |m2_workflow|
       |m2_coverage|
     - |m2_binder|
   * - :doc:`micromagneticdata`
     - |md_pypi|
       |md_anaconda|
     - |md_workflow|
       |md_coverage|
     - |md_binder|
   * - :doc:`micromagneticmodel`
     - |mm_pypi|
       |mm_anaconda|
     - |mm_workflow|
       |mm_coverage|
     - |mm_binder|
   * - :doc:`micromagnetictests`
     - |mt_pypi|
       |mt_anaconda|
     - |mt_workflow|
       |mt_coverage|
     - |mt_binder|
   * - :doc:`mumax3c`
     - |mc_pypi|
       |mc_anaconda|
     - |mc_workflow|
       |mc_coverage|
     - |mc_binder|
   * - :doc:`oommfc`
     - |oc_pypi|
       |oc_anaconda|
     - |oc_workflow|
       |oc_coverage|
     - |oc_binder|
   * - :doc:`ubermagtable`
     - |ut_pypi|
       |ut_anaconda|
     - |ut_workflow|
       |ut_coverage|
     - |ut_binder|
   * - :doc:`ubermagutil`
     - |uu_pypi|
       |uu_anaconda|
     - |uu_workflow|
       |uu_coverage|
     - |uu_binder|
   * - :doc:`ubermag`
     - |ub_pypi|
       |ub_anaconda|
     - |ub_workflow|
       |ub_coverage|
     - |ub_binder|

.. discretisedfield
.. |df_pypi| image:: https://badge.fury.io/py/discretisedfield.svg
                     :target: https://badge.fury.io/py/discretisedfield
                     :height: 20px
.. |df_anaconda| image:: https://anaconda.org/conda-forge/discretisedfield/badges/version.svg
                         :target: https://anaconda.org/conda-forge/discretisedfield
                         :height: 20px
.. |df_workflow| image:: https://github.com/ubermag/discretisedfield/workflows/workflow/badge.svg
                         :target: https://github.com/ubermag/discretisedfield/actions?query=workflow%3Aworkflow
                         :height: 20px
.. |df_coverage| image:: https://codecov.io/gh/ubermag/discretisedfield/branch/master/graph/badge.svg?token=hcK4fofmrL
                         :target: https://codecov.io/gh/ubermag/discretisedfield
                         :height: 20px
.. |df_binder| image:: https://mybinder.org/badge_logo.svg
                       :target: https://mybinder.org/v2/gh/ubermag/discretisedfield/latest?urlpath=lab/tree/docs
                       :height: 20px

.. mag2exp
.. |m2_pypi| image:: https://badge.fury.io/py/mag2exp.svg
                     :target: https://badge.fury.io/py/mag2exp
                     :height: 20px
.. |m2_anaconda| image:: https://anaconda.org/conda-forge/mag2exp/badges/version.svg
                         :target: https://anaconda.org/conda-forge/mag2exp
                         :height: 20px
.. |m2_workflow| image:: https://github.com/ubermag/mag2exp/workflows/workflow/badge.svg
                         :target: https://github.com/ubermag/mag2exp/actions/workflows/workflow.yml
                         :height: 20px
.. |m2_coverage| image:: https://codecov.io/gh/ubermag/mag2exp/branch/master/graph/badge.svg?token=hcK4fofmrL
                         :target: https://codecov.io/gh/ubermag/mag2exp
                         :height: 20px
.. |m2_binder| image:: https://mybinder.org/badge_logo.svg
                       :target: https://mybinder.org/v2/gh/ubermag/mag2exp/latest?urlpath=lab/tree/docs
                       :height: 20px

.. micromagneticdata
.. |md_pypi| image:: https://badge.fury.io/py/micromagneticdata.svg
                     :target: https://badge.fury.io/py/micromagneticdata
                     :height: 20px
.. |md_anaconda| image:: https://anaconda.org/conda-forge/micromagneticdata/badges/version.svg
                         :target: https://anaconda.org/conda-forge/micromagneticdata
                         :height: 20px
.. |md_workflow| image:: https://github.com/ubermag/micromagneticdata/workflows/workflow/badge.svg
                         :target: https://github.com/ubermag/micromagneticdata/actions?query=workflow%3Aworkflow
                         :height: 20px
.. |md_coverage| image:: https://codecov.io/gh/ubermag/micromagneticdata/branch/master/graph/badge.svg?token=hcK4fofmrL       
                         :target: https://codecov.io/gh/ubermag/micromagneticdata
                         :height: 20px
.. |md_binder| image:: https://mybinder.org/badge_logo.svg
                       :target: https://mybinder.org/v2/gh/ubermag/micromagneticdata/latest?urlpath=lab/tree/docs
                       :height: 20px

.. micromagneticmodel
.. |mm_pypi| image:: https://badge.fury.io/py/micromagneticmodel.svg
                     :target: https://badge.fury.io/py/micromagneticmodel
                     :height: 20px
.. |mm_anaconda| image:: https://anaconda.org/conda-forge/micromagneticmodel/badges/version.svg
                         :target: https://anaconda.org/conda-forge/micromagneticmodel
                         :height: 20px
.. |mm_workflow| image:: https://github.com/ubermag/micromagneticmodel/workflows/workflow/badge.svg
                         :target: https://github.com/ubermag/micromagneticmodel/actions?query=workflow%3Aworkflow
                         :height: 20px
.. |mm_coverage| image:: https://codecov.io/gh/ubermag/micromagneticmodel/branch/master/graph/badge.svg?token=hcK4fofmrL       
                         :target: https://codecov.io/gh/ubermag/micromagneticmodel
                         :height: 20px
.. |mm_binder| image:: https://mybinder.org/badge_logo.svg
                       :target: https://mybinder.org/v2/gh/ubermag/micromagneticmodel/latest?urlpath=lab/tree/docs
                       :height: 20px

.. micromagnetictests
.. |mt_pypi| image:: https://badge.fury.io/py/micromagnetictests.svg
                     :target: https://badge.fury.io/py/micromagnetictests
                     :height: 20px
.. |mt_anaconda| image:: https://anaconda.org/conda-forge/micromagnetictests/badges/version.svg
                         :target: https://anaconda.org/conda-forge/micromagnetictests
                         :height: 20px
.. |mt_workflow| image:: https://github.com/ubermag/micromagnetictests/workflows/workflow/badge.svg
                         :target: https://github.com/ubermag/micromagnetictests/actions?query=workflow%3Aworkflow
                         :height: 20px
.. |mt_coverage| image:: https://codecov.io/gh/ubermag/micromagnetictests/branch/master/graph/badge.svg?token=hcK4fofmrL       
                         :target: https://codecov.io/gh/ubermag/micromagnetictests
                         :height: 20px
.. |mt_binder| image:: https://mybinder.org/badge_logo.svg
                       :target: https://mybinder.org/v2/gh/ubermag/micromagnetictests/latest?urlpath=lab/tree/docs
                       :height: 20px

.. mumax3c
.. |mc_pypi| image:: https://badge.fury.io/py/mumax3c.svg
                     :target: https://badge.fury.io/py/mumax3c
                     :height: 20px
.. |mc_anaconda| image:: https://anaconda.org/conda-forge/mumax3c/badges/version.svg
                         :target: https://anaconda.org/conda-forge/mumax3c
                         :height: 20px
.. |mc_workflow| image:: https://github.com/ubermag/mumax3c/workflows/workflow/badge.svg
                         :target: https://github.com/ubermag/mumax3c/actions?query=workflow%3Aworkflow
                         :height: 20px
.. |mc_coverage| image:: https://codecov.io/gh/ubermag/mumax3c/branch/master/graph/badge.svg?token=hcK4fofmrL       
                         :target: https://codecov.io/gh/ubermag/mumax3c
                         :height: 20px
.. |mc_binder| image:: https://mybinder.org/badge_logo.svg
                       :target: https://mybinder.org/v2/gh/ubermag/mumax3c/latest?urlpath=lab/tree/dmcs
                       :height: 20px

.. oommfc
.. |oc_pypi| image:: https://badge.fury.io/py/oommfc.svg
                     :target: https://badge.fury.io/py/oommfc
                     :height: 20px
.. |oc_anaconda| image:: https://anaconda.org/conda-forge/oommfc/badges/version.svg
                         :target: https://anaconda.org/conda-forge/oommfc
                         :height: 20px
.. |oc_workflow| image:: https://github.com/ubermag/oommfc/workflows/workflow/badge.svg
                         :target: https://github.com/ubermag/oommfc/actions?query=workflow%3Aworkflow
                         :height: 20px
.. |oc_coverage| image:: https://codecov.io/gh/ubermag/oommfc/branch/master/graph/badge.svg?token=hcK4fofmrL       
                         :target: https://codecov.io/gh/ubermag/oommfc
                         :height: 20px
.. |oc_binder| image:: https://mybinder.org/badge_logo.svg
                       :target: https://mybinder.org/v2/gh/ubermag/oommfc/latest?urlpath=lab/tree/docs
                       :height: 20px

.. ubermagtable
.. |ut_pypi| image:: https://badge.fury.io/py/ubermagtable.svg
                     :target: https://badge.fury.io/py/ubermagtable
                     :height: 20px
.. |ut_anaconda| image:: https://anaconda.org/conda-forge/ubermagtable/badges/version.svg
                         :target: https://anaconda.org/conda-forge/ubermagtable
                         :height: 20px
.. |ut_workflow| image:: https://github.com/ubermag/ubermagtable/workflows/workflow/badge.svg
                         :target: https://github.com/ubermag/ubermagtable/actions?query=workflow%3Aworkflow
                         :height: 20px
.. |ut_coverage| image:: https://codecov.io/gh/ubermag/ubermagtable/branch/master/graph/badge.svg?token=hcK4fofmrL       
                         :target: https://codecov.io/gh/ubermag/ubermagtable
                         :height: 20px
.. |ut_binder| image:: https://mybinder.org/badge_logo.svg
                       :target: https://mybinder.org/v2/gh/ubermag/ubermagtable/latest?urlpath=lab/tree/docs
                       :height: 20px

.. ubermagutil
.. |uu_pypi| image:: https://badge.fury.io/py/ubermagutil.svg
                     :target: https://badge.fury.io/py/ubermagutil
                     :height: 20px
.. |uu_anaconda| image:: https://anaconda.org/conda-forge/ubermagutil/badges/version.svg
                         :target: https://anaconda.org/conda-forge/ubermagutil
                         :height: 20px
.. |uu_workflow| image:: https://github.com/ubermag/ubermagutil/workflows/workflow/badge.svg
                         :target: https://github.com/ubermag/ubermagutil/actions?query=workflow%3Aworkflow
                         :height: 20px
.. |uu_coverage| image:: https://codecov.io/gh/ubermag/ubermagutil/branch/master/graph/badge.svg?token=hcK4fofmrL       
                         :target: https://codecov.io/gh/ubermag/ubermagutil
                         :height: 20px
.. |uu_binder| image:: https://mybinder.org/badge_logo.svg
                       :target: https://mybinder.org/v2/gh/ubermag/ubermagutil/latest?urlpath=lab/tree/docs
                       :height: 20px

.. ubermag
.. |ub_pypi| image:: https://badge.fury.io/py/ubermag.svg
                     :target: https://badge.fury.io/py/ubermag
                     :height: 20px
.. |ub_anaconda| image:: https://anaconda.org/conda-forge/ubermag/badges/version.svg
                         :target: https://anaconda.org/conda-forge/ubermag
                         :height: 20px
.. |ub_workflow| image:: https://github.com/ubermag/ubermag/workflows/workflow/badge.svg
                         :target: https://github.com/ubermag/ubermag/actions?query=workflow%3Aworkflow
                         :height: 20px
.. |ub_coverage| image:: https://codecov.io/gh/ubermag/ubermag/branch/master/graph/badge.svg?token=hcK4fofmrL       
                         :target: https://codecov.io/gh/ubermag/ubermag
                         :height: 20px
.. |ub_binder| image:: https://mybinder.org/badge_logo.svg
                       :target: https://mybinder.org/v2/gh/ubermag/ubermag/latest?urlpath=lab/tree/docs
                       :height: 20px