.. spinanalysis documentation master file, created by
   sphinx-quickstart on Thu Jul 23 10:51:19 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

spinanalysis
============

``spinanalysis`` is a high-level Python framework for the analysis of
electron paramagnetic resonance (EPR) spectra.

The framework provides modules for loading, processing, plotting, simulating,
optimizing, and saving EPR spectra. It is designed to support complete
analysis workflows from experimental data to simulated and fitted spectra.

.. important::

   The simulation routines for spin-correlated, singlet-born radical pairs,
   out-of-phase ESEEM signals, and transiently coupled systems are currently
   provided through external dependencies.

.. toctree::
   :maxdepth: 2
   :caption: Contents

   introduction
   installation
   examples
   api
   development
   contributing
   license