index.rst

API Documentation

This page contains documentation which was automatically extracted from docstrings attached to the kafe2 source code. All major classes, methods and functions provided by kafe2 are documented here. For further information, or if in doubt about the exact functionality, users are invited to consult the source code itself. If you notice a mistake in the kafe2 documentation, or if you think that a particular part needs to be better documented, please open an issue on the kafe2 GitHub page.

kafe2 Wrappers

.. automodule:: kafe2.fit.util.wrapper
    :members:
    :undoc-members:
    :show-inheritance:

kafe2 Object-Oriented Programming

.. automodule:: kafe2.__init__
    :members:
    :undoc-members:
    :show-inheritance:

Parameter Estimation Tools: :py:mod:`~kafe2.fit`

.. automodule:: kafe2.fit

Tools for Fitting xy Data: :py:mod:`~kafe2.fit.xy`

.. automodule:: kafe2.fit.xy
    :members:
    :undoc-members:
    :imported-members:
    :show-inheritance:

Tools for Fitting Series of Indexed Measurements: :py:mod:`~kafe2.fit.indexed`

.. automodule:: kafe2.fit.indexed
    :members:
    :undoc-members:
    :imported-members:
    :show-inheritance:

Tools for Fitting Histograms: :py:mod:`~kafe2.fit.histogram`

.. automodule:: kafe2.fit.histogram
    :members:
    :undoc-members:
    :imported-members:
    :show-inheritance:

Tools for Unbinned Fits: :py:mod:`~kafe2.fit.unbinned`

.. automodule:: kafe2.fit.unbinned
    :members:
    :undoc-members:
    :imported-members:
    :show-inheritance:

Abstract Base Classes: :py:mod:`~kafe2.fit._base`

.. automodule:: kafe2.fit._base
    :members:
    :undoc-members:
    :imported-members:
    :show-inheritance: