errlib 0.0.0

A library to estimate various error indices

==================================================
This library is now part of the ambhas
(http://pypi.python.org/pypi/ambhas/) library.
Updates will only be made in the ambhas library.
==================================================

============
errlib
============

This is a package/library in python to estimate various error indices.
This is being developed under the project `AMBHAS <http://www.ambhas.com/>`_.


Installing errlib
======================

Installing errlib can be done by downloading source file (errlib--<version>.tar.gz),
and after unpacking issuing the command::

python setup.py install

This requires the usual Distutils options available.

Or, download the errlib--<version>.tar.gz file and issue the command::

pip install /path/to/errlib--<version>.tar.gz

Or, directly using the pip::

pip install errlib


Usage
=========
Import required modules::

import numpy as np
from errlib.errlib import rmse, correlation

Generate some random numbers::

x = np.random.normal(size=100)
y = np.random.normal(size=100)
rmse(x,y)
correlation(x,y)

Changelog
=========

0.0.0 (July 2011)
------------------
- Initial release


Any questions/comments
=========================
If you have any comment/suggestion/question,
please feel free to write me at [e-mail]

So far, the documents are not well explained,
I will be updating them soon.