Metadata-Version: 2.1
Name: km3flux
Version: 2.0.0a1
Summary: Neutrino and related fluxes for particle and astroparticle physics
Home-page: https://git.km3net.de/km3py/km3flux
Author: Moritz Lotze and Tamas Gal
Author-email: tgal@km3net.de
Maintainer: Tamas Gal
Maintainer-email: tgal@km3net.de
License: MIT
Keywords: neutrino,fluxes,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: numpy
Requires-Dist: scipy
Requires-Dist: importlib-resources (>=1.3) ; python_version < "3.9"
Provides-Extra: all
Requires-Dist: beautifulsoup4 ; extra == 'all'
Requires-Dist: docopt ; extra == 'all'
Requires-Dist: requests ; extra == 'all'
Requires-Dist: tqdm ; extra == 'all'
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: pytest (>=6) ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: numpydoc ; extra == 'dev'
Requires-Dist: matplotlib ; extra == 'dev'
Requires-Dist: requests ; extra == 'dev'
Requires-Dist: beautifulsoup4 ; extra == 'dev'
Requires-Dist: seaborn ; extra == 'dev'
Requires-Dist: scipy ; 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-napoleon ; extra == 'dev'
Requires-Dist: sphinxcontrib-programoutput ; extra == 'dev'
Requires-Dist: sphinxcontrib-versioning ; extra == 'dev'
Requires-Dist: sphinxcontrib-websupport ; extra == 'dev'
Requires-Dist: tqdm ; extra == 'dev'

The km3flux Python package
==========================

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

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

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

About
=====

KM3Flux is a collection of neutrino flux models + assorted utilities to
deal with them.

Install
=======

You need Python 3.6+. In your python env, do::

    pip install km3flux

or just clone the git repository and install via ``pip install .``

Update or download flux data
============================

The command-line tool ``km3flux`` can be used to manage the flux data which
is stored in an offline archive::

    $ km3flux -h
    Updates the files in the data folder by scraping the publications.
    Existing data files are not re-downloaded.

    Usage:
        km3flux [-spx] update
        km3flux (-h | --help)
        km3flux --version

    Options:
        -x    Overwrite existing files when updating.
        -s    Include seasonal flux data from Honda.
        -p    Include production height tables from Honda.
        -h    Show this screen.
        -v    Show the version.

    Currently only the Honda fluxes are download from
    https://www.icrr.u-tokyo.ac.jp/~mhonda/

Beware that the 2011 dataset is currently not available on the website,
so you will see some errors when trying to download them.


