Skip to main content

suricat-beams

MeerKAT primary beam model handling utilities

See https://doi.org/10.48479/wdb0-h061 for documentation on beam models.

The utilities can download the models for you automatically, see suricat-beams/suricat/recipes/init.yml Stimela recipe.

Installation

Use pip install suricat-beams for the full package.

Use pip install suricat-beams-cabs to install Stimela cab definitions only.

CLI commands

All commands are accessible via the suricat CLI:

suricat download U                      # Download U-band beam model
suricat mdv2bds input.npz output.bds    # Convert MdV npz to beam dataset
suricat bds2xradio beam.bds.zarr image.zarr output.zarr \
    --output-var SKY \
    --pixel-stepping 4 --time-stepping 4 \
    --num-freq 8 --chunks-time 1 --chunks-freq 1 \
    --elements II --beam-type nstokes          # Render BDS to xradio zarr
suricat mdv2xradio mdv-beams-L.npz output.zarr \
    --antenna -1 --jones HH --part real \
    --output-var SKY                            # Convert MdV npz to xradio zarr

Output format

Both xradio tools produce zarr datasets following the xradio image schema:

Dimensions:   (time, frequency, polarization, l, m)
Coordinates:  time (MJD), frequency (Hz), polarization (str), l (rad), m (rad)
Data vars:    <var_name> (time, frequency, polarization, l, m) float32
Attributes:   direction (reference, latpole, lonpole, projection, pc)

Stimela integration

Stimela cab definitions are in suricat-beams/suricat/cabs/suricat.yml:

  • suricat.download-mdv-beams -- download MdV beams from SARAO archive
  • suricat.mdv-beams-to-bds -- convert MdV npz to beam dataset
  • suricat.bds-to-xradio -- render BDS to xradio zarr image
  • suricat.mdv-to-xradio -- convert MdV npz to xradio zarr image
stimela run suricat-beams/suricat/recipes/init.yml suricat-init band=U

Python API

from suricat.xradio_util import bds_to_xradio, mdv_to_xradio

# Render a BDS with observational context
bds_to_xradio("beam.bds.zarr", "image.zarr", "output.zarr",
              output_var="SKY", num_freq=8, pixel_stepping=4)

# Convert raw MdV beam
mdv_to_xradio("mdv-beams-L.npz", "output.zarr",
              jones="HH", part="real", antenna=-1)

Metadata

Release files for suricat-beams 0.3.0

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

Source distribution (sdist)

Source distribution for suricat-beams 0.3.0
File Size Uploaded Provenance Actions
suricat_beams-0.3.0.tar.gz 32.3 kB Without provenance Details for suricat_beams-0.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for suricat-beams 0.3.0
File Interpreter ABI Platform Actions
suricat_beams-0.3.0-py3-none-any.whl Python 3 none any Details for suricat_beams-0.3.0-py3-none-any.whl

Total release size: 71.7 kB

Release files / suricat_beams-0.3.0.tar.gz

Download URL suricat_beams-0.3.0.tar.gz
Size 32.3 kB
Tags Source
SHA-256 checksum
How to use checksums
b59420c1c5e84a0345cfe0c5e43a00b2ec758920547a0c4b2b6acf6375802e4f
BLAKE2b-256 checksum
How to use checksums
cc30fb59b607f144a6b4fb68ea74470795d942adce614b9e5bc136768547cf8e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.12.3 Linux/6.17.0-1022-azure

Release files / suricat_beams-0.3.0-py3-none-any.whl

Download URL suricat_beams-0.3.0-py3-none-any.whl
Size 39.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c268e72dbaa29fc3106453789e3ccc15c341975fa06ffbc13d09406d1cb357d1
BLAKE2b-256 checksum
How to use checksums
a0a27a1d235b49974f2a8e84c664b10f0c733ed0a77d95babdb59d814b717a19
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.12.3 Linux/6.17.0-1022-azure

Security for suricat-beams 0.3.0

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

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.

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