Metadata-Version: 2.4
Name: xradio
Version: 1.1.3
Summary:  Xarray Radio Astronomy Data IO
Author-email: Jan-Willem Steeb <jsteeb@nrao.edu>, Federico Montesino Pouzols <pouzols@eso.edu>, Dave Mehringer <dmehring@nrao.edu>, Peter Wortmann <peter.wortmann@skao.int>
License: BSD 3-Clause License
        
        All works in this repository are copyrighted 2024.  
        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.14,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: xarray
Provides-Extra: zarr
Requires-Dist: astropy; extra == "zarr"
Requires-Dist: toolviper>=0.0.12; extra == "zarr"
Requires-Dist: s3fs; extra == "zarr"
Requires-Dist: scipy; extra == "zarr"
Requires-Dist: xarray; extra == "zarr"
Requires-Dist: zarr<3,>=2; extra == "zarr"
Requires-Dist: pyarrow; extra == "zarr"
Requires-Dist: psutil; extra == "zarr"
Provides-Extra: test
Requires-Dist: astropy; extra == "test"
Requires-Dist: toolviper>=0.0.12; extra == "test"
Requires-Dist: s3fs; extra == "test"
Requires-Dist: scipy; extra == "test"
Requires-Dist: xarray; extra == "test"
Requires-Dist: zarr<3,>=2; extra == "test"
Requires-Dist: pyarrow; extra == "test"
Requires-Dist: psutil; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest-html; extra == "test"
Requires-Dist: python_casacore>=3.6.1; sys_platform != "darwin" and extra == "test"
Provides-Extra: casacore
Requires-Dist: astropy; extra == "casacore"
Requires-Dist: toolviper>=0.0.12; extra == "casacore"
Requires-Dist: s3fs; extra == "casacore"
Requires-Dist: scipy; extra == "casacore"
Requires-Dist: xarray; extra == "casacore"
Requires-Dist: zarr<3,>=2; extra == "casacore"
Requires-Dist: pyarrow; extra == "casacore"
Requires-Dist: psutil; extra == "casacore"
Requires-Dist: python_casacore>=3.6.1; sys_platform != "darwin" and extra == "casacore"
Provides-Extra: interactive
Requires-Dist: astropy; extra == "interactive"
Requires-Dist: toolviper>=0.0.12; extra == "interactive"
Requires-Dist: s3fs; extra == "interactive"
Requires-Dist: scipy; extra == "interactive"
Requires-Dist: xarray; extra == "interactive"
Requires-Dist: zarr<3,>=2; extra == "interactive"
Requires-Dist: pyarrow; extra == "interactive"
Requires-Dist: psutil; 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"
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"
Requires-Dist: toolviper; extra == "docs"
Provides-Extra: all
Requires-Dist: astropy; extra == "all"
Requires-Dist: toolviper>=0.0.12; extra == "all"
Requires-Dist: s3fs; extra == "all"
Requires-Dist: scipy; extra == "all"
Requires-Dist: xarray; extra == "all"
Requires-Dist: zarr<3,>=2; extra == "all"
Requires-Dist: pyarrow; extra == "all"
Requires-Dist: psutil; extra == "all"
Requires-Dist: pytest; extra == "all"
Requires-Dist: pytest-cov; extra == "all"
Requires-Dist: pytest-html; extra == "all"
Requires-Dist: python_casacore>=3.6.1; sys_platform != "darwin" and 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"
Dynamic: license-file

# xradio
Xarray Radio Astronomy Data IO is still in development.

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

# Installing
XRADIO can be installed in virtual environments via pip. It is recommended to use the conda environment manager from [miniforge](https://github.com/conda-forge/miniforge) to create a clean, self-contained runtime where XRADIO and all its dependencies can be installed, for example:
```sh
conda create --name xradio python=3.13 --no-default-packages
conda activate xradio
```
> 📝 On macOS, if one wants to use the functions to convert MSv2=>MSv4, it is required to pre-install `python-casacore`. That can be done using `conda install -c conda-forge python-casacore`. See more alternatives below.

XRADIO can now be installed using:
```sh
pip install xradio
```
This installs only the minimal dependencies for XRADIO, which allow you to use the schema checker and export schemas to JSON. **Note that if only the minimal dependencies are installed, the functionality to open data stored using zarr and to convert MSv2 to MSv4 will not be available.**

To install the zarr backend use:
```sh
pip install "xradio[zarr]"
```
This allows for opening data stored using zarr. 

To install the zarr backend and the interactive components (JupyterLab) use:
```sh
pip install "xradio[interactive]"
```

To install the casacore backend along with the zarr backend which enables conversion from MSv2 to MSv4 use (this only works for Linux):
```sh
pip install "xradio[casacore]"
```

To installs all the needed packages to run the unit tests:
```sh
pip install "xradio[test]"
```
This also installs the zarr backend and the casacore backend on Linux. Note the tests will fail on MacOS if python-casacore is not installed separately using conda.

Multiple-dependencies can be installed using:
```sh
pip install "xradio[interactive,casacore,test]"
```

To install a more complete set of dependencies:
```sh
pip install "xradio[all]"
```
This will include the dependencies required to run the interactive Jupyter notebooks, run tests, build documentation,
and python-casacore to enable MSv2=>MSv4 functionality on Linux.

Instruction of how to setup a developer environment can be found at [Development](https://xradio.readthedocs.io/en/latest/development.html).

Instruction of how to setup a developer environment using casatools instead of python-casacore can be found at [casatools I/O backend guide](docs/source/measurement_set/guides/backends.md).
