Commit 275c530b authored by marc's avatar marc

Initial documentation for dtObsGUI

parent 198a7e92
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.
::
git clone https://gitlab.camras.nl/marc/dtObsGUI.git
cd dtObsGUI
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
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
=============
Ini files
DTObs Manual
============
The GUI consists of a standard menu and the mean purpose in the 1.0 release is to
load the pointing's. This list needs to be provided in a simple ASCII file having
3 columns, i.e. measurement number, RA and Dec. Using File->Open the required
file is loaded and made available in the right hand Table panel, showing the
measurement number, RA, Dec, Status and Result File.
On the left hand side you'll find 3 toolboxes to enter Meta Data, define your
measurement tool and settings and the backend mode.
Define Meta Data
----------------
After activating the Meta Tool box the generic meta data can be entered:
- Operator 1, 2 and 3
- Description, purpose of the measurement.
Next to the generic data, the actual time, measurement and backend settings are
stored in the result files.
.. figure:: /graphics/metaData.png
:align: center
Tab to enter generic meta data
Measurements
------------
A number of programmes are available defined in the Measurement toolbox. Depending
on the observation the following programmes can be used:
- dumpwide
- int32bin
- pulsarrecord
- rawrecord
Each programme needs 1 or more arguments like the integration time and central
frequency. [note: not implemented yet]. Also the telescope settings for Refraction
and DT Model needs to be checked and enabled if needed in the Measurement toolbox.
This information will be stored as meta data in the result file.
Please contact CAMRAS to get details on these programmes. The output directory
can be selected and stores the result files.
.. figure:: /graphics/measurement.png
:align: center
Measurement settings
Backend
-------
The backend supports the following modes:
- Pulsar mode, used for e.g. the pulsar demo
- Line mode, this is used for HI observations and has be higher frequency resolution.
- SDR mode outputs IQ data, compatible with e.g. GNUradio.
- Raw mode is used for more demanding requirements in time and frequency domain.
In case the backend mode will change, make sure that the backend is checked and
set into the proper mode. Do not start the measurement prior the backend is set.
It is also possible to compensate for the Local Standard of Rest (LSR). In the
case the received frequency will be corrected fo LSR.
If the metadata, measurement and backend settings are set, the actual measurement
can start.
.. figure:: /graphics/backendSettings.png
:align: center
Backend settings
Start measurement
-----------------
The right hand side table list the pointing's which are sent to the telescope after
clicking on the 'Start Measurement' button. Each point goes trough a status of
scheduled, slewing, measuring, completed identified by a colour. As soon a
measurement is finished it is possible to view the result file in Plotinus, but
a 'double click' on the table row.
After the measurement is completed, the table can be cleaned using the File->Close
menu and a new file can be loaded. Minor mistakes can be corrected in the Table
but are not yet saved in the measurement file.
The result files do have date and measurement number, so in case you redo the
measurement, make sure you either select an other output directory or move the
result files to a save location.
......@@ -111,8 +111,13 @@ todo_include_todos = True
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'alabaster'
#tml_theme = 'alabaster'
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# 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.
......
......@@ -11,6 +11,10 @@ Contents:
.. toctree::
:maxdepth: 2
introduction
chapters/installation
chapters/manual
Indices and tables
......@@ -19,4 +23,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
# Release 1.0 features
- loads ASCII pointing file in QTable
- controls pointing's using the Telescope class
- writes metadata in result file using MetaData class
- creates CLI commands to perform the measurements
- set backend in required mode
# DT Observation GUI
DT Observation GUI
==================
The DTObsGUI provide a simplified way to operate the Dwingeloo Telescope by means
of a user friendly GUI, which reads the pointing's and send these pointing's to
......@@ -15,114 +9,16 @@ mode. The actual result files are stored on the local drive and can be made
available on Internet. Beside the actual results the meta data is written in each
result file required for post processing of the data.
## How to use DT Observation Application
The GUI consists of a standard menu and the mean purpose in the 1.0 release is to
load the pointing's. This list needs to be provided in a simple ASCII file having
3 columns, i.e. measurement number, RA and Dec. Using File->Open the required
file is loaded and made available in the right hand Table panel, showing the
measurement number, RA, Dec, Status and Result File.
On the left hand side you'll find 3 toolboxes to enter Meta Data, define your
measurement tool and settings and the backend mode.
## Define Meta Data
After activating the Meta Tool box the generic meta data can be entered:
- Operator 1, 2 and 3
- Description, purpose of the measurement.
Next to the generic data, the actual time, measurement and backend settings are
stored in the result files.
## Measurements
A number of programmes are available defined in the Measurement toolbox. Depending
on the observation the following programmes can be used:
- dumpwide
- int32bin
- pulsarrecord
- rawrecord
Each programme needs 1 or more arguments like the integration time and central
frequency. [note: not implemented yet]. Also the telescope settings for Refraction
and DT Model needs to be checked and enabled if needed in the Measurement toolbox.
This information will be stored as meta data in the result file.
Please contact CAMRAS to get details on these programmes. The output directory
can be selected and stores the result files.
## Backend
.. figure:: graphics/dtObsGUI.png
The backend supports the following modes:
- Pulsar mode, used for e.g. the pulsar demo
- Line mode, this is used for HI observations and has be higher frequency resolution.
- SDR mode outputs IQ data, compatible with e.g. GNUradio.
- Raw mode is used for more demanding requirements in time and frequency domain.
Screenshot of dtObsGUI
In case the backend mode will change, make sure that the backend is checked and
set into the proper mode. Do not start the measurement prior the backend is set.
It is also possible to compensate for the Local Standard of Rest (LSR). In the
case the received frequency will be corrected fo LSR.
Release 1.0 features
--------------------
If the metadata, measurement and backend settings are set, the actual measurement
can start.
## Start measurement
The right hand side table list the pointing's which are sent to the telescope after
clicking on the 'Start Measurement' button. Each point goes trough a status of
scheduled, slewing, measuring, completed identified by a colour. As soon a
measurement is finished it is possible to view the result file in Plotinus, but
a 'double click' on the table row.
After the measurement is completed, the table can be cleaned using the File->Close
menu and a new file can be loaded. Minor mistakes can be corrected in the Table
but are not yet saved in the measurement file.
The result files do have date and measurement number, so in case you redo the
measurement, make sure you either select an other output directory or move the
result files to a save location.
# 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. Therefore
the system 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.
```
git clone https://gitlab.camras.nl/marc/dtObsGUI.git
cd dtObsGUI
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
```
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}
```
# TODO - define central frequency - internationalization - predefine paintings
# for demo sources, e.g. M31, CASA, M101, hydrogen profiles - set MJD in
# metadata, now local time - INDI connection to show DT position on Stellarium -
# estimation overall observation time - update status field with status -
# initial post processing of measurements - Pause/resume of measurement - SETI
# transient setting in case of transient observations
- loads ASCII pointing file in QTable
- controls pointing's using the Telescope class
- writes metadata in result file using MetaData class
- creates CLI commands to perform the measurements
- set backend in required mode
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