+-------------------------------------------------+
|  [Py]thon +                                     |
|  [F]ITS                                         |
|  [A]nalysis for                     < v0.2.1 >  |
|  [C]herenkov                       Jun 5, 2012  |
|  [T]elescopes                                   |
+-------------------------------------------------+

Copyright (c) 2011-2012, the PyFACT developers
All rights reserved.

PyFACT is distributed under the Modified BSD License (see below).

============
INTRODUCTION

PyFACT is a collection of python tools for the analysis of Imaging
Atmospheric Cherenkov Telescope (IACT) data in FITS format. PyFACT is developed
and maintained by Martin Raue (martin.raue@desy.de) with contributions
by Christoph Deil (christoph.deil@mpi-hd.mpg.de).

============
REQUIREMENTS

The module is written for Python 2.6++ and requires the following python
packages to be installed:

* numpy 1.5.1 or higher
  http://numpy.scipy.org/

* scipy 0.9.0 or higher
  http://www.scipy.org/

* pyfits 3.0.0 or higher
  http://www.stsci.edu/resources/software_hardware/pyfits/

The data needs to be in CTA FITS format v1.0.0 or higher.

Optional, for plotting:

* matplotlib 1.0.1
  http://matplotlib.sourceforge.net/

============
INSTALLATION

No installation of the package is required. Simply untar the archive and you are good to go.

To build the documentation the sphinx package is required:
$ cd docs/
$ make html (latex ...)

The documentation can then be found in the docs/_build/ directory.

The documentation is also available online
http://pyfact.rtfd.org

=====
USAGE

------
BASICS

Tasks are performed using the python scripts located in the scripts/ folder. The scripts are excecutable python scripts. To execute them simply type:

./scripts/pfmap.py

If you prefer to run them with a specific python version, you can also execute them as normal python scripts, e.g.

python2.6 ./scripts/pfmap.py

They can also run inside an interactive session, e.g. in ipython

In [0]: %run ./scripts/pfmap.py

The scripts come with a builtin help text, which is displayed when the scripts are called without any argument or with the -h/--help option:

$ ./scripts/pfmap.py
$ ./scripts/pfmap.py -h
$ ./scripts/pfmap.py --help

Please refer to the full documentation for more details. It can be found online:
http://pyfact.rtfd.org

==================
FEEDBACK & SUPPORT

For bug reports and feature requests please contact martin.raue@desy.de.

=======
LICENSE

PyFACT is distributed under the Modified BSD License.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the PyFACT developers nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE PYFACT DEVELOPERS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

end.