.. uniserv documentation master file, created by
   sphinx-quickstart on Sat Dec 14 00:52:02 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

===================================
Welcome to uniserv's documentation!
===================================

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


.. toctree::
   :maxdepth: 1

This is uniserv, the program that runs on the 
`UniDrive <https://acim.nidec.com/drives/control-techniques/products/ac-drives/unidrive-m>`_
motor control devices. These devices and this application are part of the
`Insertion Device Control System <https://idcp-documentation.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
`The UniDrive Motor control system <https://idcp-documentation.sourceforge.io/unidrive.html>`_.

uniserv 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/idcs-uniserv/code uniserv

uniserv at sourceforge
======================

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

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`