Commit 198a7e92 authored by marc's avatar marc

move to atom for documentation

parent 012c2715
......@@ -3,6 +3,7 @@ measurements
backend
metadata
createpointings
doc/_build
__pycache__
.directory
.settings
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
help:
@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 " singlehtml to make a single large HTML file"
@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 " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/dtObsGUI.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/dtObsGUI.qhc"
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/dtObsGUI"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/dtObsGUI"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
This diff is collapsed.
.. dtObsGUI documentation master file, created by
sphinx-quickstart on Sun Nov 12 18:39:31 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to dtObsGUI's documentation!
====================================
Contents:
.. toctree::
:maxdepth: 2
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
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
the telescope using the python Telescope class. As soon the Telescope tracks the
source, the actual measurement starts after the backend is set into the correct
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
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.
## 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
0 83.09576543345065 21.51446
1 56.323431431150276 23.605313
2 56.869089 23.605313
3 56.869089 24.105313
4 56.32132166678547 24.105313
0 10.02459429004687 40.769065
1 10.684793 40.769065
2 10.684793 41.269065
3 10.019563557556424 41.269065
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