Skip to main content

PyPI - Downloads Read the Docs GitHub Release GitHub Last Commit

AVICA: Automated VLBI pipeline in CASA

Accepted for publication in Astronomy & Astrophysics journal.

asciicast

Full documentation: https://avica.readthedocs.io/en/latest/

Contents

Installation

Requirements:

  • Ubuntu 18.04+, Debian 10+, or RHEL/CentOS 8+
  • Python >= 3.9

The avica package is publicly available on PyPI. Use uv or pipx for an isolated command-line installation.

Recommended installation

Using uv:

uv tool install avica --python 3.10

Using pipx:

pipx install avica

Using pip:

pip install avica

If you install with pip, use a virtual environment unless you already manage Python packages another way.

Manual installation

Clone the repository and install it locally:

git clone https://github.com/avikhagol/avica.git
cd avica/
pip install .

Usage

The pipeline calibration steps rely on rPicard. Follow the rPicard setup instructions first. After rPicard is configured, AVICA only needs a minimal configuration file to get started; see Configuration.

Pipeline

Run the default pipeline:

avica pipe run --fitsfilenames <file1.uvfits,file2.uvfits> --target <source-name>

The default pipeline executes these steps:

  • preprocess_fitsidi
  • fits_to_ms
  • phaseshift
  • avica_avg
  • avicameta_ms
  • avica_snr
  • avica_fill_input
  • avica_split_ms
  • rpicard

You can pass one or more step names to run only part of the pipeline:

avica pipe run preprocess_fitsidi fits_to_ms --fitsfilenames <file.uvfits>

Common options:

Option Description
--f, --fitsfilenames Comma-separated FITS-IDI file names.
--t, --target Selected field or source name.
--configfile Configuration file containing key=value entries. Defaults to avica.inp.
--help Show the full command help.

Manipulating FITS-IDI

Check FITS-IDI files for known issues:

avica fitsidi_check <file.uvfits>

Useful options:

Option Description
--fix, --no-fix Apply available fixes. Defaults to --no-fix.
--desc, --no-desc Show issue descriptions. Defaults to --no-desc.
--help Show the full command help.

Example output:

avica fitsidi_check VLBA_VSN005412_file3.uvfits
+--------------------+---------+-------+-------+----------------+----------+
| hdu                | fixable | total | fixed | problem_code   | affected |
+==========================================================================+
| ARRAY_GEOMETRY     | 0       | 8     | 0     | []             | []       |
| ANTENNA            | 0       | 16    | 0     | []             | []       |
| FREQUENCY          | 0       | 8     | 0     | []             | []       |
| PHASE-CAL          | 0       | 12    | 0     | []             | []       |
| PRIMARY            | 1       | 10    | 0     | ["extra_byte"] | [""]     |
| SOURCE             | 0       | 8     | 0     | []             | []       |
| FLAG               | 0       | 12    | 0     | []             | []       |
| UV_DATA            | 0       | 8     | 0     | []             | []       |
| GAIN_CURVE         | 0       | 8     | 0     | []             | []       |
| SYSTEM_TEMPERATURE | 0       | 8     | 0     | []             | []       |
+--------------------+---------+-------+-------+----------------+----------+

List observation information:

avica listobs <file.uvfits>

Configuration

asciicast

The pipeline configuration is a key=value file. By default, AVICA looks for avica.inp in the current directory. See the example configuration for a minimal setup.

Pass a custom configuration file with --configfile:

avica pipe run --configfile <path/to/config/file>

If --configfile is not provided, AVICA uses avica.inp by default.

To store defaults persistently, create ~/.avica/avica.inp from an existing file:

avica pipe config --default --inpfile <path/to/avica.inp>

You can also set default values directly:

avica pipe config --default key=value key2=value2 key3=value3

To set global defaults in AVICA's installed directory, use --global in the same way:

avica pipe config --global --inpfile <path/to/avica.inp>
avica pipe config --global key=value key2=value2 key3=value3

To supersede the rPicard input_template files (array.inp, observation.inp, array_finetune.inp, flagging.inp, constants.inp) used by the rpicard step, point picard_input_template_update at a folder containing the parameters you want to fix:

picard_input_template_update   =   "path/to/folder/with/fixed/inp/files"

Parameter summary

Use --summary to print a report of every pipeline parameter, its resolved value, and where that value came from (inpfile, default, context, or a per-step override):

avica pipe config --summary --inpfile <path/to/avica.inp>

If --inpfile is omitted and avica.inp exists in the current directory, it's read automatically. Combine --summary with key=value overrides on the command line to preview how they would change the resolved configuration before writing it out.

Cleaning up intermediate data

Each pipeline step can remove its own intermediate files (temporary files, superseded Measurement Sets, etc.) once it finishes. This is controlled by:

Option Description
delete_removables Master switch; must be True for any cleanup to happen. Defaults to False.
removables List of glob patterns (relative to the step's working directory) to delete. Can be set globally or per step as <step_name>.removables.
rm_pre / <step_name>.rm_pre If True, delete the matching files before the step runs instead of after.
rm_only Only perform the deletion and skip running the step itself.

Several steps ship with sensible defaults, e.g.:

delete_removables            =   True
preprocess_fitsidi.removables    =   ["raw/*.tmp"]
rpicard.removables               =   ["wd_[SLKQXPD]/VLBI_*.ms"]
fits_to_ms.removables            =   ["*.old"]

Deletion is always confined to the step's working directory; patterns that resolve outside it are ignored.

Attribution

When using AVICA, please add a link to this repository in a footnote.

Acknowledgement

AVICA was developed within the "Search for Milli-Lenses" (SMILE) project. SMILE has received funding from the European Research Council (ERC) under the HORIZON ERC Grants 2021 programme (grant agreement No. 101040021).

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

avica-0.3.1.10.tar.gz (2.0 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

avica-0.3.1.10-cp313-cp313-musllinux_1_2_x86_64.whl (3.4 MB view details)

Uploaded CPython 3.13musllinux: musl 1.2+ x86-64

avica-0.3.1.10-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (2.4 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

avica-0.3.1.10-cp313-cp313-macosx_11_0_arm64.whl (2.2 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

avica-0.3.1.10-cp312-cp312-musllinux_1_2_x86_64.whl (3.4 MB view details)

Uploaded CPython 3.12musllinux: musl 1.2+ x86-64

avica-0.3.1.10-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (2.4 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

avica-0.3.1.10-cp312-cp312-macosx_11_0_arm64.whl (2.2 MB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

avica-0.3.1.10-cp311-cp311-musllinux_1_2_x86_64.whl (3.4 MB view details)

Uploaded CPython 3.11musllinux: musl 1.2+ x86-64

avica-0.3.1.10-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (2.4 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

avica-0.3.1.10-cp311-cp311-macosx_11_0_arm64.whl (2.2 MB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

avica-0.3.1.10-cp310-cp310-musllinux_1_2_x86_64.whl (3.4 MB view details)

Uploaded CPython 3.10musllinux: musl 1.2+ x86-64

avica-0.3.1.10-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (2.4 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

avica-0.3.1.10-cp310-cp310-macosx_11_0_arm64.whl (2.2 MB view details)

Uploaded CPython 3.10macOS 11.0+ ARM64

avica-0.3.1.10-cp39-cp39-musllinux_1_2_x86_64.whl (3.4 MB view details)

Uploaded CPython 3.9musllinux: musl 1.2+ x86-64

avica-0.3.1.10-cp39-cp39-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (2.4 MB view details)

Uploaded CPython 3.9manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

avica-0.3.1.10-cp39-cp39-macosx_11_0_arm64.whl (2.2 MB view details)

Uploaded CPython 3.9macOS 11.0+ ARM64

File details

Details for the file avica-0.3.1.10.tar.gz.

File metadata

  • Download URL: avica-0.3.1.10.tar.gz
  • Upload date:
  • Size: 2.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for avica-0.3.1.10.tar.gz
Algorithm Hash digest
SHA256 38f5b9e7f025bc20aa7c69201fe181aa657b04b328ba11802ed44e76d22717e9
MD5 57ce796e01a216efaf60f6d26a294c40
BLAKE2b-256 22df291d42e029dfd87bafecaedf941a15606a1d7a7d7aa7e59c95fe80e49caa

See more details on using hashes here.

Provenance

The following attestation bundles were made for avica-0.3.1.10.tar.gz:

Publisher: build_wheels.yml on avikhagol/avica

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file avica-0.3.1.10-cp313-cp313-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for avica-0.3.1.10-cp313-cp313-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 79c710a3f120ffe0f52f00ceb120a1141fe4afd28a62c9eb1aaf4b11c2b75b6a
MD5 171342873c90e77e6aeb77549081266d
BLAKE2b-256 590b2585d21b34924750c4fd74f208750a633935e169728b307366713a8e7f65

See more details on using hashes here.

Provenance

The following attestation bundles were made for avica-0.3.1.10-cp313-cp313-musllinux_1_2_x86_64.whl:

Publisher: build_wheels.yml on avikhagol/avica

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file avica-0.3.1.10-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for avica-0.3.1.10-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 b5ca7b32da95d64e4e2ba6a0ac6e9d16f671d46a3c4c25699951bf4977a65f26
MD5 a05c5ad2d5d008be49aba01e9acc38be
BLAKE2b-256 acd800bdaf828262e9a2f7fded55572e58e8eab68c21402fdcce20825774f776

See more details on using hashes here.

Provenance

The following attestation bundles were made for avica-0.3.1.10-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl:

Publisher: build_wheels.yml on avikhagol/avica

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file avica-0.3.1.10-cp313-cp313-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for avica-0.3.1.10-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 ae48968ff06d96ce77f0193a06ee751ed54f310cd9619987e1fb9b0551f9fe8d
MD5 e2e8cf1f1f79288edef66c7aa100a6f5
BLAKE2b-256 9e553e6b3f8eab7a5fa33ea174d5fddb61cde9cdc3eb05f10cebf552cb82e6bc

See more details on using hashes here.

Provenance

The following attestation bundles were made for avica-0.3.1.10-cp313-cp313-macosx_11_0_arm64.whl:

Publisher: build_wheels.yml on avikhagol/avica

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file avica-0.3.1.10-cp312-cp312-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for avica-0.3.1.10-cp312-cp312-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 edf770fff77a9a37328d386bfce461d12250777cfaf31abde342bf8569c63fad
MD5 10154089cd07807db1f95f29407dbfa3
BLAKE2b-256 646b67f2285812841671dfb140055adc2e292069a41a918d34f6cf78eced8b34

See more details on using hashes here.

Provenance

The following attestation bundles were made for avica-0.3.1.10-cp312-cp312-musllinux_1_2_x86_64.whl:

Publisher: build_wheels.yml on avikhagol/avica

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file avica-0.3.1.10-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for avica-0.3.1.10-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 44f14d66b2451866d1e087a4f8d4e9dd1841eb1784d26cc7fcfadfdc022d27a4
MD5 9871633b950a74ce69450264f49026a7
BLAKE2b-256 6995a99d1f76786cfb88b4744de8eb746cc74f92476ee1370bec6f0c51bd92f5

See more details on using hashes here.

Provenance

The following attestation bundles were made for avica-0.3.1.10-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl:

Publisher: build_wheels.yml on avikhagol/avica

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file avica-0.3.1.10-cp312-cp312-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for avica-0.3.1.10-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 69269f47821073b578a991ec6bcc00463abe42cea7711e8474b2d39efb8b3787
MD5 9d578c2a79b080585d7fbbf614f5ad75
BLAKE2b-256 4e4b6ee4664897a6b4c9b44c9e2b3c6ee194ecaece75dbb357ac55aabd43906f

See more details on using hashes here.

Provenance

The following attestation bundles were made for avica-0.3.1.10-cp312-cp312-macosx_11_0_arm64.whl:

Publisher: build_wheels.yml on avikhagol/avica

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file avica-0.3.1.10-cp311-cp311-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for avica-0.3.1.10-cp311-cp311-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 86fdd3e8fb43c3411d563fd30587c2fb82ee8bcad60bbe871fdccab5446fc850
MD5 a5cec051d2ade50973fff1799df07ffa
BLAKE2b-256 ca5585ad788845d1e3bd295008a3b97378e07e9cade49a65a78168115d012fb7

See more details on using hashes here.

Provenance

The following attestation bundles were made for avica-0.3.1.10-cp311-cp311-musllinux_1_2_x86_64.whl:

Publisher: build_wheels.yml on avikhagol/avica

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file avica-0.3.1.10-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for avica-0.3.1.10-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 9218fa3d99af083af9c968c1b3a6df028183a3619ed8b52e4276aa637c6e10f4
MD5 41577b6ce821ab09952c0d79ac474ba4
BLAKE2b-256 174a95146428ae9d84745722d4db24686d77d1cab15d0d5db2d922a05b7e90d4

See more details on using hashes here.

Provenance

The following attestation bundles were made for avica-0.3.1.10-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl:

Publisher: build_wheels.yml on avikhagol/avica

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file avica-0.3.1.10-cp311-cp311-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for avica-0.3.1.10-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 e18f8daca3451b638a62074c97e688150704f24ac051f489bc37ac6ecc622464
MD5 fa08bb6966d789d581090632ce8472d8
BLAKE2b-256 3b510a02a3a105ae89196e05e07352d1236ec884b2ba44ac505d40c673ebefd3

See more details on using hashes here.

Provenance

The following attestation bundles were made for avica-0.3.1.10-cp311-cp311-macosx_11_0_arm64.whl:

Publisher: build_wheels.yml on avikhagol/avica

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file avica-0.3.1.10-cp310-cp310-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for avica-0.3.1.10-cp310-cp310-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 cc87d9d0f30bf9bab292aa797111c76803c0fa6514e1ca3da3a77202313438f7
MD5 b341ddaede7e1c2c08f1b4c4f4630f0f
BLAKE2b-256 db978f0635d8be43e14f6435a1b5adc7d4ec8696aa27ce27f5357adb9645bbd0

See more details on using hashes here.

Provenance

The following attestation bundles were made for avica-0.3.1.10-cp310-cp310-musllinux_1_2_x86_64.whl:

Publisher: build_wheels.yml on avikhagol/avica

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file avica-0.3.1.10-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for avica-0.3.1.10-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 4fecc425ba9b58a9c0af017003ca3a02e9f0b47594d4e3a898e307e18c588e3e
MD5 14f5cc403dadb6e8c46ce3082f15eb6a
BLAKE2b-256 81fc7f03f3bf51f6ce208636c9472b390ed475c1f031d6d52764bb88f84089fd

See more details on using hashes here.

Provenance

The following attestation bundles were made for avica-0.3.1.10-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl:

Publisher: build_wheels.yml on avikhagol/avica

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file avica-0.3.1.10-cp310-cp310-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for avica-0.3.1.10-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 a57be5cb4571c135f71c90a8a0214cdd14f9dba431a73570d41dc2a48f7ee89d
MD5 33d320bb6acc49044b022e6107f99928
BLAKE2b-256 a7e653b41cbef1ac7c945dd4b673e09b8f5cc9aab15cbd84ba0f0deb1ffab200

See more details on using hashes here.

Provenance

The following attestation bundles were made for avica-0.3.1.10-cp310-cp310-macosx_11_0_arm64.whl:

Publisher: build_wheels.yml on avikhagol/avica

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file avica-0.3.1.10-cp39-cp39-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for avica-0.3.1.10-cp39-cp39-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 fa4ac2360d56623a4e3e445ca6d5ac6222e09bb9504b0fd689a5a85e1df5c7e8
MD5 66814f4969fb3e2d6dc789b2f74f9ff7
BLAKE2b-256 1ca65a57da30c9b3aca70571a9c090b5b5fd93641905ba8fbbb65a13f68cc4d2

See more details on using hashes here.

Provenance

The following attestation bundles were made for avica-0.3.1.10-cp39-cp39-musllinux_1_2_x86_64.whl:

Publisher: build_wheels.yml on avikhagol/avica

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file avica-0.3.1.10-cp39-cp39-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for avica-0.3.1.10-cp39-cp39-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 061c204f45fa35287683c2d887d0720b089c50a204e8759f1bc9f78d4c5ceba2
MD5 00253a46a7a4878eaf3ea8155b45a9e3
BLAKE2b-256 20e4ee6458e76a558fd6d4177628b753f9515062d5a1ee5863b9525d209458df

See more details on using hashes here.

Provenance

The following attestation bundles were made for avica-0.3.1.10-cp39-cp39-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl:

Publisher: build_wheels.yml on avikhagol/avica

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file avica-0.3.1.10-cp39-cp39-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for avica-0.3.1.10-cp39-cp39-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 d049c6f8408a39a7406748e3c28411688d5d766839e27022dd5b0a9b42245f07
MD5 5763481024d9c616bf1798de61bd5d91
BLAKE2b-256 e472013da28d9efeb98f247e26304485cce94e250d64ea376e6ac677dd9ee93f

See more details on using hashes here.

Provenance

The following attestation bundles were made for avica-0.3.1.10-cp39-cp39-macosx_11_0_arm64.whl:

Publisher: build_wheels.yml on avikhagol/avica

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.3.1.10 This release

16 files

0.3.1.9

16 files

0.3.1.8

16 files

0.3.1.7

16 files

0.3.1.6

16 files

0.3.1.5

16 files

0.3.1.4

16 files

0.3.1.3

16 files

0.3.1.2

16 files

0.3.1.1

16 files

0.3.1.0

16 files

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