.. id-db documentation master file, created by
   sphinx-quickstart on Fri Dec 13 20:43:27 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

=================================
Welcome to id-db's documentation!
=================================

.. image:: logo_hzb_big.png
      :align: right
      :target: http://www.helmholtz-berlin.de

.. toctree::
   :maxdepth: 1

This is the `Structured Data <https://yaml-structureddata.sourceforge.io/>`_
parameter database of the 
`Insertion Device Control Program (IDCP) <https://idcp.sourceforge.io/>`_,
that is used at the 
`Helmholtz-Zentrum Berlin <https://www.helmholtz-berlin.de>`_
to control `undulators <https://en.wikipedia.org/wiki/Undulator>`_.

Documentation of this project can be found at
`IDCP Parameters <https://idcp-documentation.sourceforge.io/idcp_db.html>`_.

id-db is part of the Insertion Device Control System, it's complete documentation
can be found here: `idcs documentation <https://idcp-documentation.sourceforge.io/>`_. 

How to download
===============

Currently you can only download the project with mercurial with this command::

  hg clone http://hg.code.sf.net/p/id-db/code id-db

id-db at sourceforge
====================

You find the sourceforge summary page here:
`id-db summary page <https://sourceforge.net/projects/id-db>`_.

There you also find the link to download the software repository.

:Author:
    Goetz Pfeiffer (Goetz.Pfeiffer@helmholtz-berlin.de, goetzpf@googlemail.com)

License and copyright
---------------------

Copyright (c) 2024 by `Helmholtz-Zentrum Berlin <https://www.helmholtz-berlin.de>`_.

This software of this project can be used under GPL v.3, see :doc:`license`.

.. Indices and tables
.. ==================
.. 
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`