.. OpenKM3 documentation master file, created by
   sphinx-quickstart on Thu Oct 22 15:18:49 2020.

Welcome to the OpenKM3 documentation!
=====================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   
   store.rst
   dataclasses.rst
   nb_gallery/index.rst
   autoapi/index.rst
   

Short overview
==============

OpenKM3 is a python-based interface to the `KM3NeT Open Data Center (ODC) <http://opendata.km3net.de>`_. It allows to easily access data from the ODC, download it and handle it using widely used scientific packages like numpy and pandas.

Installation
------------

Install openkm3 using pip directly from the repository:

.. code-block::

    pip install git+https://git.km3net.de/open-data/openkm3


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`