Metadata-Version: 2.4
Name: aoquality
Version: 0.5
Summary: Python module to access Measurement Sets' quality statistics produced by aoflagger, aoquality or DPPP.
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Author: Florent Mertens
Author-email: florent.mertens@gmail.com
Requires-Python: >=3.10,<4.0
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
Classifier: Programming Language :: Python :: 3.14
Provides-Extra: dev
Requires-Dist: astropy (>=5.0)
Requires-Dist: click (>=7.0)
Requires-Dist: matplotlib (>=3.0)
Requires-Dist: numpy (>=1.20)
Requires-Dist: pytest (>=7.0) ; extra == "dev"
Requires-Dist: pytest-cov (>=5.0) ; extra == "dev"
Requires-Dist: python-casacore (>=3.0)
Requires-Dist: ruff (==0.16.1) ; extra == "dev"
Project-URL: Documentation, https://pyaoquality.readthedocs.io
Project-URL: Homepage, https://gitlab.com/flomertens/pyaoquality
Project-URL: Issues, https://gitlab.com/flomertens/pyaoquality/-/issues
Project-URL: Repository, https://gitlab.com/flomertens/pyaoquality
Description-Content-Type: text/markdown

# aoquality

`aoquality` reads and analyses the Measurement Set **quality statistics**
produced by [AOFlagger](https://aoflagger.readthedocs.io), `aoquality`, or
[DP3](https://dp3.readthedocs.io).

It provides a small Python API over the three AOQuality table types (baseline,
frequency, and time statistics) — reading a single Measurement Set or combining
many — and a command-line tool, `aostats`, for diagnostic plots and outlier
detection across many observations.

**Documentation: https://pyaoquality.readthedocs.io**

## Installation

```bash
pip install aoquality
```

Requires Python ≥ 3.8.

## Quick start

Python API:

```python
import aoquality

bl = aoquality.BaselineStat('obs.MS')
ant_names, ant_stats = bl.get_antenna_stat('SNR')   # (n_ant,), (n_ant, n_pol)
```

Command line:

```bash
aostats plot obs.MS SNR -o stat_snr            # single-MS diagnostic plots
aostats plot-grid obs1/ obs2/ obs3/ SNR        # multi-observation grids
aostats find-bad-stations *.qs SNR -o bad.json # flag outlier antennas
```

See the [documentation](https://pyaoquality.readthedocs.io) for the full Python
API, usage guide, and `aostats` command-line reference.

