funcFit - A convenient fitting interface
=========================================

The funcFit package provides a convenient interface to the fitting algorithms
provided by the popular SciPy and pymc packages.
It implements a very flexible and simple parameter handling mechanism
making fitting in Python a much more enjoyable experience.

.. seealso:: PyAstronomy's *modelSuite*. The funcFit package itself comes with only a few basic fitting models such as
          a Gaussian. More complex models are provided in the frame of the *model suite*.

.. note:: If you use the 2.x series of Python, funcFit requires Python 2.7.x.
          The 2.6.x series (and prior) has a bug affecting the copying of
          dynamically created class methods, which has not been (and will not be) corrected.
          This interferes with many of funcFit's algorithms.

The tutorial
-----------------

The funcFit tutorial gives you an introduction to the capabilities of the
package. The most important aspects are demonstrated by example. 

.. toctree::
    :maxdepth: 2

    tutorial.rst
    tutorial2.rst
    tutorialMCMC.rst
    traceAnalysisTutorial.rst

Basic models
----------------

.. toctree::
    :maxdepth: 2

    simplemodels.rst

Internal and external fitters
--------------------------------

.. toctree::
    :maxdepth: 2

    extFitters.rst

API, parameters and further functionality
--------------------------------------------

.. toctree::
    :maxdepth: 2
    
    params.rst
    onedfit.rst
    sampleEMCEE.rst
    modelRebin.rst
    syncFit.rst
    emceePriors.rst
    traceAnalysis.rst
    coordinateGrid.rst