KM3Store

The KM3Store is the central access point to the data offered through the KM3NeT Open Data Center.

Initiate the store with

from openkm3.store import KM3Store
store = KM3Store()

The catalog

Get the catalog of all available collections by calling store.list()

This returns a table of data collections, streams and resources in the data center, listing

  • An identifier per entry

  • the name of the object

  • a description

You can browse through the content by calling an object by its identifier by using

store.list(identifier)

Entry types

Entries in the index can relate to “collections” of various data resources, “streams” of data resources of the same type, or actual data “resources”, in which case each resource entry corresponds to one associated piece of data (e.g. data table, file, or json object).

Local storage and reloading

The catalog is loaded from the KM3NeT Data Centre, and stored in local cache. Further calls to the KM3Store load information that was already retrieved directly from cache. If you want to reload the catalog from the server, call

store.update_catalog()

Retrieving data

To actually load data with a given identifier, call

data = store.get(identifier)