1Metadata-Version: 2.1
2Name: iminuit
3Version: 2.8.4
4Summary: Jupyter-friendly Python frontend for MINUIT2 in C++
5Home-page: http://github.com/scikit-hep/iminuit
6Author: Piti Ongmongkolkul and the iminuit team
7Maintainer: Hans Dembinski
8Maintainer-email: hans.dembinski@gmail.com
9License: MIT+LGPL
10Download-URL: https://pypi.python.org/pypi/iminuit
11Project-URL: Documentation, https://iminuit.readthedocs.io
12Project-URL: Source Code, http://github.com/scikit-hep/iminuit
13Description: .. |iminuit| image:: doc/_static/iminuit_logo.svg
14           :alt: iminuit
15           :target: http://iminuit.readthedocs.io/en/latest
16
17        |iminuit|
18        =========
19
20        .. skip-marker-do-not-remove
21
22        .. image:: https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg
23           :target: https://scikit-hep.org
24        .. image:: https://img.shields.io/pypi/v/iminuit.svg
25           :target: https://pypi.org/project/iminuit
26        .. image:: https://img.shields.io/conda/vn/conda-forge/iminuit.svg
27           :target: https://github.com/conda-forge/iminuit-feedstock
28        .. image:: https://coveralls.io/repos/github/scikit-hep/iminuit/badge.svg?branch=develop
29           :target: https://coveralls.io/github/scikit-hep/iminuit?branch=develop
30        .. image:: https://readthedocs.org/projects/iminuit/badge/?version=stable
31           :target: https://iminuit.readthedocs.io/en/stable
32        .. image:: https://img.shields.io/pypi/l/iminuit
33        .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3949207.svg
34           :target: https://doi.org/10.5281/zenodo.3949207
35        .. image:: https://img.shields.io/badge/ascl-2108.024-blue.svg?colorB=262255
36           :target: https://ascl.net/2108.024
37           :alt: ascl:2108.024
38
39        *iminuit* is a Jupyter-friendly Python interface for the *Minuit2* C++ library maintained by CERN's ROOT team.
40
41        Minuit was designed to minimise statistical cost functions, for likelihood and least-squares fits of parametric models to data. It provides the best-fit parameters and error estimates from likelihood profile analysis.
42
43        - Supported CPython versions: 3.6+
44        - Supported PyPy versions: 3.6
45        - Supported platforms: Linux, OSX and Windows.
46
47        The iminuit package comes with additional features:
48
49        - Builtin cost functions for statistical fits
50
51          - Binned and unbinned maximum-likelihood
52          - Non-linear regression with (optionally robust) weighted least-squares
53          - Gaussian penalty terms
54          - Cost functions can be combined by adding them: ``total_cost = cost_1 + cost_2``
55        - Tools for numerical error propagation ``iminuit.util.propagate``
56        - Support for SciPy minimisers as alternatives to Minuit's Migrad algorithm (optional)
57        - Support for Numba accelerated functions (optional)
58
59        Checkout our large and comprehensive list of `tutorials`_ that take you all the way from beginner to power user. For help and how-to questions, please use the `discussions`_ on GitHub.
60
61        .. image:: https://mybinder.org/badge_logo.svg
62           :target: https://mybinder.org/v2/gh/scikit-hep/iminuit/develop?filepath=doc%2Ftutorial
63
64        In a nutshell
65        -------------
66
67        .. code-block:: python
68
69            from iminuit import Minuit
70
71            def cost_function(x, y, z):
72                return (x - 2) ** 2 + (y - 3) ** 2 + (z - 4) ** 2
73
74            fcn.errordef = Minuit.LEAST_SQUARES
75
76            m = Minuit(cost_function, x=0, y=0, z=0)
77
78            m.migrad()  # run optimiser
79            print(m.values)  # x: 2, y: 3, z: 4
80
81            m.hesse()   # run covariance estimator
82            print(m.errors)  # x: 1, y: 1, z: 1
83
84        Versions
85        --------
86
87        **The current 2.x series has introduced breaking interfaces changes with respect to the 1.x series.**
88
89        All interface changes are documented in the `changelog`_ with recommendations how to upgrade. To keep existing scripts running, pin your major iminuit version to <2, i.e. ``pip install 'iminuit<2'`` installs the 1.x series.
90
91        .. _changelog: https://iminuit.readthedocs.io/en/stable/changelog.html
92        .. _tutorials: https://iminuit.readthedocs.io/en/stable/tutorials.html
93        .. _discussions: https://github.com/scikit-hep/iminuit/discussions
94
95Platform: UNKNOWN
96Classifier: Development Status :: 5 - Production/Stable
97Classifier: Intended Audience :: Science/Research
98Classifier: Intended Audience :: Developers
99Classifier: License :: OSI Approved :: MIT License
100Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
101Classifier: Programming Language :: C++
102Classifier: Programming Language :: Python
103Classifier: Programming Language :: Python :: 3
104Classifier: Programming Language :: Python :: 3.6
105Classifier: Programming Language :: Python :: 3.7
106Classifier: Programming Language :: Python :: 3.8
107Classifier: Programming Language :: Python :: 3.9
108Classifier: Programming Language :: Python :: 3 :: Only
109Classifier: Programming Language :: Python :: Implementation :: CPython
110Classifier: Programming Language :: Python :: Implementation :: PyPy
111Classifier: Topic :: Software Development
112Classifier: Topic :: Scientific/Engineering :: Physics
113Classifier: Topic :: Scientific/Engineering :: Mathematics
114Classifier: Operating System :: Microsoft :: Windows
115Classifier: Operating System :: POSIX
116Classifier: Operating System :: Unix
117Classifier: Operating System :: MacOS
118Requires-Python: >=3.6
119Description-Content-Type: text/x-rst
120Provides-Extra: test
121Provides-Extra: doc
122