.. unisim documentation master file, created by
   sphinx-quickstart on Sat Oct 11 10:28:28 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to unisim's documentation!
==================================

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

.. toctree::
   :maxdepth: 1

unisim emulates a set of 
`UniDrive <https://acim.nidec.com/drives/control-techniques/products/ac-drives/unidrive-m>`_
motor control devices that run the
`uniserv <https://idcs-uniserv.sourceforge.io/>`_
program.

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>`_.

Comprehensive documentation of this project can be found at
`The unisim application <https://idcp-documentation.sourceforge.io/unisim.html>`_.

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

You download the sources with
`mercurial <https://www.mercurial-scm.org/>`_
with this command::

  hg clone http://hg.code.sf.net/p/idcs-unisim/code unisim

Building the application
------------------------

The quick method to build the application is to run::

  ./configure.sh -v

A more comprehensive description of the various build and install options is at
`The unisim application <https://idcp-documentation.sourceforge.io/unisim.html>`_.

unisim at sourceforge
=====================

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

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

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

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

Copyright (c) 2025 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`