Metadata-Version: 1.1
Name: orcanet
Version: 0.13.4
Summary: Runs Neural Networks for usage in the KM3NeT project
Home-page: https://git.km3net.de/ml/OrcaNet
Author: Michael Moser, Stefan Reck
Author-email: stefan.reck@fau.de, mmoser@km3net.de, michael.m.moser@fau.de
License: AGPL
Description: OrcaNet: A training organizer for Deep Learning in KM3NeT
        =========================================================
        
        .. image:: https://badge.fury.io/py/orcanet.svg
            :target: https://badge.fury.io/py/orcanet
        
        .. image:: https://git.km3net.de/ml/OrcaNet/badges/master/pipeline.svg
            :target: https://git.km3net.de/ml/OrcaNet/pipelines
        
        .. image:: https://examples.pages.km3net.de/km3badges/docs-latest-brightgreen.svg
            :target: https://ml.pages.km3net.de/OrcaNet
        
        .. image:: https://git.km3net.de/ml/OrcaNet/badges/master/coverage.svg
            :target: https://ml.pages.km3net.de/OrcaNet/coverage
        
        .. image:: https://api.codacy.com/project/badge/Grade/6c81a8396eb34a9d88f07b6620535432
            :alt: Codacy Badge
            :target: https://www.codacy.com/app/sreck/OrcaNet?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=StefReck/OrcaNet&amp;utm_campaign=Badge_Grade
        
        
        OrcaNet is a deep learning framework based on tensorflow in order to simplify the
        training process of neural networks for astroparticle physics, in particular
        for Orca, Arca and Antares. It incorporates
        automated logging, plotting and validating during the training, as well as
        saving and continuing the training process. Additionally, it features easy 
        management of multiple neural network inputs and the use of training data 
        which is split over multiple files.
        
        In this sense, it tackles many challenges that are usually found in 
        astroparticle physics, like huge datasets.
        
        Documentation is at https://ml.pages.km3net.de/OrcaNet/.
        
        OrcaNet is a part of the Deep Learning efforts for the neutrino telescope KM3NeT.
        Find more information about KM3NeT on http://www.km3net.org .
        
        OrcaNet is currently being developed at the official KM3NeT gitlab (https://git.km3net.de/ml/OrcaNet).
        
        However, there's also a github mirror that can be found at https://github.com/ViaFerrata/OrcaNet.
        
        
        Installation
        ------------
        
        OrcaNet can be installed via pip by running::
        
            pip install orcanet
        
        
        In order to make use of tensorflow's GPU acceleration, you need cuda and
        cudnn installed. You can see which of these each tensorflow version needs here
        https://www.tensorflow.org/install/source#gpu
        
        
        Containerization
        ----------------
        The easiest way to run OrcaNet is with singularity.
        A Singularity image of the latest stable version of OrcaNet with tensorflow
        and cuda/cudnn for GPUs
        is automatically uploaded to our sftp server.
        Download it e.g. via::
        
            wget http://pi1139.physik.uni-erlangen.de/singularity/orcanet_v0.13.4.sif
        
        and run it e.g. via::
        
            singularity shell orcanet.sif
        
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
