===========
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 import stream

    stream = read('path_to_data')
    stream.plot(['x'])

(Note the double-colon and 4-space indent formatting above.)

Paragraphs are separated by blank lines. *Italics*, **bold**,
and ``monospace`` look like this.

INSTALL
=======

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

Windows
-------


A Section
=========

Lists look like this:

* First

* Second. Can be multiple lines
  but must be indented properly.

A Sub-Section
-------------

Numbered lists look like you'd expect:

1. hi there

2. must be going

Urls are http://like.this and links can be
written `like this <http://www.example.com/foo/bar>`_.
