index.rst 2.71 KB
Newer Older
Samuel Debionne's avatar
Samuel Debionne committed
1
.. LImA documentation master file, created by
2 3 4 5 6
   sphinx-quickstart on Fri Feb 18 10:19:02 2011.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

====================================
Samuel Debionne's avatar
Samuel Debionne committed
7
LImA : Library for Image Acquisition
8
====================================
Samuel Debionne's avatar
Samuel Debionne committed
9
LImA (stands for **L** ibrary for **Im** age **A** cquisition) is a project for the unified control of 2D detectors. It is used in production in `ESRF Beamlines <https://www.esrf.eu/about/synchrotron-science/beamline>`_ and in other places.
10

Samuel Debionne's avatar
Samuel Debionne committed
11
The architecture of the library aims at clearly separating hardware specific code from common software configuration and features, like setting standard acquisition parameters (exposure time, external trigger), file saving and image processing.
12

Samuel Debionne's avatar
Samuel Debionne committed
13
LImA is a C++ library but the library also comes with a Python_ binding. A PyTango_ device server for remote control is provided as well.
14

Samuel Debionne's avatar
Samuel Debionne committed
15
We provide Conda binary package for Windows and Linux for some cameras. Check out our `Conda channel <https://anaconda.org/esrf-bcu>`_.
16

Samuel Debionne's avatar
Samuel Debionne committed
17
LImA is a very active project and many developments are ongoing and available from `GitHub <https://github.com/esrf-bliss/LImA>`_. You can find stable version releases through git branches and tags on `Github releases <https://github.com/esrf-bliss/LImA/releases>`_.
18

Samuel Debionne's avatar
Samuel Debionne committed
19 20 21 22 23
If you want to get in touch with the LIMA community, please send an email to lima@esrf.fr. You may also want to subscribe to our mailing list by sending a message to `sympa@esrf.fr <mailto:sympa@esrf.fr?subject=subscribe%20lima>`_ with ``subscribe lima`` as subject.

For the latest changes, refers to the :download:`Release Notes <../ReleaseNotes.txt>`.

Note that this documentation is also available in `pdf`_ and `epub`_ format.
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38

.. _compilation:

.. _installation:

.. toctree::
  :maxdepth: 3
  :caption: Installation

  requirements
  build_install
  install_tango_device_server

.. toctree::
  :maxdepth: 2
Samuel Debionne's avatar
Samuel Debionne committed
39
  :caption: Getting Started
40

Samuel Debionne's avatar
Samuel Debionne committed
41 42 43
  user/overview
  user/concepts
  user/tutorial
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

.. toctree::
  :maxdepth: 2
  :caption: Cameras

  supported_cameras
  future_cameras

.. toctree::
  :maxdepth: 3
  :caption: Applications

  applications/cli/doc/index
  applications/tango/python/doc/index

.. toctree::
  :maxdepth: 3
Samuel Debionne's avatar
Samuel Debionne committed
61
  :caption: Camera Plugin developer guide
62

Samuel Debionne's avatar
Samuel Debionne committed
63
  plugin/index
64 65 66

.. toctree::
  :maxdepth: 1
Samuel Debionne's avatar
Samuel Debionne committed
67
  :caption: Reference Documentation
68 69 70

  cpp_api
  python_api
Samuel Debionne's avatar
Samuel Debionne committed
71 72 73 74
  
.. toctree::
  :maxdepth: 2
  :caption: How to contribute
75

Samuel Debionne's avatar
Samuel Debionne committed
76
  howto_contribute
77

78 79
.. _pdf: http://readthedocs.org/projects/lima-doc/downloads/pdf/latest/
.. _epub: http://readthedocs.org/projects/lima-doc/downloads/epub/latest/
80 81 82 83
.. _release notes: ./ReleaseNotes.txt

.. _Python: http://python.org
.. _PyTango: http://github.com/tango-cs/pytango