Commit 1fab49d9 authored by marc's avatar marc

Update dtObsGUI docmentation

parent 275c530b
Installation
============
DTObsGUI is written in python3 and uses pyqt5 GUI framework. The user interface
is build using QT designer and converted to a python UI window class. The
software depends on:
- python3
- pyqt5
- CAMRAS python classes, available on CAMRAS git-lab
- dtObsGUI
- measurements
- metadata
- backend
The latter 3 classes are installed in the dtObsGUI directory and imported by
python. Each class has an ini file and should be checked for each installation.
It sets e.g. the file locations of the measurement programmes, test modes, logging
level etc. Make sure you can execute the programmes are current user.
DTObsGUI is written in `python3`_ and uses `pyqt5`_ GUI framework. The user interface
is build using QT designer and converted into a python UI window class by means of
`pyuic5 -x file.ui -o file.py`. The software depends on:
- python3
- pyqt5
- CAMRAS python software classes, available on CAMRAS `git-lab`_:
- dtObsGUI
- measurements
- metadata
- backend
The latter 4 classes are installed in the dtObsGUI directory and imported by
python. Each class has an ini file and should be checked for each installation,
see section: `Configuration`_. It sets e.g. the file locations of the measurement
programmes, test modes, logging level etc. Make sure you can execute the
programme as user.
::
git clone https://gitlab.camras.nl/marc/dtObsGUI.git
cd dtObsGUI
git clone https://gitlab.camras.nl/dijkeme/telescope.git
git clone https://gitlab.camras.nl/marc/measurements.git
git clone https://gitlab.camras.nl/marc/metadata.git
git clone https://gitlab.camras.nl/marc/backend.git
......@@ -39,4 +42,86 @@ Add PYTHONPATH for createpointings
Configuration
=============
Ini files
To ease the DEVOPS customization of dtObsGUI, each class has its own `.ini` file
used by the config manager of python. The `.ini` files are key/value entries read
during the instantiation of the class.
The configuration of the `telescope` Class is described on `git-lab`_.
dtobsgui ini
------------
- WARN
- INFO
- DEBUG
For normal operation the `INFO` level is sufficient and shows the entry and exit
of executed methods.
The demo can be set `True` to bypass the telescope class, which requires a
connection to either the `consoledemo`_ or the DT telescope. This setting is for
development purpose only. For proper operation of the software `demo` should be
set to `False`
Example:
::
[Application]
LogLevel: INFO
[TestConfig]
demo: False
measurements ini
----------------
The location of the measurement tools, which read the data from the backend and
converts it into either text or binary file, are defined in `Tools`. The example
shows the required settings for the DT.
Example:
::
[Tools]
dumpwide: /usr/local/bin/dump-wide
dump32: /usr/local/bin/dump32
int32bit: /usr/local/bin/int32bit
pulsarrecord: /usr/local/bin/pulsar_record
rawrecord: /usr/local/bin/raw_record
metadata ini
------------
No ini file is yet defined for metaData class.
backend ini
-----------
In section Tools the runimpact and vlsr location needs to be defined. For the DT
these tools are located in the `/usr/local/bin`. In the Modes section the runimpact
argument is defined to programme the backedn in the required mode.
Example:
::
[Tools]
runimpact: /usr/local/bin/runimpact
vlsr: /usr/local/bin/trackHI.py
[Modes]
pulsar: pulsar.batch
hydrogen: line
raw: raw
SDR: sdr
.. _python3: https://www.python.org/
.. _pyqt5: http://pyqt.sourceforge.net/Docs/PyQt5/index.html
.. _git-lab: https://gitlab.camras.nl/
.. _consoledemo: https://charon.camras.nl/consoledemo
......@@ -47,8 +47,22 @@ can be selected and stores the result files.
.. figure:: /graphics/measurement.png
:align: center
Measurement settings
Measurement Tools
~~~~~~~~~~~~~~~~~
**dumpwide**
**dump32**
**int32bit**
**pulsarrecord**
**rawrecord**
Backend
-------
......
......@@ -2,4 +2,4 @@
LogLevel: INFO
[TestConfig]
demo: True
\ No newline at end of file
demo: True
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment