.. CMIstark documentation master file
   This file should at least contain the root `toctree` directive.

CMIstark documentation
======================

CMIstark_ is a software package and tool for DC Stark effect calculations of molecules in electric fields.

See [Chang2014]_ for a scientific description of version 1.0 and as a formal, citeable reference and
the `online manual`_ for further information on later versions.


User documentation
------------------

.. toctree::
   :maxdepth: 4

   installation
   user-guide
   new-molecule
   extending


Developer documentation
-----------------------

The full documentation of the source code is available in the following subpages. This includes, for
instance, available classes and methods, and their respective parameters and return values.

.. toctree::
   :maxdepth: 4

   cmistark
   developer-guide


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

.. toctree::
   :maxdepth: 1

   todolist
   references
   release-notes

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


.. _CMIstark: https://github.com/CFEL-CMI/cmistark
.. _online manual: https://cmistark.readthedocs.io

.. comment
   Local Variables:
   coding: utf-8
   mode: fly-spell
   fill-column: 100
   truncate-lines: t
   End: