xradio

Xarray Radio Astronomy Data IO is still in development.

Installing

XRADIO can be installed in virtual environments via pip. It is recommended to use the conda environment manager from miniforge to create a clean, self-contained runtime where XRADIO and all its dependencies can be installed, for example:

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:

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:

pip install "xradio[zarr]"

This allows for opening data stored using zarr.

To install the zarr backend and the interactive components (JupyterLab) use:

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):

pip install "xradio[casacore]"

To installs all the needed packages to run the unit tests:

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:

pip install "xradio[interactive,casacore,test]"

To install a more complete set of dependencies:

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.

Instruction of how to setup a developer environment using casatools instead of python-casacore can be found at casatools I/O backend guide.