Metadata-Version: 2.1
Name: scikit-hep
Version: 5.1.1
Summary: Metapackage of Scikit-HEP project libraries for Particle Physics.
Home-page: https://github.com/scikit-hep/scikit-hep/
Author: the scikit-hep admins
Author-email: scikit-hep-admins@googlegroups.com
License: BSD 3-Clause License
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Utilities
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: C++
Classifier: Programming Language :: Cython
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.7
License-File: LICENSE


``scikit-hep``: metapackage for Scikit-HEP
==========================================

.. image:: https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg
   :target: https://scikit-hep.org

.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
   :target: https://gitter.im/Scikit-HEP/community

.. image:: https://img.shields.io/pypi/v/scikit-hep.svg
  :target: https://pypi.python.org/pypi/scikit-hep

.. image:: https://img.shields.io/conda/vn/conda-forge/scikit-hep.svg
  :target: https://github.com/conda-forge/scikit-hep-feedstock

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1043949.svg
  :target: https://doi.org/10.5281/zenodo.1043949

.. image:: https://github.com/scikit-hep/scikit-hep/workflows/CI/badge.svg
   :target: https://github.com/scikit-hep/scikit-hep/actions?query=workflow%3ACI+branch%3Amaster

.. image:: https://codecov.io/gh/scikit-hep/scikit-hep/graph/badge.svg?branch=master
   :target: https://codecov.io/gh/scikit-hep/scikit-hep?branch=master

Project info
------------

The `Scikit-HEP project <http://scikit-hep.org/>`_ is a community-driven and community-oriented project
with the aim of providing Particle Physics at large with an ecosystem for data analysis in Python
embracing all major topics involved in a physicist's work.
The project started in Autumn 2016 and its packages are actively developed and maintained.

It is not just about providing core and common tools for the community.
It is also about improving the interoperability between HEP tools and the Big Data scientific ecosystem in Python,
and about improving on discoverability of utility packages and projects.

For what concerns the project grand structure, it should be seen as a *toolset* rather than a toolkit.

**Getting in touch**

There are various ways to
`get in touch <https://scikit-hep.org/getting-in-touch.html>`_
with project admins and/or users and developers.

scikit-hep package
------------------

``scikit-hep`` is a metapackage for the Scikit-HEP project.

Installation
.............

You can install this metapackage from PyPI with `pip`:

.. code-block:: bash

   python -m pip install scikit-hep

or you can use Conda through conda-forge:

.. code-block:: bash

   conda install -c conda-forge scikit-hep

All the normal best-practices for Python apply; you should be in a virtual environment, etc.

Package version and dependencies
................................

Please check the ``setup.cfg`` and ``requirements.txt`` files for the list
of Python versions supported and the list of Scikit-HEP project packages
and dependencies included, respectively.

For any installed ``scikit-hep`` the following displays the actual versions
of all Scikit-HEP dependent packages installed, for example:

.. code-block:: python

    >>> import skhep
    >>> skhep.show_versions()

    System:
        python: 3.9.12 (main, Apr  4 2022, 05:22:27) [MSC v.1916 64 bit (AMD64)]
    executable: C:\home\sw\anaconda3\python.exe
       machine: Windows-10-10.0.19044-SP0

    Python dependencies:
           pip: 21.2.4
    setuptools: 61.2.0
         numpy: 1.21.5
         scipy: 1.7.3
        pandas: 1.4.2
    matplotlib: 3.5.1

    Scikit-HEP package version and dependencies:
            awkward: 1.8.0
    boost_histogram: 1.3.1
      decaylanguage: 0.14.2
           hepstats: 0.5.0
           hepunits: 2.2.1
               hist: 2.6.1
         histoprint: 2.4.0
            iminuit: 2.16.0
             mplhep: 0.3.26
           particle: 0.20.1
              pylhe: 0.4.0
           resample: 1.5.1
              skhep: 4.1.0
             uproot: 4.3.5
             vector: 0.8.5


**Note on the versioning system:**

- A version ``scikit-hep x.y`` is compatible with the releases of all package dependents
  versions ``a.b.c`` for all ``c``.
- Major version updates are prepared every time (at least) a "package component" does the same.
- Minor version updates are the typical updates, when (at least) a package goes from version ``a.b`` to ``a.(b+1)``.
- Patch version updates are only done if there is some reason on the side of the metapackage itself.
