Metadata-Version: 2.1
Name: km3compass
Version: 0.8.0
Summary: Light weight package to read and exploit km3net compass data
Home-page: https://git.km3net.de/km3py/km3compass
Author: Valentin Pestel
Author-email: vpestel@km3net.de
Maintainer: Valentin Pestel
Maintainer-email: vpestel@km3net.de
License: MIT
Keywords: neutrino,astroparticle,physics,HEP
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
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: Topic :: Scientific/Engineering
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: setuptools-scm
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: km3db >=v0.12.0
Requires-Dist: scipy
Requires-Dist: scikit-learn
Requires-Dist: matplotlib
Requires-Dist: tables
Provides-Extra: all
Requires-Dist: black ; extra == 'all'
Requires-Dist: matplotlib ; extra == 'all'
Requires-Dist: numpydoc ; extra == 'all'
Requires-Dist: ipykernel ; extra == 'all'
Requires-Dist: pillow ; extra == 'all'
Requires-Dist: pytest ; extra == 'all'
Requires-Dist: pytest-cov ; extra == 'all'
Requires-Dist: pytest-flake8 ; extra == 'all'
Requires-Dist: pylint ; extra == 'all'
Requires-Dist: pytest-watch ; extra == 'all'
Requires-Dist: sphinx ; extra == 'all'
Requires-Dist: sphinx-autoapi ; extra == 'all'
Requires-Dist: sphinx-gallery >=0.12.1 ; extra == 'all'
Requires-Dist: sphinx-rtd-theme ; extra == 'all'
Requires-Dist: sphinxcontrib-versioning ; extra == 'all'
Requires-Dist: wheel ; extra == 'all'
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: matplotlib ; extra == 'dev'
Requires-Dist: numpydoc ; extra == 'dev'
Requires-Dist: ipykernel ; extra == 'dev'
Requires-Dist: pillow ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-flake8 ; extra == 'dev'
Requires-Dist: pylint ; extra == 'dev'
Requires-Dist: pytest-watch ; extra == 'dev'
Requires-Dist: sphinx ; extra == 'dev'
Requires-Dist: sphinx-autoapi ; extra == 'dev'
Requires-Dist: sphinx-gallery >=0.1.12 ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
Requires-Dist: sphinxcontrib-versioning ; extra == 'dev'
Requires-Dist: wheel ; extra == 'dev'

Light weight package to read and exploit km3net compass data
============================================================

.. image:: https://git.km3net.de/km3py/km3compass/badges/master/pipeline.svg
    :target: https://git.km3net.de/km3py/km3compass/pipelines

.. image:: https://git.km3net.de/km3py/km3compass/badges/master/coverage.svg
    :target: https://km3py.pages.km3net.de/km3compass/coverage

.. image:: https://git.km3net.de/examples/km3badges/-/raw/master/docs-latest-brightgreen.svg
    :target: https://km3py.pages.km3net.de/km3compass


Setup
=====

Currently, only solution is to install the repository from source.
After cloning the repository, you can install it with pip (preferably inside a virtual env).
From inside the repository:


.. code:: bash

   pip install ./

And you are done !


Command line interface
======================

This package provides some command line tool that can be used to interact with compass data.




Acknowledgements
================

Thanks especially to the gracious help of all contributors:

Valentin Pestel, Adrian Saina, Tamas Gal, Cristiano Bozza, Bryan Darquea, Jhilik Majumdar

