From 25b4b6515d5bbf0a0ae427783f245ddbca68bbee Mon Sep 17 00:00:00 2001 From: Tim van Werkhoven Date: Mon, 1 Aug 2011 14:58:48 +0200 Subject: [PATCH] Added module documentation for Python. --- pyana/pyana.py | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/pyana/pyana.py b/pyana/pyana.py index ae8544f..6e241cc 100755 --- a/pyana/pyana.py +++ b/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(, [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(, , [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