snap-base 1.3.1

SuperNova Async Pipeline: base package

SuperNova Async Pipeline

This package contains base for asynchronous real-time data analysis pipeline. It was designed for the supernova neutrino signal detection.

Documentation: https://snap-base.readthedocs.io

Features

• Running chains of generators and functions asynchronously.
• Computationally heavy/blocking code is run in parallel threads/processes.
• Pipeline is configured in a yaml file, where the steps are assembled and parameters are set.
• Branching support: data can be fed to parallel chains for various processing.
• IO interfaces to connect running nodes with each other:
  • ZeroMQ
  • Hopskotch

Installation

pip install snap-base

This will install only the core functionality.

To install also the i/o interfaces use

pip install "snap-base[zmq,hop]"

or

pip install "snap-base[io]"

Defining the pipeline

The pipeline definition consist of

1. A python module (or modules) where all the processing steps should be defined
2. yaml configuration file, defining how the data should flow through these steps.

While this package defines some basic functions, like sending and receiving data via ZMQ or running analysis step in parallel processes, all other needed functions will need to be defined by user in the python package.

Package snap-combine contains more utility functions for the supernova neutrino signals combinations.

Running

Go to the directory where your Run the node named node_name from config.yml:

snap config.yml -n node_name

Example

Put the example module example.py and configuration example_cfg.yml in a directory.

Run the example node with branching:

snap example_cfg.yml -n node_branching

And you should see the output of the generated random walk , and it's analysis in two branches.