===========
MagPy
===========

MagPy (GeomagPy) provides tools for geomagnetic analysis with special focus on observatories.
Typical usage often looks like this::

    #!/usr/bin/env python

    from magpy.stream import *

    stream = read(path_or_url='filename')
    stream.plot(['x'])


INSTALL
=======

Linux/Unix
----------
gunzip -c geomagpy-x.x.x.tar.gz | tar xf -    # unpacks into directory geomagpy-x.x.x
cd geomagpy-x.x.x
python setup.py install

Windows
-------
coming soon

A Quick guide
=============

In the following some basic usage examples are given:

A Reading  and plotting data
----------------------------

Use the following commands

1. data = read('path_to_data')

2. data.plot('[x]')

You will find some example plots at the `Conrad Observatory <http://www.conrad-observatory.at>`_.
