Skip to main content

cubevis - visualization tools for CASA images

cubevis is a visualization toolkit for radio astronomy image and visibility data, built on Bokeh for the front-end and CASA for the processing backend. Python and CASA drive image/data access while a generated JavaScript interface provides an interactive control front-end, usable from JupyterLab, Google Colab, or plain Python scripts.

The documentation is at https://casangi.github.io/cubevis/.

cubevis replaces the casagui and vidavis packages, which are no longer developed.

cubevis currently provides two applications:

  • Interactive Clean (iclean) - released. Visually observe and control CASA’s image reconstruction (tclean/deconvolve). See Interactive Clean below.

  • Visibility Plotter (visplot) - in development. Interactive visibility-domain plotting supporting both legacy CASA Measurement Sets (MSv2) and the newer AstroVIPER Measurement Set v4 format, via xarray-ms. visplot has no stable end-user API yet; it is not ready for general use.

This is a beta-release quality package.

Installation

cubevis uses optional extras so that installing it doesn’t pull in more than a given application needs. The extras you want depend on which application you’re using:

# Interactive Clean (released)
pip install cubevis[iclean]

# Visibility Plotter (in development - no stable API yet)
pip install cubevis[visplot]

# both applications in one environment
pip install cubevis[iclean,visplot]

# add Jupyter/anywidget support for either, if working in a notebook
pip install cubevis[iclean,notebook]

iclean depends on CASA6’s casatasks, which runs the imaging (tclean); the images themselves are read and written with arcae (see Images below), which the iclean extra installs. visplot depends on xarray-ms / arcae for both its MSv2 and MSv4 backends, so it does not require casatasks even when working with legacy Measurement Sets.

iclean and visplot are convenience aliases for the underlying casa6 and xarray extras, respectively; those backend-named extras are also available directly for anyone assembling a custom environment. The two can be installed together in one plain pip environment (cubevis[iclean,visplot], which is also what cubevis.setup installs for a remote kernel that serves both applications): casatools and arcae each bring their own native libraries and work side by side in one process.

Interactive Clean

Interactive clean is the primary application provided by this package. It allows for visualizally observing and controlling the image reconstruction performed by CASA. The primary CASA tasks used to perform the image reconstruction are tclean and deconvolve.

Usage

This example provide a summary of how to use interactive clean from Python:

from cubevis import iclean

iclean( vis='refim_twopoints_twochan.ms', imagename='test',
        imsize=100, cell='8.0arcsec',
        phasecenter="J2000 19:59:28.500 +40.44.01.50",
        outlierfile='test_outlier.txt',
        niter=50, cycleniter=10, deconvolver='hogbom',
        specmode='mfs', spw='0:0' )

For this sample, the test measurement set is available, while the outlierfile would look something like:

imagename=try_multifield_1
imsize=[80,80]
cell=[8.0arcsec,8.0arcsec]
phasecenter=J2000 19:58:41.095 +40.56.01.043

Images

Interactive clean reads the residual and reads and writes the mask through arcae rather than casatools: CASA images (paged, or concatenated with ia.imageconcat), and xradio images in Zarr. Nothing needs to be set for this. To go back to casatools for image access, set an environment variable where the images are (for a remote session, in the kernel’s environment):

export CUBEVIS_IMAGE_STORE=casatools

With CUBEVIS_DEBUG=1 the log says once which is in use, for example images are read with XarrayImageStore (arcae, through cubevis.xarray.image; no casatools): the default. If arcae or xarray is not installed, casatools is used and the log says so.

The same code is available by itself, with no CASA installed (pip install cubevis[image]):

import xarray as xr
import cubevis.xarray.image                      # registers the "casa-image" engine

ds = xr.open_dataset( 'test.residual', engine='casa-image' )
plane = ds.SKY.isel( time=0, polarization=0, frequency=12 ).values   # reads one plane

from cubevis.xarray.image import CasaImage, write_image
im = CasaImage( 'test.mask' )
im[:, :, 0, 12] = 0                              # index as CASA does: x, y, Stokes, channel

from cubevis.imaging import ImageReader          # a CASA image, an xradio Zarr image, or a dataset
reader = ImageReader.open( 'test.residual' )
reader.info( ).shape, reader.plane( 0, 12 ), reader.spectrum( 50, 50, 0 )

The dataset is laid out as xradio’s image datasets are (SKY, FLAG_SKY, BEAM_FIT_PARAMS_SKY; dims time, frequency, polarization, l, m). The engine is used only when named, so it does not change what xr.open_dataset(path) does where xradio’s own xradio_casa_image engine is installed.

Visibility Plotter

visplot is under active development and does not yet have a stable end-user API - it isn’t ready for general use, and this README will be updated with usage instructions once one is available.

Metadata

Release files for cubevis 1.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cubevis 1.1.4
File Size Uploaded Provenance Actions
cubevis-1.1.4.tar.gz 2.1 MB With provenance Details for cubevis-1.1.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cubevis 1.1.4
File Interpreter ABI Platform Actions
cubevis-1.1.4-py3-none-any.whl Python 3 none any Details for cubevis-1.1.4-py3-none-any.whl

Total release size: 4.4 MB

Release files / cubevis-1.1.4.tar.gz

Download URL cubevis-1.1.4.tar.gz
Size 2.1 MB
Tags Source
SHA-256 checksum
How to use checksums
415eaa822f19359bdd88cfe63bdd4cdbc7f71d372dfab4b0d2a034ff8f96a8b0
BLAKE2b-256 checksum
How to use checksums
d6ef241538bc8e885f30ffbdcec39ddc057ea119e7987e2064ce390feec9a1ab
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / cubevis-1.1.4-py3-none-any.whl

Download URL cubevis-1.1.4-py3-none-any.whl
Size 2.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
9fcec7b973d3f36fdba3eedbee14f42bca3b6ddf53e627f9f14121311aae7bab
BLAKE2b-256 checksum
How to use checksums
34698fb8d338f82f6dbb4a9ca1a2b180d1c86ce6681ffc2eeb3c37ee70103110
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Security for cubevis 1.1.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for cubevis-1.1.4.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.1.4 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page