.. OpenMS documentation master file

Welcome to the OpenMS documentation!
====================================

**OpenMS** is a multiscale ecosystem for solving coupled Maxwell-Schrödinger equations in Open quantum environments.

Check out the :doc:`usage` section for further information, including
how to :ref:`installation` the project.

.. note::

   This project is under active development.

.. Contents
.. --------

.. toctree::
   :caption: User guide
   :maxdepth: 1
   :numbered:

   overview.rst
   install.rst
   lib.rst
   mqed.rst
   gwf.rst
   qmc.rst
   nqs.rst
   models.rst
   qdynamics.rst
   spindynamics.rst
   fdtd.rst
   qcsolvers.rst
   solvers.rst
   examples.rst
   references.rst

..   tutorial.rst
..   usage
..   api


.. rubric:: Submodules

.. currentmodule:: openms


.. autosummary::

    mqed
    gwf
    qmc
    nqs
    qmd
    solvers
    qcsolvers
    spindy
    maxwell
    lib

*************
Release Notes
*************

Development notes and release details can be found below.

.. toctree::
   :maxdepth: 2

   notes.rst


.. only :: html

    Indices and Tables
    ==================

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

.. * :ref:`cfg-config-index`
.. * :ref:`cfg-option-index`