Metadata-Version: 2.4
Name: almaqso
Version: 1.6.0b4
Summary: Add your description here
Requires-Python: >=3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: astroquery>=0.4.10
Requires-Dist: coloredlogs>=15.0.1
Requires-Dist: ipython>=9.0.2
Requires-Dist: matplotlib>=3.10.1
Requires-Dist: numpy>=2.2.4
Requires-Dist: pandas>=2.2.3
Requires-Dist: pyvo>=1.6.1
Requires-Dist: scipy>=1.15.2
Requires-Dist: setuptools>=78.0.2
Requires-Dist: spectral-cube>=0.6.6
Requires-Dist: tdqm>=0.0.1
Requires-Dist: tenacity>=9.1.2
Dynamic: license-file

<a href='https://github.com/akimasanishida/almaqso' target="_blank"><img alt='GitHub' src='https://img.shields.io/badge/GitHub_Repository-100000?style=flat&logo=GitHub&logoColor=white&labelColor=black&color=FFFFFF'/></a>
[![Static Badge](https://img.shields.io/badge/docs-GitHub%20Pages-blue?logo=GitHub)](https://akimasanishida.github.io/almaqso/)

# almaqso

This repository is a folk of [astroysmr/almaqso](https://github.com/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](https://github.com/akimasanishida/almaqso/issues)

## Pre-requisites

### CASA

Please use [CASA](https://casa.nrao.edu/) **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](https://zenodo.org/records/17252072).
I strongly recommend you to use the **LATEST** version of it.

## Installation

You can install this package by

```shell
pip install almaqso
```

Then you can use the package like this:

```python
import almaqso
```

## Usage

See sample code in `sample` folder and [documentation](https://akimasanishida.github.io/almaqso/).

## Developer Guide

### Pre-requisites

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

- [uv](https://github.com/astral-sh/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:

```shell
uv sync --dev
```

Then, you can run `main.py` or something with

```shell
uv run main.py  # or something
```

### Render diagrams

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

```shell
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:**
```shell
./scripts/sphinx-build-html.sh
```
If you do not use uv, run with python instead:
```shell
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`.

```shell
./scripts/sphinx-build-pdf.sh
```

<!-- When you need to reproduce the `almaqso.rst` file with the change of codes,
```shell
uv run sphinx-apidoc -o docs almaqso
``` -->

### Branches

- `main`: The main branch.
- `with-old-codes`: The branch with old codes (created by original editor). This is for the reference.
