********************************
PyAims programming documentation
********************************

.. contents:: index
   :local:

Overview
++++++++

.. automodule:: soma.aims


Tutorial
++++++++

There is a PyAims tutorial available as a `Jupyter/Ipython notebook <http://jupyter.org>`_:

.. ifconfig:: 'nbsphinx' in extensions

    * :download:`download tutorial notebook <pyaims_tutorial_nb.ipynb>`
    * :doc:`see it in the doc <pyaims_tutorial_nb>`

.. ifconfig:: 'nbsphinx' not in extensions

    * :download:`download tutorial notebook <pyaims_tutorial_nb.ipynb>`
    * :doc:`see it in the doc <pyaims_tutorial>`


Contents
++++++++

.. ifconfig:: 'nbsphinx' not in extensions

  .. toctree::
    :titlesonly:

    pyaims_tutorial

.. ifconfig:: 'nbsphinx' in extensions

  .. toctree::
    :titlesonly:

    pyaims_tutorial_nb.ipynb

.. toctree::
  :titlesonly:

  pyaims_highlevel
  pyaims_lowlevel
  pyaims_algo
  pyaims_examples
  pyaims_examples_advanced
  pyaims_aimsalgo
  pyaims_api_aims
  pyaims_api_aimsalgo
  pyaims_modules_api
..  pyaims_aimsalgo_examples