Metadata-Version: 2.1
Name: km3det
Version: 0.2.4
Summary: km3det, a low weight python io module for KM3NeT detector files
Home-page: https://git.km3net.de/km3py/km3det
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.6
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.6
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: setuptools-scm
Requires-Dist: numpy
Provides-Extra: all
Requires-Dist: black ; extra == 'all'
Requires-Dist: km3net-testdata ; 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: km3net-testdata ; 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'

km3det
======

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

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

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


``km3det`` is a low weight python module for detector definition file io in KM3NeT.

It currently supports:

- Detector files (``datx`` / ``detx``)
- PMT parameters files (``txt``)
  
Installation
~~~~~~~~~~~~

It is recommended to first create an isolated virtualenvironment to not interfere
with other Python projects::

  git clone https://git.km3net.de/km3py/km3det
  cd km3det
  python3 -m venv venv
  . venv/bin/activate

Install directly from the Git server via ``pip`` (no cloneing needed)::

  pip install git+https://git.km3net.de/km3py/km3det

Or clone the repository and run::

  make install

To install all the development dependencies, in case you want to contribute or
run the test suite::

  make install-dev
  make test

  
---

*Created with ``cookiecutter https://git.km3net.de/templates/python-project``*
