/arcane_suite

Arbitrary Radio astronomiCAl pipeliNE: a set (suite) of radio astronomical pipelines

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Arbitrary Radio astronomiCAl pipeliNE suite (arcane_suite)

Introduction

arcane_suite is a collection of arbitrary analytic and utility tools & libraries and pre-defined Snakemake pipelines that I use for my personal and collaborative projects. As such, the aim of this library is to have most of my frequently used own code in the same place, and to avoid 'copy and paste code' for my various projects. Furthermore, I wanted to develop a framework, in which I can build easy-to-use (deploy & run) pipelines via Snakemake, since many radio astronomical pipelines are data-driven, yet embarrassingly parallel and simple at the same time.

Installation

You can install the latest release from source only at the moment.

Usage and contribution

arcane_suite is primarily developed for personal use, except for some pipelines, which are developed for collaborations. Nonetheless, the code is open-source and open-acces for anyone to use, including the various modules, tools and of course the pipelines.

Contribution of any form is more than welcome and I aim to fix any bugs as quckly as possible. See the see the design & philosophy page for more info. For the upcoming bug fixes and features planned, see the backlog page.

Documentation and testing

Documentation is mostly embedded in the code itself, plus an additional a brief description of the libraries and pipelines included under the Documentation folder. The Documentation is designed to be readable in GitHub, and there is no plan to set up a more serious online documentation yet.

Testing of the code is sparse, since some components are data-driven and some are tested on large data sets. However, I try to add testing with time.

These design choices are driven by the fact, that the code is primarily developed for my own usage and not for wider distribution (see the design & philosophy page for more info).

Copyright and licence

arcane-suite is created by Kristof Rozgonyi and can be distributed/used under the terms of the GNU General Public License V3.

@2022 Kristof Rozgonyi