almaqso 1.6.1

Automation for downloading and processing ALMA calibration target observations.

almaqso

This repository is a folk of astroysmr/almaqso, which is no longer maintained. Bugs are being removed and some new feature is being implemented.

If you find something or have questions, please refer, report or ask from issue

About

almaqso is an automated package for downloading and analyzing ALMA calibration sources (quasars). Originally developed for analyzing absorption lines, this package addresses a limitation of the standard calibration scripts attached to ALMA archive data, which often mask absorption lines. By generating calibration scripts that preserve these lines, this package ensures accurate analysis of absorption features.

Pre-requisites

CASA

Please use CASA with ALMA pipeline. Version 6 is only supported. I am using CASA version 6.6.6-17-pipeline-2025.1.0.35.

CASA Modules

Please install analysisUtilites. I strongly recommend you to use the LATEST version of it.

Installation

You can install this package by

pip install almaqso

Then you can use the package like this:

import almaqso

Usage

See sample code in sample folder and documentation.

If you find any problems or questions, feel free to report or ask from issue. I would like you to use English or Japanese.

Citation

Please cite this package (software) if it helps your work!

@software{nishida_2026_18334952,
  author       = {Nishida, Akimasa and
                  Ryo, Kishikawa and
                  Yoshimura, Yuki and
                  Narita, Kanako},
  title        = {almaqso},
  month        = jan,
  year         = 2026,
  publisher    = {Zenodo},
  version      = {1.6.0},
  doi          = {10.5281/zenodo.18334952},
  url          = {https://doi.org/10.5281/zenodo.18334952},
  swhid        = {swh:1:dir:ad33568ee7a116c4377820a5ddc87ec3aa0545ce
                   ;origin=https://doi.org/10.5281/zenodo.14752250;vi
                   sit=swh:1:snp:3931013c0f76f5ddc4a12e857819b7522897
                   d68c;anchor=swh:1:rel:2e78a89c6a5fd103e5a5081e988b
                   3e7eb7ecb1b6;path=almaqso-1.6.0
                  },
}

Developer Guide

Pre-requisites

You do not have to install all shown below. Please install only what you need.

• uv: Strongly recommended. uv will manage everything about Python.
• plantuml & graphviz: Install if you want to build docs or re-render the docs/diagrams.
• imagemagick: Install if you want to build PDF version documentation.

You can reproduce the environment with uv:

uv sync --dev

Then, you can run main.py or something with

uv run main.py  # or something

Format code

./scripts/code-check.sh

Test code

For unit tests, run

uv run pytest -m "not integration"

For integration tests, run

uv run pytest -m "integration"

Or, you can run all tests with

uv run pytest

Render diagrams

(Re-)Render all PUML files in docs/diagrams with the command below. SVG files will be generated in the same directory.

plantuml --svg docs/diagrams/

This is run by documentation building scripts below.

Build documentation

If you change the files in docs/diagrams, please recreate the SVG files first as written in Render diagrams section.

HTML:

./scripts/sphinx-build-html.sh

If you do not use uv, run with python instead:

python sphinx-build -b html docs docs/_build/html

Then, please open docs/_build/html/index.html in your browser.

PDF: The script file will build PDF file and copy it to docs/almaqso.pdf.

./scripts/sphinx-build-pdf.sh