Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 1.93 KB

README.md

File metadata and controls

28 lines (19 loc) · 1.93 KB

LImA

License Gitter Conda Version Platform

Lima ( L ibrary for Im age A cquisition) is a project for the unified control of 2D detectors. The aim is to clearly separate hardware specific code from common software configuration and features, like setting standard acquisition parameters (exposure time, external trigger), file saving and image processing.

Lima is a C++ library which can be used with many different cameras. The library also comes with a Python binding and provides a PyTango device server for remote control.

Documentation

The documentation is available here. Thank you to the people running Read the Docs for such an excellent service.

The source for the documentation is in the docs folder. Here are the instructions to built and read it locally. The documentation is built with Doxygen and Sphinx. The sphinx template is from ReadtheDocs. Breathe provides a bridge between the Sphinx and Doxygen documentation systems.

pip install --user sphinx sphinx-autobuild sphinx_rtd_theme breathe recommonmark
apt-get doxygen

cd docs  
doxygen common.dox
doxygen control.dox
doxygen hardware.dox
make html

The html documentation is generated in docs/.build/html.