pySpinW API
===========

Reference for the ``pyspinw`` Python package. Modules are grouped by role;
follow any link for the detailed function and class reference.

.. currentmodule:: pyspinw

Sample and structure
--------------------

.. autosummary::
   :toctree: generated
   :nosignatures:

   sample
   basis
   site
   sitemeta
   cell_offsets
   lattice_distances
   structure
   subsystems

Exchange and Hamiltonian
------------------------

.. autosummary::
   :toctree: generated
   :nosignatures:

   exchange
   exchangegroup
   exchangemetadata
   batch_exchanges
   hamiltonian
   anisotropy

Calculations and spectroscopy
-----------------------------

.. autosummary::
   :toctree: generated
   :nosignatures:

   calculations
   polarisation
   path
   experiment
   instrument
   measurement

Symmetry and I/O
----------------

.. autosummary::
   :toctree: generated
   :nosignatures:

   symmetry
   cif
   serialisation
   loading

Utilities
---------

.. autosummary::
   :toctree: generated
   :nosignatures:

   checks
   constants
   data
   interface
   tolerances
   units
   util