installation.rst 3.47 KB
Newer Older
marc's avatar
marc committed
1
2
3
Installation
============

marc's avatar
marc committed
4
5
6
7
8
9
10
11
12
13
14
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
marc's avatar
marc committed
15
      - createpointings
marc's avatar
marc committed
16
17
18
19
20
21
22


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.
marc's avatar
marc committed
23
24
25
26
27

::

    git clone https://gitlab.camras.nl/marc/dtObsGUI.git
    cd dtObsGUI
marc's avatar
marc committed
28
    git clone https://gitlab.camras.nl/dijkema/telescope.git
marc's avatar
marc committed
29
30
31
    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
marc's avatar
marc committed
32
    git clone https://gitlab.camras.nl/marc/createpointings.git
marc's avatar
marc committed
33

marc's avatar
marc committed
34
35
36
37
38
39
40
41
On mecury the telescope class is already installed. For other systems the
class can be installed locally or in system. 

::

    git clone https://gitlab.camras.nl/dijkema/telescope.git

Run python3 setup.py install to install the telescope in system.
marc's avatar
marc committed
42
43
44
45
46
47
48
49
50
51
52
53
54

Check for each programme if DT Obs can find the proper location. Each class can
be tested individually if needed.

Add PYTHONPATH for createpointings

::

    export PYTHONPATH=createpointings:${PYTHONPATH}

Configuration
=============

marc's avatar
marc committed
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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