Skip to content

Latest commit

 

History

History
68 lines (53 loc) · 3.83 KB

README.md

File metadata and controls

68 lines (53 loc) · 3.83 KB
Raw

DARC

DOICI

Data Analysis of Real-time Candidates from the Apertif Radio Transient System

This repository contains the necessary software to automatically process FRB candidates produced by the ARTS real-time system. As of Summer 2020, DARC has discovered 18 new FRBs and several bursts from known repeaters. An extended description of DARC and other ARTS software can be Leon Oostrum's PhD thesis, available here.

Installation

Requirements:

The following packages are automatically installed when installing DARC through pip:

  • astropy
  • h5py
  • matplotlib
  • numpy
  • pypdf4
  • pytz
  • pyyaml
  • scipy
  • voevent-parse

To install a DARC release, for example v3.0: pip install git+https://github.com/loostrum/darc/archive/v3.0.tar.gz
To install the latest master: pip install git+https://github.com/loostrum/darc.git

Overview

DARC comprises several parts that communicate through either queues or sockets. Each node of the ARTS cluster runs one instance of DARC.

  • DARCMaster: Master service. Handles communication with user, controls all other services.
  • AMBERListener: Continuously reads AMBER triggers and puts them on a Python queue.
  • AMBERClustering: Clusters AMBER triggers together and puts them on queues for either IQUV or LOFAR triggering.
  • DADATrigger: Generates and sends dada_dbevent triggers for stokes I and IQUV
  • LOFARTrigger: Generates and sends LOFAR TBB triggers.
  • VOEventGenerator: Converts incoming triggers to a VOEvent and sends them to a VOEvent broker.
  • StatusWebsite: Queries status of all services and generates status webpage.
  • OfflineProcesing: Handles offline processing, runs after every observation.
  • Processor: Semi-real-time extraction and analysis of AMBER triggers. Replacement for OfflineProcessing

Executables

darc: Used to interact with the all services through the DARC Master service.
darc_start_master: Starts the DARC Master service if not already running.
darc_stop_master: Stops the DARC Master service and by extension all other services.
darc_start_all_services: Starts all services, including DARC Master if it is not running.
darc_stop_all_services: Stops all services except DARC Master.
darc_kill_all: Kill DARC Master service and by extension all other services.
darc_service: The DARC Master service. Should not be started directly, but through darc_start_master or darc_start_all_services

Usage

Note: This example is specific to the ARTS cluster and assumes you are logged in to the ARTS master node. The python virtual env (. ~/darc/venv/bin/activate) needs to be activated to be able to run DARC commands manually. Always start DARC on the master node before starting it on other nodes. DARC can be started automatically across the cluster by running start_full_pipeline and stopped with stop_full_pipeline.

Start DARC (e.g. on the master and arts001): darc_start_all_services; ssh arts001 . ~/darc/venv/bin/activate && darc_start_all_services
Verify that all services are running: darc --host arts001 --service all status
Check the log file of a specific service: tail ~/darc/log/amber_clustering.arts001.log
Restart a specific service: darc --host arts001 --service amber_clustering restart
Start an observation: darc --host arts001 --parset /path/to/parset start_observation
To consult the status of DARC across the cluster, open the ~arts/darc/status webpage on the master node.

Documentation

Available at https://trasal.github.io/darc/