Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tamasgal/nerca.jl

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/tamasgal/nerca.jl
Owner: tamasgal
License: other
Created: 2016-11-13T23:47:36.000Z (about 8 years ago)
Default Branch: main
Last Pushed: 2024-04-22T12:30:51.000Z (7 months ago)
Last Synced: 2024-09-22T16:07:36.924Z (about 2 months ago)
Language: Julia
Size: 2.67 MB
Stars: 0
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # NeRCA.jl

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://tgal.pages.km3net.de/NeRCA.jl/stable)

[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://tgal.pages.km3net.de/NeRCA.jl/dev)

[![Build Status](https://git.km3net.de/tgal/NeRCA.jl/badges/main/pipeline.svg)](https://git.km3net.de/tgal/NeRCA.jl/pipelines)

[![Coverage](https://git.km3net.de/tgal/NeRCA.jl/badges/main/coverage.svg)](https://git.km3net.de/tgal/NeRCA.jl/commits/main)

## Introduction

Welcome to the `NeRCA.jl` (**Ne**utrino **R**esearch with **C**osmics in the **A**byss) package documentation. This piece of software was written

for those who like to explore the KM3NeT world with a new, modern and ultra fast

programming language designed for scientific computing: [Julia](https://www.julialang.org).

The I/O for KM3NeT related data is provided by [KM3io.jl](https://git.km3net.de/common/KM3io.jl).

## Installation

`NeRCA.jl` was initially registered on the officially Julia package registry but since version 0.11.0, it resides in the [KM3NeT Julia Registry](https://git.km3net.de/common/julia-registry). To install the latest version, you first need to add the KM3NeT Julia Registry to your local registries. Follow the instructions in its README!

*After that*, you can install `NeRCA.jl` just like any other Julia package with `Pkg`:

```julia-repl

using Pkg

Pkg.add("NeRCA")

```

## General information

`NeRCA.jl` started as a hobby project and contained all kinds of KM3NeT related stuff. In 2023, many of the functionalities were extracted to distinct packages. Here are some examples:

- [KM3io.jl](https://git.km3net.de/common/KM3io.jl): general I/O (reading ROOT, DETX and other KM3NeT files)

- [KM3DB.jl](https://git.km3net.de/tgal/KM3DB.jl): accessing the KM3NeT Oracle Database (StreamDS, run setups, detector calibrations, ...)

- [KM3Acoustics.jl](https://git.km3net.de/acoustics/KM3Acoustics.jl): Acoustics stuff, simulation of acoustic events, calibration procedures, ..

- [KM3NeTTestData.jl](https://git.km3net.de/km3py/km3net-testdata): A collection of KM3NeT related sample files (used for tests)