.. wfProc documentation master file, created by
   sphinx-quickstart on Sat Feb  5 13:56:57 2011.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to wfProc's documentation!
==================================

**wfProc** is a set of Python modules for waveform processing (which will hopefully evolve in a package). A waveform is defined as an array of equisampled data (at the moment float or int) with a fixed start time *t0*. *ns* is the number of samples in the waveform, which is basically fixed (but a resize facility is planned). *fs* is the sampling frequency, again, fixed, but several ways of interpolation are available.

The best way of downloading the library is via the SVN:

``svn co https://wfproc.svn.sourceforge.net/svnroot/wfproc/trunk wfproc``

Once you've downloaded it, try running ``python setup.py install`` to add the package to your python distribution. If you don't have root access, you'll have to stick with ``python setup.py build`` and adding the wfproc directory to your PYTHONPATH.

This documentation can be created by running ``make html`` (run ``make`` to see other options) in the ``doc`` subfolder. It requires Sphinx documentation generator to be installed.

Contents:

.. toctree::
   :maxdepth: 2

   wf
   proc

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`