Metadata-Version: 2.2
Name: astroviper
Version: 0.0.42
Summary: Astro Visibility and Image Parallel Execution Reduction 
Author-Email: Jan-Willem Steeb <jsteeb@nrao.edu>, Dave Mehringer <dmehring@nrao.edu>, Kumar Golap <kgolap@nrao.edu>, Takahiro Tsutsumi <ttsutsum@nrao.edu>, Srikrishna Sekhar <ssekhar@nrao.edu>
License: BSD 3-Clause License
         
         All works in this repository are copyrighted 2026.
         For inquiries contact  Associated Universities, Inc., 2650 Park Tower Drive Vienna, VA 22180, USA.
         
         Portions of this repository are copyrighted by the following entities:
         1. AUI/NRAO, ESO, NAOJ, in the framework of the ALMA partnership.
         2. AUI/NRAO in the framework of the ngVLA project.
         
         Redistribution and use in source and binary forms, with or without
         modification, are permitted provided that the following conditions are met:
         
         1. Redistributions of source code must retain the above copyright notice, this
            list of conditions and the following disclaimer.
         
         2. Redistributions in binary form must reproduce the above copyright notice,
            this list of conditions and the following disclaimer in the documentation
            and/or other materials provided with the distribution.
         
         3. Neither the name of the copyright holder nor the names of its
            contributors may be used to endorse or promote products derived from
            this software without specific prior written permission.
         
         THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
         AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
         IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
         DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
         FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
         DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
         SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
         CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
         OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
         OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
         
Requires-Python: <3.15,>=3.11
Requires-Dist: graphviper>=0.0.57
Requires-Dist: opt_einsum
Requires-Dist: pyfftw
Requires-Dist: gdown
Provides-Extra: casacore
Requires-Dist: xradio[casacore]>=1.3.0; extra == "casacore"
Provides-Extra: interactive
Requires-Dist: matplotlib; extra == "interactive"
Requires-Dist: prettytable; extra == "interactive"
Requires-Dist: jupyterlab; extra == "interactive"
Requires-Dist: ipykernel; extra == "interactive"
Requires-Dist: ipympl; extra == "interactive"
Requires-Dist: ipython; extra == "interactive"
Requires-Dist: jupyter-client; extra == "interactive"
Requires-Dist: bokeh; extra == "interactive"
Requires-Dist: holoviews; extra == "interactive"
Requires-Dist: graphviz; extra == "interactive"
Provides-Extra: docs
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: recommonmark; extra == "docs"
Requires-Dist: scanpydoc; extra == "docs"
Requires-Dist: sphinx-autoapi; extra == "docs"
Requires-Dist: sphinx-autosummary-accessors; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: twine; extra == "docs"
Requires-Dist: pandoc; extra == "docs"
Provides-Extra: all
Requires-Dist: xradio[casacore]>=1.3.0; extra == "all"
Requires-Dist: pytest; extra == "all"
Requires-Dist: pytest-cov; extra == "all"
Requires-Dist: pytest-html; extra == "all"
Requires-Dist: matplotlib; extra == "all"
Requires-Dist: prettytable; extra == "all"
Requires-Dist: jupyterlab; extra == "all"
Requires-Dist: ipykernel; extra == "all"
Requires-Dist: ipympl; extra == "all"
Requires-Dist: ipython; extra == "all"
Requires-Dist: jupyter-client; extra == "all"
Requires-Dist: nbsphinx; extra == "all"
Requires-Dist: recommonmark; extra == "all"
Requires-Dist: scanpydoc; extra == "all"
Requires-Dist: sphinx-autoapi; extra == "all"
Requires-Dist: sphinx-autosummary-accessors; extra == "all"
Requires-Dist: sphinx_rtd_theme; extra == "all"
Requires-Dist: twine; extra == "all"
Requires-Dist: pandoc; extra == "all"
Requires-Dist: pre-commit; extra == "all"
Requires-Dist: nbstripout; extra == "all"
Requires-Dist: bokeh; extra == "all"
Requires-Dist: graphviz; extra == "all"
Description-Content-Type: text/markdown

# AstroVIPER

AstroVIPER (Visibility and Image Parallel Execution Reduction) is in development.

[![Python 3.12 3.13 3.14](https://img.shields.io/badge/python-3.12%20%7C%203.13%20%7C%203.14-blue)](https://www.python.org/downloads/release/python-3140/)
[![Linux Tests](https://github.com/casangi/astroviper/actions/workflows/python-testing-linux.yml/badge.svg?branch=main)](https://github.com/casangi/astroviper/actions/workflows/python-testing-linux.yml?query=branch%3Amain)
[![macOS Tests](https://github.com/casangi/astroviper/actions/workflows/python-testing-macos.yml/badge.svg?branch=main)](https://github.com/casangi/astroviper/actions/workflows/python-testing-macos.yml?query=branch%3Amain)
[![ipynb Tests](https://github.com/casangi/astroviper/actions/workflows/run-ipynb.yml/badge.svg?branch=main)](https://github.com/casangi/astroviper/actions/workflows/run-ipynb.yml?query=branch%3Amain)
[![Coverage](https://codecov.io/gh/casangi/astroviper/branch/main/graph/badge.svg)](https://codecov.io/gh/casangi/astroviper/branch/main/astroviper)
<!-- [![Documentation Status](https://readthedocs.org/projects/astroviper/badge/?version=latest)](https://astroviper.readthedocs.io) -->
[![Version Status](https://img.shields.io/pypi/v/astroviper.svg)](https://pypi.python.org/pypi/astroviper/)

## Installation

Create a virtual environment using any tool of your choice (`venv`, `uv`, `mamba`, `conda` etc.)
and run

```
pip install astroviper
```

To convert Measurement Set v2 (MSv2) data or image it directly, also install the
casacore table backend, [arcae](https://github.com/ska-sa/arcae), which XRADIO uses
and which has wheels for Linux and macOS:

```
pip install "astroviper[casacore]"
```

### Developer Setup

```bash
git clone git@github.com:casangi/astroviper.git
cd astroviper
pip install -e '.[all]'     # builds the C++ extensions; '[all]' adds test/docs/interactive deps
pre-commit install          # installs ruff + nbstripout git hooks
```
- **After editing any `.cpp` / `.hpp` / `CMakeLists.txt`** you must rebuild for
  the change to take effect (the C++ is compiled at install time):
  ```bash
  pip install -e '.[all]'   # or: pip install .
  ```
  `scikit-build-core` caches in `build/{wheel_tag}/`; if a build behaves oddly,
  delete `build/` and reinstall. The -e creates an editable Python installation.

## Imaging input validation

The cube and continuum workflows share three independent configuration checks
in `processing_functions/imaging/config_check`: residual settings, model-update
settings, and driver/output settings. They reject invalid explicit choices,
physical beam parameters, kernel recipes, control-array shapes, and unsupported
output representations before execution, without modifying caller parameters.
FITS output requires uniformly spaced channel centres; use Zarr for irregular
frequency axes.

Both Briggs weighting variants (`"briggs"` and `"briggs_abs"`) require an
explicit finite `robust` value in `[-2, 2]`; no robustness default is inferred.
For example, use `{"weighting": "briggs", "robust": 0.5}` when 0.5 is the
intended weighting choice. Missing or invalid values fail validation before
input reads, output creation, or graph execution.

Input metadata and generated task boundaries are checked before output writes
or graph execution when they become available. Continuum beam inference needs
only antenna metadata and runs before the first output write. Spectral preflight
uses selected frequency coordinates and equal sample weights, with a
column-normalized float64 rank test. It reads no bulk weights, flags, UVW, or
visibility arrays; its support and noise diagnostics are nominal equal-weight
estimates. Kernel-design
preflight reuses the production kernel cache. Direct entry points use
`input_checked=False`; validated callers pass `True` through the stack. Configuration predicates live in the parameter-check package; legacy helpers
reuse those predicates. Actual-product, cache-consistency, and native-buffer
guards remain active even for checked calls. Both multifield modes remain explicitly unsupported.

See [the configuration-check tutorial](docs/processing_functions_tutorials/imaging/demo_config_check.ipynb)
for valid and invalid examples.
