API reference
=============

This page is auto-generated by ``sphinx.ext.autodoc`` from the docstrings of
the :mod:`mag4` package.

.. autosummary::
   :toctree: _autosummary
   :recursive:

   mag4

Constants and data structures
-----------------------------

.. automodule:: mag4.constants
   :members:

Geometry
--------

.. automodule:: mag4.lattice
   :members:

Reading / writing
-----------------

.. automodule:: mag4.io_cif
   :members:

.. automodule:: mag4.io_poscar
   :members:

Supercell
---------

.. automodule:: mag4.supercell
   :members:

Four-state method
-----------------

.. automodule:: mag4.symmetry
   :members:

.. automodule:: mag4.dimers
   :members:

.. automodule:: mag4.spinconfig
   :members:

VASP input generation
---------------------

.. automodule:: mag4.vasp
   :members:

WIEN2k input generation
-----------------------

.. automodule:: mag4.wien2k
   :members:

Energy parsing
--------------

.. automodule:: mag4.energy
   :members:

J-value extraction
------------------

.. automodule:: mag4.extract
   :members:

Reports and pipeline
--------------------

.. automodule:: mag4.reports
   :members:

.. automodule:: mag4.pipeline
   :members:

Sub-package :mod:`mag4.magnon`
------------------------------

.. automodule:: mag4.magnon.sublattice
   :members:

.. automodule:: mag4.magnon.qmesh
   :members:

.. automodule:: mag4.magnon.exchange
   :members:

.. automodule:: mag4.magnon.ordering
   :members:

.. automodule:: mag4.magnon.tc
   :members:

.. automodule:: mag4.magnon.kpath
   :members:

.. automodule:: mag4.magnon.dispersion
   :members:

.. automodule:: mag4.magnon.plot
   :members:

.. automodule:: mag4.magnon.report
   :members:

Sub-package :mod:`mag4.analysis`
--------------------------------

.. automodule:: mag4.analysis.bond_angles
   :members:

.. automodule:: mag4.analysis.wien2k
   :members:

Sub-package :mod:`mag4.cli`
---------------------------

.. automodule:: mag4.cli.fourstate
   :members:

.. automodule:: mag4.cli.extract
   :members:

.. automodule:: mag4.cli.magnon
   :members:

.. automodule:: mag4.cli.bond_angles
   :members:

.. automodule:: mag4.cli.extract_moments
   :members: