convolve-rs 1.0.0

Rust port of beamcon from RACS-tools: smooth FITS images and cubes to a common beam via UV-plane (FFT) convolution
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

name: CI

on:
  workflow_dispatch:
  pull_request:
  push:
    branches:
      - main

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

env:
  # Many color libraries just need this variable to be set to any value.
  FORCE_COLOR: 3
  CARGO_TERM_COLOR: always
  # Bump this to invalidate the cached MIRIAD build.
  MIRIAD_CACHE_VERSION: v1

jobs:
  lint:
    name: Lint & format
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt, clippy

      - uses: Swatinem/rust-cache@v2

      - name: rustfmt
        run: cargo fmt --all --check

      - name: clippy
        # Not --all-features: `abi3` and `stubgen` are mutually exclusive.
        # `stubgen` pulls in the full Python module (it implies `python`).
        run: cargo clippy --all-targets --features stubgen -- -D warnings

      - uses: astral-sh/setup-uv@v7

      - name: ruff check
        run: uvx ruff check .

      - name: ruff format
        run: uvx ruff format --check .

  rust-test:
    name: Rust tests (vs MIRIAD)
    runs-on: ubuntu-latest
    needs: [lint]
    steps:
      - uses: actions/checkout@v6

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@stable

      - uses: Swatinem/rust-cache@v2

      # ── MIRIAD: build from source (csiro/miriad), aggressively cached ────────
      - name: Cache MIRIAD install
        id: miriad-cache
        uses: actions/cache@v4
        with:
          path: ~/miriad-install
          key: miriad-${{ runner.os }}-${{ env.MIRIAD_CACHE_VERSION }}

      - name: Install MIRIAD build dependencies
        if: steps.miriad-cache.outputs.cache-hit != 'true'
        run: |
          sudo apt-get update
          sudo apt-get install -y --no-install-recommends \
            gfortran libx11-dev libpng-dev libreadline-dev cmake

      - name: Build MIRIAD from source
        if: steps.miriad-cache.outputs.cache-hit != 'true'
        run: |
          git clone --depth 1 https://github.com/csiro/miriad.git /tmp/miriad-src
          cmake -S /tmp/miriad-src -B /tmp/miriad-build \
            -DCMAKE_INSTALL_PREFIX="$HOME/miriad-install"
          cmake --build /tmp/miriad-build --target install -j"$(nproc)"

      - name: Run Rust tests
        run: |
          # The MIRIAD comparison test reads MIRIAD_BIN and derives the rest of
          # the runtime environment (catalogs, etc.) from the install prefix.
          export MIRIAD_BIN="$HOME/miriad-install/bin"
          # The integration tests exercise the pure-Rust API; no Python features.
          cargo test

  python-test:
    name: Python ${{ matrix.python-version }}
    runs-on: ubuntu-latest
    needs: [lint]
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.10", "3.12", "3.13", "3.14"]
    steps:
      - uses: actions/checkout@v6

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@stable

      - uses: Swatinem/rust-cache@v2

      - uses: astral-sh/setup-uv@v7
        with:
          python-version: ${{ matrix.python-version }}

      # Builds the maturin extension module and installs the `test` extra
      # (pytest, radio-beam, astropy). cfitsio is compiled from source via the
      # crate's `fitsio-src` feature, so no system library is needed.
      - name: Build extension and install test dependencies
        run: uv sync --extra test

      - name: Run pytest
        run: uv run --no-sync pytest -ra --durations=20