Commit a4c07c65 authored by Samuel Debionne's avatar Samuel Debionne

Merge improve-doc branch from documentation submodule

parent 29e1ab6d
Pipeline #2667 failed with stages
in 11 seconds
This diff is collapsed.
# Makefile for Sphinx documentation
# You can set these variables from the command line.
SPHINXBUILD = sphinx-build
BUILDDIR = .build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
-rm -rf $(BUILDDIR)/*
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
@echo "Build finished; now you can process the pickle files."
@echo "Build finished; now you can process the JSON files."
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Lima.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Lima.qhc"
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
"run these through (pdf)latex."
@echo "The overview file is in $(BUILDDIR)/changes."
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
\ No newline at end of file
\ No newline at end of file
.. _build_installation:
Build and Install
Using scripts
The ``install`` scripts will run cmake, compile and install.
It accepts input arguments (see below) but it also uses a configuration file ``scripts/config.txt``. Feel free to update this file for setting a permanent configuration for your own installation.
For Linux:
.. code-block:: bash
[--install-prefix=<desired installation path>]
[--install-python-prefix=<desired python installation path>]
For Windows:
.. code-block:: bash
[--install-prefix=<desired installation path>]
[--install-python-prefix=<desired python installation path>]
The ``--git`` (Linux only) option can be used to clone the required submodules as a prerequisite. Otherwise you should install the submodules manually with git commands, for instance::
$ git submodule init third-party/Processlib
$ git submodule init camera/basler
$ git submodule init applications/tango/python
$ git submodule update
Options are ``<camera-name> <saving-format> python pytango-server``:
``<camera-name>`` can be a combination of any of the following options::
``<saving-format>`` can be a combination of any of the following options::
``python`` will install the python module
``pytango-server`` will install the PyTango_ server
For example, to install the basler camera, use the TIFF output format, the python binding and the TANGO server, one would run:
.. code-block:: bash
$ sudo --git --install-prefix=./install --install-python-prefix=./install/python tiff basler python pytango-server
Using CMake
Install first the project submodules:
.. code-block:: bash
git submodule init third-party/Processlib
git submodule init camera/basler
git submodule init applications/tango/python
git submodule update
Run ``cmake`` in the build directory:
.. code-block:: bash
mkdir build
cd build
cmake ..
[-G "Visual Studio 15 2017 Win64" | -G "Visual Studio 15 2017" | -G "Unix Makefiles"]
[-DCMAKE_INSTALL_PREFIX=<desired installation path>]
[-DPYTHON_SITE_PACKAGES_DIR=<desired python installation path>]
Then compile and install:
.. code-block:: bash
cmake --build
sudo cmake --build --target install
May you need to update your environment?
If you have changed the default destination path for both libraries and python modules you should update
your environment variables.
For Linux:
.. code-block:: bash
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<my-new-install-dir>/Lima/lib
export PYTHONPATH=$PYTHONPATH:<my-new-install-dir>
For Windows:
.. code-block:: bash
set PATH=%PATH%;<my-new-install-dir>\Lima\lib
set PYTHONPATH=%PYTHONPATH%;<my-new-install-dir>
or update the system wide variables PATH for the libraries and PYTHONPATH for python.
.. _PyTango:
\ No newline at end of file
# -*- coding: utf-8 -*-
# Lima documentation build configuration file, created by
# sphinx-quickstart on Fri Feb 18 10:19:02 2011.
# This file is execfile()d with the current directory set to its containing dir.
# Note that not all possible configuration values are present in this
# autogenerated file.
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os, subprocess
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
# Read The Docs.
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
# -- RunDoxygen first thing ------------------------------------------------
if read_the_docs_build:'doxygen control.dox; doxygen hardware.dox', shell=True)
# -- General configuration -----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.ifconfig',
'sphinx.ext.mathjax', 'breathe'
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'Lima'
copyright = u'2016, Lima Team'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
# The short X.Y version.
version = '1.7'
# The full version, including alpha/beta/rc tags.
release = '1.7.2'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of documents that shouldn't be included in the build.
#unused_docs = []
# List of directories, relative to source directory, that shouldn't be searched
# for source files.
exclude_trees = []
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# Tell breathe about the projects
breathe_projects = { "control": ".doxygen/control/", "hardware": ".doxygen/hardware/" }
breathe_default_project = "control"
breathe_domain_by_extension = {"h" : "cpp"}
# -- Options for HTML output ---------------------------------------------------
# only import and set the theme if we're building docs locally
if not read_the_docs_build:
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# otherwise, uses their theme by default, so no need to specify it
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
#html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = 'lima-logo-2-40perc.png'
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
#html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_use_modindex = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = ''
# Output file base name for HTML help builder.
htmlhelp_basename = 'Limadoc'
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
latex_paper_size = 'a4'
# The font size ('10pt', '11pt' or '12pt').
latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'Lima.tex', u'Lima Documentation',
u'Lima Team', 'manual'),
# The name of an image file (relative to this directory) to place at the top of
# the title page.
latex_logo = 'lima-logo-3.png'
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_use_modindex = True
This source diff could not be displayed because it is too large. You can view the blob instead.
Unfortunately very limited documentation is available from the source doc...
Main interfaces
.. doxygenclass:: lima::CtAcquisition
:project: control
.. doxygenclass:: lima::HwInterface
:project: hardware
.. doxygenclass:: lima::HwFrameCallback
:project: hardware
Capabilities interfaces
.. doxygenclass:: lima::HwDetInfoCtrlObj
:project: hardware
.. doxygenclass:: lima::HwBufferCtrlObj
:project: hardware
.. doxygenclass:: lima::HwSyncCtrlObj
:project: hardware
.. doxygenclass:: lima::SoftBufferCtrlObj
:project: hardware
Future Cameras
We have many contributors now for new camera plugins, main but not the least are:
During the coming year, several new detector plugins will be available.
Under development
- Hexitec
- SVCam HR (SVS-Vistek)
- Vieworks
- Eiger (PSI)
.. _getit:
Get the Software
As Lima is not packaged yet, the only way for now is to retrieve the source from Github. You may either get the source tarball from the releases or using ``git``.
For both Linux and Windows we recommend to use the git tools:
- For Linux, install Git_ package if your linux distribution did not.
- For Windows, get and install Git_ first for the download section. Then use the git-bash tool with linux-like command line commands.
Command to get all sources
.. code-block:: bash
git clone --recursive git://
Commands for a minimum checkout to get all source needed for a particular camera
.. code-block:: bash
git clone git://
cd Lima
git submodule init third-party/Processlib third-party/Sps third-party/libconfig
git submodule init camera/CAMERA_YOU_WANT_TO_COMPILE
git submodule update
In addition (but optional) you can get the **TANGO** python device servers, so update your git clone again:
.. code-block:: bash
git submodule init application/tango/python
git submodule update
Need a Specific Version?
Stable versions of lima are tracked via Git branches and Git tags. So you can retrieve any particular version using git tools.
Please refer to the release notes document `release notes`_ , for more information of the latest release and tags.
For instance if you want to get version 1.7.1 of Lima core, do:
.. code-block:: bash
git checkout core-1.7.1
git submodule init
git submodule update
.. _git:
.. _release notes: ./ReleaseNotes.txt
This source diff could not be displayed because it is too large. You can view the blob instead.
For collaborative development, we use the "Fork & Pull" model from Github. So anyone who wants to contribute needs an account on Github. Then you need to fork the project you want to contribute.
.. note:: If you want to contribute with a new camera plug-in you should first request us (by email @ to get the new plug-in camera sub-module created. We will provide:
- a default structure of directories (<mycamera>/src /include sip/ doc/ python/ test/)
- the Makefile files (<mycamera>/Makefile, <mycamera>/src/Makefile, <mycamera>/test/Makefile)
- templates files (src and include) for the mandatory classes:
- <MyCamera>Interface
- <MyCamera>DetInfoCtrlObj
- <MyCamera>SyncCtrlObj
- a standard .gitignore file
- a template index.rst for the documentation
In addition we will update with new entries other files needed to compile the plugin library and the python module:
- Lima/config.inc_default
- Lima/camera/Makefile
- build/Makefile
- sip/Makefile
- sip/
As above do not forget to fork the new sub-module project.
Create a github account
This is an easy task, you just have to `Sign up <>`_, it's free!
Fork a project
Check out the `Github doc <>`_, it is far better explained than we could do ;)
Contribute guideline
It is very simple to contribute, you should follow the steps below.
1. Branch
First of all you have to create a branch for a new feature or for a bug fix, use an explicit
branch name, for instance "soleil_video_patch" .
2. Code/patch
If it's a patch from an existing module, respect and keep the coding style of the previous programmer (indentation,variable naming,end-line...).
If you're starting a new camera project, you've just to respect few rules:
- Class member must start with '**m\_**'
- Class method must be in **CamelCase**
- You must define the camera's namespace
3. Commit
Do as many commit as you need with clear comments.
Prefer an atomic commit with a single change rather than a huge commit with too many (unrelated) changes.
4. Pull Request
Then submit a `Pull Request <>`_
At this stage you have to wait, we need some time to accept or reject your request. So there are two possible issues:
1. The Pull-request is accepted, congrat!
We merge your branch with the the main project master branch, then everything is fine and you can now synchronize your forked project with the main project and go on with your next contribution.
2. The pull-request is rejected:
The pull request could be rejected if:
- the new code doesn't compile
- it breaks backward compatibility
- the python wrapping is missing or not updated
- the commit log message doesn't describe what you actually do
In case of a new camera plug-in sub-module the first pull request will be rejected if:
- as above
- the documentation is missing or if it does not fit with the guidelines (e.i :ref:`guidelines`)
We will tell you (code review on Github and/or email) about the reason and we will give some advises to improve your next tentative of pull-request.