..  vim: filetype: rst

===================
PyDIM documentation
===================

PyDIM is a Python interface to `DIM`_. PyDIM could be used to create DIM
clients and servers, using an API very similar to the one that is used for C.

.. _DIM: http://dim.web.cern.ch/dim/

Tutorial
========

An example is worth a thousand of words, so this :ref:`tutorial` will provides
sample code of DIM clients and servers using with PyDIM.

Installation
============

Instructions for installing PyDIM can be found in :ref:`install`.

Documentation
=============

.. toctree::
    :maxdepth: 2

    install
    tutorial
    pydim-c
    dimbrowser
    changelog

Generated documentation from the C API is `also available </pydim/api/>`_.

Source code
============

The source code is hosted in the CERN's Gitlab at the address :

    https://gitlab.cern.ch/lhcb-online/pydim

The :ref:`changelog` includes a description of changes.

Documentation generation
========================

This documentation has been generated with sphix-build version **1.1.3**. Please use this version of Sphinx to generate
your future documentation::

    $ pip install sphinx==1.1.3

CSS issues happens with higher versions !

About
=====

PyDIM was originally developed by `Radu Stoica`_.

Currently it's maintained by `Niko Neufeld`_ and `Juan Manuel Caicedo`_.
Feel free to send your questions and bug reports.

.. _Radu Stoica: http://consult.cern.ch/xwho/people/652087
.. _Niko Neufeld: http://consult.cern.ch/xwho/people/417932
.. _Juan Manuel Caicedo: http://consult.cern.ch/xwho/people/681596
