Metadata-Version: 2.1
Name: km3irf
Version: 0.3.0
Summary: KM3NeT instrument response functions
Home-page: https://git.km3net.de/km3py/km3irf
Author: Tamas Gal
Author-email: tgal@km3net.de
Maintainer: Tamas Gal
Maintainer-email: tgal@km3net.de
License: MIT
Keywords: neutrino,astroparticle,physics,HEP
Platform: UNKNOWN
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
Requires-Dist: astropy
Requires-Dist: hist
Requires-Dist: importlib-resources
Requires-Dist: km3io
Requires-Dist: km3net-testdata (>=0.4.3)
Requires-Dist: km3pipe
Requires-Dist: pandas
Requires-Dist: prettytable
Requires-Dist: scipy
Requires-Dist: setuptools
Requires-Dist: setuptools-scm
Requires-Dist: uproot
Provides-Extra: all
Requires-Dist: black ; extra == 'all'
Requires-Dist: ipykernel ; extra == 'all'
Requires-Dist: matplotlib ; extra == 'all'
Requires-Dist: numpydoc ; extra == 'all'
Requires-Dist: pillow ; extra == 'all'
Requires-Dist: pydata-sphinx-theme (==0.13.0rc4) ; extra == 'all'
Requires-Dist: pytest ; extra == 'all'
Requires-Dist: pytest-cov ; extra == 'all'
Requires-Dist: pytest-flake8 ; extra == 'all'
Requires-Dist: pytest-pylint ; extra == 'all'
Requires-Dist: pytest-watch ; extra == 'all'
Requires-Dist: sphinx ; extra == 'all'
Requires-Dist: sphinx-autoapi (<=1.9.0) ; extra == 'all'
Requires-Dist: sphinx-gallery (>=0.1.12) ; extra == 'all'
Requires-Dist: sphinxcontrib-versioning ; extra == 'all'
Requires-Dist: wheel ; extra == 'all'
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: black[jupyter] ; extra == 'dev'
Requires-Dist: ipykernel ; extra == 'dev'
Requires-Dist: matplotlib ; extra == 'dev'
Requires-Dist: numpydoc ; extra == 'dev'
Requires-Dist: pydata-sphinx-theme (==0.13.0rc4) ; 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: pytest-pylint ; extra == 'dev'
Requires-Dist: pytest-watch ; extra == 'dev'
Requires-Dist: sphinx ; extra == 'dev'
Requires-Dist: sphinx-autoapi (<=1.9.0) ; extra == 'dev'
Requires-Dist: sphinx-gallery (>=0.1.12) ; extra == 'dev'
Requires-Dist: sphinxcontrib-versioning ; extra == 'dev'
Requires-Dist: wheel ; extra == 'dev'
Provides-Extra: test
Requires-Dist: black ; extra == 'test'
Requires-Dist: black[jupyter] ; extra == 'test'
Requires-Dist: ipykernel ; extra == 'test'
Requires-Dist: matplotlib ; extra == 'test'
Requires-Dist: pillow ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pytest-flake8 ; extra == 'test'
Requires-Dist: pytest-pylint ; extra == 'test'
Requires-Dist: pytest-watch ; extra == 'test'
Requires-Dist: wheel ; extra == 'test'

.. image:: https://git.km3net.de/km3py/km3irf/badges/main/pipeline.svg
    :target: https://git.km3net.de/km3py/km3irf/pipelines

.. image:: https://git.km3net.de/km3py/km3irf/badges/main/coverage.svg
    :target: https://km3py.pages.km3net.de/km3irf/coverage

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


KM3NeT instrument response function
====================================

This project provides a versatile tool that can be used to quickly analyze the sensitivity of the **KM3NeT** detector for various source models.
Currently it considers only point-like sources. The main feature of the tool is deep targeting to ``gammapy`` software.
For further analysis in ``gammapy``, ``km3irf`` provides next modules:

* Event list
* Instrument response function (IRF)
* Data set

Installation
~~~~~~~~~~~~

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

  git clone https://git.km3net.de/km3py/km3irf
  cd km3irf
  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/km3irf

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``*


