Added module documentation for Python.

pyana/pyana.py

@@ -3,8 +3,22 @@
 """
 pyana.py
 
-Created by Tim van Werkhoven on 2009-02-11.
-Copyright (c) 2009 Tim van Werkhoven. All rights reserved.
+A C extension for Python to read ana f0 files. Based on Michiel van Noort's
+IDL DLM library 'f0' which contains a cleaned up version of the original
+anarw routines.
+
+To read a file:
+> anadata = pyana.fzread(<filename>, [debug=0])
+which will return a dict with the data in anadata['data'] and some meta info
+in anadata['header']. To return only the data or header, use pyana.getdata()
+and pyana.getheader() respectively.
+
+To write a file:
+> pyana.fzwrite(<filename>, <data>, [compress=1, [comments=False, [debug=0]]]):
+or use pyana.writeto(), which is an alias to fzwrite().
+
+Created by Tim van Werkhoven (t.i.m.vanwerkhoven@gmail.com) on 2009-02-11.
+Copyright (c) 2009--2011 Tim van Werkhoven. All rights reserved.
 """
 
 ## Import libraries