README.md

# KM3Aux

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://common.pages.km3net.de/KM3Aux.jl/stable)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://common.pages.km3net.de/KM3Aux.jl/dev)
[![Build Status](https://git.km3net.de/common/KM3Aux.jl/badges/main/pipeline.svg)](https://git.km3net.de/common/KM3Aux.jl/pipelines)
[![Coverage](https://git.km3net.de/common/KM3Aux.jl/badges/main/coverage.svg)](https://git.km3net.de/common/KM3Aux.jl/commits/main)

Welcome to the `KM3Aux.jl` repository! Your partner for accessing files from the
legendary [KM3NeT Auxiliary Files Archive](https://git.km3net.de/auxiliary_data/calibration)
for calibration data.


## Documentation

Check out the **[Latest Documention](https://common.pages.km3net.de/KM3Aux.jl/dev)**
which also includes tutorials and examples.


## Installation

`KM3Aux.jl` is not an officially registered Julia package but it's available via
the [KM3NeT Julia registry](https://git.km3net.de/common/julia-registry). To add
the KM3NeT Julia registry to your local Julia registry list, follow the
instructions in its
[README](https://git.km3net.de/common/julia-registry#adding-the-registry) or simply do

    git clone https://git.km3net.de/common/julia-registry ~/.julia/registries/KM3NeT
    
After that, you can add `KM3Aux.jl` just like any other Julia package:

    julia> import Pkg; Pkg.add("KM3Aux")
    

## Quickstart

Make sure to clone the [KM3NeT Auxiliary Files Archive](https://git.km3net.de/auxiliary_data/calibration)
to a folder and set the environment variable `KM3AUX_CALIB_PATH` to that path:

    git clone git@git.km3net.de:auxiliary_data/calibration.git /path/to/the/archive
    export KM3AUX_CALIB_PATH=/path/to/the/archive

``` julia-repl
julia> using KM3Aux

julia> fpath = filepath(160, 19468, "pmt")
"/path/to/the/archive/00000160/pmt/_H_1.1.3/00019465/00019532/1.txt"
```