Metadata-Version: 2.4
Name: skarabina
Version: 0.5.1
Summary: Skarabina (dungbeetle): An all purpose 1GC flagger
Author-email: Tim Molteno <tim@elec.ac.nz>
License: GPLv3
License-File: LICENSE
Requires-Python: <3.14,>=3.10
Requires-Dist: dask-ms[xarray,zarr]
Requires-Dist: stimela>=2.1.2
Requires-Dist: zarr>=2.0
Description-Content-Type: text/markdown

<!-- Copyright (c) 2025-2026 Tim Molteno (tim@elec.ac.nz) -->
# Skarabina

```
 =,                .=
=.|      ,---.      |.=
=.|   "-(:::::)-"   |.=
   \\__/`-.|.-'\__//
    `-| .::| .::|-'      Pillendreher
     _|`-._|_.-'|_       (Scarabaeus sacer)
   /.-|    | .::|-.\
  // ,| .::|::::|. \\
 || //\::::|::' /\\ ||
 /'\|| `.__|__.' ||/'\
^    \\         //    ^
     /'\       /'\
    ^             ^
```

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 can also do averaging to reduce data volume, and measurement set analysis to recommend image size.

## Documentation

See [doc/](doc/index.md) for full documentation:

- [Usage & CLI reference](doc/usage.md)
- [Time & frequency averaging](doc/AVERAGING.md)
- [Measurement set analyzer](doc/ANALYZE.md)
- [Changelog](doc/CHANGES.md)

## Install

    pip install skarabina

## Quick start

```sh
# Flag and clean
skarabina --ms raw.ms --flag-nan --flag-uv-above 4000 \
    --time-average-factor 3 --optimize --msout clean.ms --clobber

# Analyze
skarabina-analyze --ms raw.ms --image-fov 2.5
```

## Build

Install [uv](https://docs.astral.sh/uv/), then:

    uv sync
    uv build

## Stimela

```yaml
_include:
    - (skarabina):
        - skarabina.yml

my-recipe:
    info: "Print a flagging summary using skarabina"
    inputs:
        ms: MS
    steps:
        flag-summary:
            cab: skarabina
            params:
                ms: =recipe.ms
                summary: true
```
