Data Fitting with SciPy
=======================

**This project is in development and in no way stable.**

Documentation
-------------

Documentation generated from source with
`pdoc <https://pypi.python.org/pypi/pdoc/>`__ for the latest version is
hosted at
`packages.python.org/scipy-data\_fitting/ <http://packages.python.org/scipy-data_fitting/>`__.

Installation
------------

This package is registered on the Python Package Index (PyPI) at
`pypi.python.org/pypi/scipy-data\_fitting <https://pypi.python.org/pypi/scipy-data_fitting>`__.

Add this line to your application's ``requirements.txt``:

::

    scipy-data_fitting

And then execute:

.. code:: bash

    $ pip install -r requirements.txt

Or install it yourself as:

.. code:: bash

    $ pip install scipy-data_fitting

Instead of the package name ``scipy-data_fitting``, you can use this
repository directly with

::

    git+https://github.com/razor-x/scipy-data_fitting.git@master#egg=scipy-data_fitting

Development
-----------

Source Repository
~~~~~~~~~~~~~~~~~

The `source <https://github.com/razor-x/scipy-data_fitting>`__ is hosted
at GitHub. Fork it on GitHub, or clone the project with

.. code:: bash

    $ git clone https://github.com/razor-x/scipy-data_fitting.git

Documentation
~~~~~~~~~~~~~

Generate documentation with pdoc by running

.. code:: bash

    $ make docs

Tests
~~~~~

Run the tests with

.. code:: bash

    $ make tests

License
-------

This code is licensed under the MIT license.

Warranty
--------

This software is provided "as is" and without any express or implied
warranties, including, without limitation, the implied warranties of
merchantibility and fitness for a particular purpose.
