Update the documentation (build with CMake) and cleanup

doc/index.rst

@@ -7,124 +7,85 @@ Frelon camera
 
 Introduction
 ````````````
-TODO
+
+The FReLoN camera is a 14 bit dynamic CCD camera, with a 2048*2048 pixel chip. This camera has been developped by the awesome people with the 'Analog and Transient Electronic' ESRF group.
 
 Prerequisite
 ````````````
 
 Installation & Module configuration
-````````````````````````````````````
-
--  follow first the steps for the linux installation :ref:`linux_installation`
+```````````````````````````````````
 
-The minimum configuration file is *config.inc* :
+Follow the generic instructions in :ref:`build_installation`. If using CMake directly, add the following flag:
 
 .. code-block:: sh
 
- COMPILE_CORE=1
- COMPILE_SIMULATOR=0
- COMPILE_SPS_IMAGE=1
- COMPILE_ESPIA=0
- COMPILE_FRELON=1
- COMPILE_MAXIPIX=0
- COMPILE_PILATUS=0
- COMPILE_BASLER=0
- COMPILE_PROSILICA=0
- COMPILE_ROPERSCIENTIFIC=0
- COMPILE_MYTHEN=0
- COMPILE_ADSC=0
- COMPILE_UEYE=0
- COMPILE_XH=0
- COMPILE_XSPRESS3=0
- COMPILE_XPAD=0
- COMPILE_PERKINELMER=0
- COMPILE_ANDOR=0
- COMPILE_PHOTONICSCIENCE=0
- COMPILE_PCO=0
- COMPILE_MARCCD=0
- COMPILE_POINTGREY=0
- COMPILE_IMXPAD=0
- COMPILE_DEXELA=0
- COMPILE_RAYONIXHS=0
- COMPILE_CBF_SAVING=0
- COMPILE_NXS_SAVING=0
- COMPILE_FITS_SAVING=0
- COMPILE_EDFGZ_SAVING=0
- COMPILE_TIFF_SAVING=0
- COMPILE_CONFIG=1
- LINK_STRICT_VERSION=0
- export COMPILE_CORE COMPILE_SPS_IMAGE COMPILE_SIMULATOR \
-       COMPILE_ESPIA COMPILE_FRELON COMPILE_MAXIPIX COMPILE_PILATUS \
-       COMPILE_BASLER COMPILE_PROSILICA COMPILE_ROPERSCIENTIFIC COMPILE_ADSC \
-       COMPILE_MYTHEN COMPILE_UEYE COMPILE_XH COMPILE_XSPRESS3 COMPILE_XPAD COMPILE_PERKINELMER \
-       COMPILE_ANDOR COMPILE_PHOTONICSCIENCE COMPILE_PCO COMPILE_MARCCD COMPILE_DEXELA\
-       COMPILE_POINTGREY COMPILE_IMXPAD COMPILE_RAYONIXHS COMPILE_CBF_SAVING COMPILE_NXS_SAVING \
-       COMPILE_FITS_SAVING COMPILE_EDFGZ_SAVING COMPILE_TIFF_SAVING COMPILE_CONFIG\
-       LINK_STRICT_VERSION
-
--  start the linux compilation :ref:`linux_compilation`
-
--  finally with the Tango server installation :ref:`tango_installation`
+ -DLIMACAMERA_FRELON=true
+
+For the Tango server installation, refers to :ref:`tango_installation`.
 
 Initialisation and Capabilities
-````````````````````````````````
-In order to help people to understand how the camera plugin has been implemented in LImA this section
-provide some important information about the developer's choices.
+```````````````````````````````
+
+Implementing a new plugin for new detector is driven by the LIMA framework but the developer has some freedoms to choose which standard and specific features will be made available. This section is supposed to give you the correct information regarding how the camera is exported within the LIMA framework.
 
 Camera initialisation
-......................
-The Frelon plugin is providing a helper class **FrelonAcq** which manages the initialisation sequence with
-the camera and interface object. One should only provide an Espia board channel number as the initialisation
+.....................
+
+The Frelon plugin provides a helper class :cpp:class:`FrelonAcq` which manages the initialisation sequence with
+the camera and interface object. An Espia board channel number should be set as the initialisation
 parameter (default is 0).
 
+.. code-block:: c++
+
   frelon = Frelon.FrelonAcq(int(espia_dev_nb))
   return frelon.getGlobalControl()
 
 Std capabilites
-................
+...............
 
-This plugin has been implemented in respect of the mandatory capabilites but with limitations according 
+This plugin has been implemented in respect of the mandatory capabilites but with limitations according
 due to the detector specific features and with some programmer's  choices.  We do not explain here the standard Lima capabilites
 but you can find in this section the useful information on the Dexela specfic features.
 
 * HwDetInfo
 
- TODO  
+ TODO
 
 * HwSync
 
- TODO  
+ TODO
 
 Optional capabilites
-........................
-In addition to the standard capabilities, we make the choice to implement some optional capabilities in order to 
+....................
+
+In addition to the standard capabilities, we make the choice to implement some optional capabilities in order to
 have an improved simulation.
 
 * HwShutter
 
- TODO 
+ TODO
 
 * HwRoi
 
- TODO 
+ TODO
 
-* HwBin 
+* HwBin
 
- TODO 
+ TODO
 
 Configuration
 `````````````
 
-The main configuration will consist in providing the correct "DexelaConfig.cfg" file to the detector API.
-The file has to be provided by the manufacturer with a second file like "sensor2923.fmt". The .fmt file contains
-some calibration data.
-
+The main configuration will consist in providing the correct ``DexelaConfig.cfg`` file to the detector API.
+The file has to be provided by the manufacturer with a second file like ``sensor2923.fmt``. The ``.fmt`` file contains some calibration data.
 
 How to use
 ````````````
+
 The LimaCCDs tango server provides a complete interface to the dexela plugin so feel free to test.
 
-For a quick test one can use python, is this a short code example:
+For a quick test one can use python, this is a short example code:
 
 .. code-block:: python
 
@@ -133,7 +94,7 @@ For a quick test one can use python, is this a short code example:
   import time
 
   FrelonAcq  = Frelon.FrelonAcq(int(espia_dev_nb))
-  control = FrelonAcq.getGlobalControl() 
+  control = FrelonAcq.getGlobalControl()
 
   acq = control.acquisition()
 
@@ -151,8 +112,8 @@ For a quick test one can use python, is this a short code example:
 
   # now ask for 2 sec. exposure and 10 frames
   acq.setAcqExpoTime(2)
-  acq.setNbImages(10) 
-  
+  acq.setNbImages(10)
+
   acq.prepareAcq()
   acq.startAcq()
 
@@ -161,9 +122,6 @@ For a quick test one can use python, is this a short code example:
   while lastimg !=9:
     time.sleep(1)
     lastimg = control.getStatus().ImageCounters.LastImageReady
- 
+
   # read the first image
   im0 = control.ReadImage(0)
-  
-
-