Welcome to VDAT: Virus Data Analysis Tool’s documentation!

Version: 0.9.0.post0

The Virus Data Analysis Tool (VDAT) software is a GUI tool to reduce data from Hobby-Eberly Telescope (HET) observations. The software is being created specifically for HET Dark Energy Experiment (HETDEX), but we try to design it to be easily extended to other user cases.

vdat supports python 2.7, 3.4 or later.

This documentation is also available on vdat.readthedocs.io.

User documentation

• Installation
  • Instructions
  • Dependances
  • Development
  • Notes and problems
• Use VDAT: how to
  • Get the configuration files
  • Check the configuration files
  • Launch VDAT
  • The VDAT database
• The directory structure and symlinking
  • Raw directory structure
  • Redux directory structure
  • Symlinking
• The Graphical User Interface
  • The main window
  • IFU viewer
  • Queue window
• The Command Interpreter Tool
  • Introduction
  • The interpreter
  • The configuration file
  • Add new types
  • Communication
• FAQ

Todo

Add some instruction about the loggers settings

Developer documentation

• Contribute to VDAT
  • How To
  • Coding style
  • Testing
  • Documentation
• Code Documentation
  • command_interpreter – The command line interpreter
  • vdat.libvdat – Stuff that isn’t GUI
  • vdat.config – The configuration functionality and files
  • vdat.gui – The Gui Code
  • vdat.database – The VDAT database
  • vdat.utilities – Generic utilities
  • vdat.exceptions – VDAT exceptions
  • vdat.list_plugins – List plugins used by VDAT

About

• LICENSE
  • Code Licence: GPL v3
  • Documentation Licence: FDL v1.3
  • Artwork Licence: CC BY-NC 4.0
• Authors
• Virus Data Analysis Tool release notes
  • Development version @ trunk
  • Version 0.9.0
  • Version 0.8.0
  • Version 0.7.0
  • Version 0.6.1
  • Version 0.6.0
  • Version 0.5.0
  • Version 0.4.0
  • Version 0.3.0
  • Version 0.2.4
  • Version 0.2.3
  • Version 0.2.2
  • Version 0.2.1
  • Version 0.2.0
  • Version 0.1.0
• Changelog
• TODO

Copyright notice

Copyright (c) 2018 “The HETDEX collaboration”.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled Documentation Licence: FDL v1.3.

Artwork copyright

VDAT artwork by Majo Buro is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.

The artwork consists of:

• the logo with the VDAT text shown in upper left corner of the documentation;
• the two splash screens visible when starting VDAT;
• the VDAT window icon.

Links

• Index
• Module Index
• Search Page