summaryrefslogtreecommitdiff
path: root/lib/__init__.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/__init__.py')
-rw-r--r--lib/__init__.py11
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/__init__.py b/lib/__init__.py
index ebd45ef..0728a1c 100644
--- a/lib/__init__.py
+++ b/lib/__init__.py
@@ -1,3 +1,14 @@
+""" STWCS
+
+This package provides support for WCS based distortion models and coordinate
+transformation. It relies on PyWCS (based on WCSLIB). It consists of two subpackages:
+updatewcs and wcsutil. Updatewcs performs corrections to the basic WCS and includes
+other distortion infomation in the science files as header keywords or file extensions.
+Wcsutil provides an HSTWCS object which extends pywcs.WCS object and provides HST instrument
+specific information as well as methods for coordinate tarnsformaiton. Wcsutil also provides
+functions for manipulating alternate WCS descriptions in the headers.
+
+"""
from __future__ import division # confidence high
#import all needed modules here to avoid relative imports