.. _gallery_nb_gallery_example_openstore.ipynb:

Exploring ODC data
==================

The KM3Store serves as interface to the data available in the open data
center (ODC). Information is retrieved on first use of the KM3Store from
the ODC and stored in cache.

.. code:: ipython3

    from openkm3.store import KM3Store
    store = KM3Store()


.. parsed-literal::

    INFO:root:Loaded catalog from cache.


If information should be reloaded from the ODC, update the catalog.

.. code:: ipython3

    store.update_catalog()
    store.list() # lists all available collections


.. parsed-literal::

    INFO:root:Updated catalog!



Collections from the Open Data Center
-------------------------------------

+------------------+--------------------------------------------------+------------------------------------------------------------------------------------+
| Identifier       | Title                                            | Description                                                                        |
+==================+==================================================+====================================================================================+
| ana20\_01        | ANTARES 2007-2017 neutrino point source search   | Cosmic neutrino event candidate selection from search for neutrino point sources   |
+------------------+--------------------------------------------------+------------------------------------------------------------------------------------+
| evts20\_01       | One week of ORCA 4-line data                     | Events from one week of data taking with ORCA                                      |
+------------------+--------------------------------------------------+------------------------------------------------------------------------------------+
| acoustic20\_01   | Acoustic data                                    | Acoustic data samples from ORCA hydrophone                                         |
+------------------+--------------------------------------------------+------------------------------------------------------------------------------------+


.. code:: ipython3

    store.list("ana20_01") # list information about object (collection) with the given identifier



ANTARES 2007-2017 neutrino point source search
----------------------------------------------

+--------------------+--------------------------------------------+------------------------------------------------------------------------------------------------+
| Identifier         | Title                                      | Description                                                                                    |
+====================+============================================+================================================================================================+
| ana20\_01\_vo      | ANTARES 2007-2017 neutrino events          | Event list of neutrino candidates                                                              |
+--------------------+--------------------------------------------+------------------------------------------------------------------------------------------------+
| ana20\_01\_pub     | ANTARES 2007-2017 point source analysis    | Search for neutrino point sources with the full ANTARES data                                   |
+--------------------+--------------------------------------------+------------------------------------------------------------------------------------------------+
| ana20\_01\_aeff0   | ANTARES 2007-2017 effective area           | effective area for E-2 source spectrum at zenith                                               |
+--------------------+--------------------------------------------+------------------------------------------------------------------------------------------------+
| ana20\_01\_bkg     | ANTARES 2007-2017 muon estimate function   | Function for estimation of the muon background for the full analysis for a given declination   |
+--------------------+--------------------------------------------+------------------------------------------------------------------------------------------------+
| ana20\_01\_acc     | ANTARES 2007-2017 detector acceptance      | Lookup table of the detector acceptance for a given declination and source spectral index      |
+--------------------+--------------------------------------------+------------------------------------------------------------------------------------------------+


.. code:: ipython3

    store.get("ana20_01_pub")


.. parsed-literal::

    INFO:root:Cannot load paper. Please visit https://doi.org/10.3847/2041-8213/aad8c0 .
    INFO:root:No data loaded for ana20_01_pub.


.. code:: ipython3

    function = store.get("ana20_01_bkg")
    function


.. parsed-literal::

    INFO:root:Loading data from cache.
    INFO:root:Loaded entry ana20_01_bkg as <class 'openkm3.dataclasses.Function'>.




.. parsed-literal::

    <openkm3.dataclasses.Function at 0x7f3608b42220>



.. code:: ipython3

    store.list("acoustic20_01") 



Acoustic data
-------------

+-----------------------+----------------------------------------+---------------------------------------------------------+
| Identifier            | Title                                  | Description                                             |
+=======================+========================================+=========================================================+
| acoustic20\_01\_wav   | Acoustic data stream wave              | Samples of acoustic data from ARCA DOM as wav file      |
+-----------------------+----------------------------------------+---------------------------------------------------------+
| acoustic20\_01\_mp3   | Acoustic data stream mp3               | Samples of acoustic data from ORCA DOM as mp3 file      |
+-----------------------+----------------------------------------+---------------------------------------------------------+
| acoustic20\_01\_raw   | Acoustic data stream raw               | Samples of acoustic data from ORCA DOM as raw files     |
+-----------------------+----------------------------------------+---------------------------------------------------------+
| acoustic20\_01\_psd   | Acoustic data stream psd information   | Statistical quantities of acoustic data from ORCA DOM   |
+-----------------------+----------------------------------------+---------------------------------------------------------+


Streams hold pieces of data of the same format, e.g. several snippets of
hydrophone data in various formats. You can list all entries in a stream
and access each resource separately.

.. code:: ipython3

    store.list("acoustic20_01_psd") # accesses the stream



Acoustic data stream psd information
------------------------------------

+--------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------+
| Identifier                                             | Title                                             | Description                                             |
+========================================================+===================================================+=========================================================+
| acoustic20\_01\_psd\_DOM\_808974724\_CH1\_1601366233   | Element of Acoustic data stream psd information   | Statistical quantities of acoustic data from ORCA DOM   |
+--------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------+
| acoustic20\_01\_psd\_DOM\_808974724\_CH1\_1599150167   | Element of Acoustic data stream psd information   | Statistical quantities of acoustic data from ORCA DOM   |
+--------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------+
| acoustic20\_01\_psd\_DOM\_808974724\_CH1\_1601455406   | Element of Acoustic data stream psd information   | Statistical quantities of acoustic data from ORCA DOM   |
+--------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------+
| acoustic20\_01\_psd\_DOM\_808974724\_CH1\_1599152165   | Element of Acoustic data stream psd information   | Statistical quantities of acoustic data from ORCA DOM   |
+--------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------+
| acoustic20\_01\_psd\_DOM\_808974724\_CH1\_1601364561   | Element of Acoustic data stream psd information   | Statistical quantities of acoustic data from ORCA DOM   |
+--------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------+
| acoustic20\_01\_psd\_DOM\_808974724\_CH1\_1600355223   | Element of Acoustic data stream psd information   | Statistical quantities of acoustic data from ORCA DOM   |
+--------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------+



.. only:: html

    .. container:: sphx-glr-download

        **Download python script:** :download:`example_openstore.py`

        **Download Jupyter notebook:** :download:`example_openstore.ipynb`