Metadata-Version: 2.3
Name: skarabina
Version: 0.1.4
Summary: Skarabina (dungbeetle): An all purpose 1GC flagger
License: GPLv3
Author: Tim Molteno
Author-email: tim@elec.ac.nz
Requires-Python: >=3.10,<3.14
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: dask-ms[xarray,zarr]
Requires-Dist: stimela (>=2.1.2)
Requires-Dist: zarr (>=2.0)
Description-Content-Type: text/markdown

# Skarabina

skarabina: a basic 1GC radio astronomy RFI flagger

Author: Tim Molteno (tim@elec.ac.nz)

Intended to reduce I/O costs by performing the standard flagging during 1GC efficiently, and with low memory requirements. Skarabina is named after the latin name Skarabinae, the genus of many interesting beetles (uncluding the dungbeetle) in Africa.

## Install

    pip install skarabina
    
## Usage

### Barber flagging

Generate a report (in the style of barber).

    skarabina --ms foo.ms --barber
    
### Clip and Nan Flagging

This will flag a measurement set, and modify it in-place.

    skarabina --ms test.ms --flag-nan --flag-clip [0,100] --apply --clobber
    
The following will write a new measurement set.

    skarabina --ms test.ms --flag-nan --flag-clip [0,100] --apply --clobber --msout bar.ms

    
## Build

    pip install poetry
    poetry install

## Stimela

skarabina is available as a stimela package. You can include it in your pipeline (after installing skarabina) thusly

    _include:
        - (skarabina):
            - skarabina.yml
            
    my-recpipe:
        info: "Print a flagging summary using skarabina"
        inputs:
            ms: MS

        steps:
            flag-summary:
                cab: skarabina
                params:
                    ms: =recipe.ms
                    summary: true

