README file
QTMC Software
J Geach
Astronomy Unit
Queen Mary, University of London
Last update: Jul 2007

COPYRIGHT

The author(s) of software modules retain the copyright of the source code.
This source code is distributed under the Gnu Public License in the
hope that it will be useful but without any warranty whatsoever.

These modules also depend on other software products, including:

QSAS software, (see http://www3.imperial.ac.uk/spat/research/facilities/cluster)
IDFS software, licensed by SwRI (see www.idfs.org)
Qt software, licensed by Troll (see http://www.trolltech.com)

CONTENTS

This distribution provides an application to correct the on-board calculated moments
of the PEACE (P.I. = A Fazakerley, Mullard Space Science Laboratory) instrument on
the Cluster mission of the effects of spacecraft potential and a truncated energy range.

QTMC runs from the command line or in GUI mode, retrieving data via the IDFS system
and applying an algorithm developed by Vincent Genot (CESR, Toulouse) and Steve Schwartz
(QMUL). The result is a data file (either in Cluster Exchange Format (CEF) or
comma-delimited ASCII) containing the corrected moments, an estimate of the
temperature anisotropy of the electron distribution and several diagnostic factors.

QTMC reuses some code from other QMUL/IC software projects for Cluster,
namely some QSAS and QPEACE utilities. That software can be found at the main
Cluster Science Centre site http://www3.imperial.ac.uk/spat/research/facilities/cluster

The following directories are provided:

src     - source code of QTMC software
include - header files
doc     - ps & html documentation
bin     - destination of built executables. QTMC should be executed through a script,
	        an example of which can be found in this directory (and which will
                need editing to point to the installation
cal     - calibration files read by QTMC corresponding to gain corrections
          which must be applied for certain intervals

And files:

README   - this file
INSTALL  - installation instructions
build    - a script which builds QTMC which must be edited by the user
	         to point to various dependencies
Makefile - QTMC's makefile which should not need editing

REQUIREMENTS for RUNNING the APPLICATION

SDDAS   - a working local SDDAS/IDFS installation.
DATA    - QTMC software will attempt client-server connections to
          retrieve data. If this fails, use your SDDAS Data Catalog to
	        "promote" the data of interest and try again.
CDF     - used to export data to files conforming to ISTP/Cluster CDF
          design in cdf format (or Cluster Exchange Format)
QSAS    - a working local QSAS installation

REQUIREMENTS for BUILDING the APPLICATION

IDFS    - you will need to sign the appropriate IDFS license agreement,
          obtain and build the IDFS software modules.
Qt      - you will need this toolkit for building the Graphical User
          Interface. [It may be available already on your system; it
          is supplied, for example, with most/all Linux distributions.]
QSAS    - required for LAPACK and BLAS libraries

LANGUAGE- QTMC software is written in C and C++. The Qt interface is in
          C++. We use the Gnu Compiler Collection (gcc).

KNOWN FEATURES

Minimum time interval -- the minimum interval that can be corrected is ~10 secs.

Data inaccessable -- will fail and report if a certain data series cannot be found.
The exception to this is the EFW probe potential which can be over-ridden by the
user to some constant value, and the FGM magnetic field vector which is used to
estimate the anisotropy. If the magnetic field data cannot be found then no anisotropy
will be calculated.

TROUBLESHOOTING

In all cases, check the console window from which the application was
launched for possible error messages.

Problem: Fails to launch, run

   Possible Cause: Missing or incompatible system,
                   utility libraries (ld errors?).

   Remedy:         Fetch the libs from the distribution site or build the
                   applications from the source provided

FEEDBACK

We welcome comments and feedback. Email s.schwartz@imperial.ac.uk
When submitting bug reports, include system details and complete
description of circumstances.

End QTMC README file


