.. RadicalPy documentation master file, created by
   sphinx-quickstart on Sun Jul 31 22:31:33 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

RadicalPy: a toolbox for radical pair spin dynamics
===================================================

RadicalPy in an intuitive (object-oriented) open-source Python
framework specific to radical pair spin dynamics.

To get started take a look at the `quick start guide`_ or the
`examples`_.

The package is still under development.  Basic functionality is
implemented, `documentation`_ is sparse, testing partial.

.. _quick start guide: https://github.com/Spin-Chemistry-Labs/radicalpy/tree/main/docs/quick-start/guide.org
.. _examples: https://github.com/Spin-Chemistry-Labs/radicalpy/tree/main/examples
.. _documentation: https://radicalpy.readthedocs.io/

Installation
------------

Install simply using :code:`pip`::

   pip install radicalpy


.. toctree::
   :maxdepth: 1
   :caption: Contents:


.. include:: modules.rst


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`

.. * :ref:`search` # this search page doesn't work for some reason... might look into it once

.. toctree::
   :maxdepth: 1

   todos