.. meta::
   :description lang=en: kafe2 - a general, Python-based approach to fit a
      model function to two-dimensional data points with correlated
      uncertainties in both dimensions
   :robots: index, follow


#######################
**kafe2** documentation
#######################

.. image:: _static/img/badge_kafe2.svg.png
   :width: 128px
   :height: 128px
   :alt: kafe2 logo
   :align: left


Welcome to **kafe2**, the *Karlsruhe Fit Environment 2*!

*kafe2* is a data fitting framework designed for use in undergraduate
physics lab courses. It provides a basic Python toolkit for fitting
models to data as well as visualizing the data and the model function.
It relies on Python packages such as :py:mod:`numpy` and :py:mod:`matplotlib`,
and can use the Python interface to the minimizer `Minuit` contained in the data
analysis framework `ROOT` or in the Python package `iminuit`.


.. toctree::
   :name: mastertoc
   :maxdepth: 3
   :includehidden:

   parts/installation
   parts/mathematical_foundations
   parts/user_guide
   parts/api_documentation/index