Release 0.3.0

.copier-answers.yml

@@ -0,0 +1,9 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: 0.1.0
+_src_path: https://github.com/python-accelerator-middle-layer/pyaml-repository-template.git
+distribution_name: accelerator-middle-layer
+html_title: pyaml
+import_name: pyaml
+package_name: pyaml
+repository_url: https://github.com/python-accelerator-middle-layer/pyaml
+use_docs_extra: false

.github/workflows/dt4acc-integration.yml

@@ -0,0 +1,128 @@
+name: dt4acc integration
+
+on:
+  workflow_dispatch:
+    inputs:
+      dt4acc_image_uri:
+        description: "Apptainer ORAS image URI for the dt4acc twin"
+        required: false
+        default: "oras://registry.synchrotron-soleil.fr/software_control_system_public/dt4acc-soleil-twin:latest"
+  pull_request:
+    branches: ["main"]
+    paths:
+      - ".github/workflows/dt4acc-integration.yml"
+      - "pyaml/**"
+      - "tests/integration/**"
+      - "pyproject.toml"
+
+permissions:
+  contents: read
+
+jobs:
+  smoke:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+
+    defaults:
+      run:
+        shell: bash -el {0}
+
+    env:
+      TANGO_HOST: 127.0.0.1:10000
+      DT4ACC_IMAGE_URI: ${{ inputs.dt4acc_image_uri || 'oras://registry.synchrotron-soleil.fr/software_control_system_public/dt4acc-soleil-twin:latest' }}
+      DT4ACC_REGISTRY_USER: ${{ secrets.DT4ACC_REGISTRY_USER }}
+      DT4ACC_REGISTRY_PASSWORD: ${{ secrets.DT4ACC_REGISTRY_PASSWORD }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          repository: ${{ github.event.pull_request.head.repo.full_name || github.repository }}
+          ref: ${{ github.event.pull_request.head.ref || github.ref_name }}
+
+      - name: Set up Apptainer
+        uses: eWaterCycle/setup-apptainer@v2
+
+      - name: Set up Python environment
+        uses: mamba-org/setup-micromamba@v2
+        with:
+          environment-name: pyaml-dt4acc-integration
+          create-args: >-
+            -c conda-forge
+            python=3.12
+            pip
+            pytest
+            pytango
+          cache-environment: true
+
+      - name: Install pyAML and control-system backends
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[test]"
+          python -m pip install "ophyd-async[tango, ca, pva]"
+          python -m pip install --no-deps \
+            "tango-pyaml @ git+https://github.com/python-accelerator-middle-layer/tango-pyaml.git@1f010735bd675ad2f918958abd0396cb6766f14e" \
+            "pyaml-cs-oa @ git+https://github.com/python-accelerator-middle-layer/pyaml-cs-oa.git@0.2.0"
+          python -c "import tango; import tango.pyaml; import pyaml_cs_oa"
+
+      - name: Log in to GitLab registry
+        if: ${{ env.DT4ACC_REGISTRY_USER != '' && env.DT4ACC_REGISTRY_PASSWORD != '' }}
+        run: |
+          printf '%s' "${DT4ACC_REGISTRY_PASSWORD}" |
+            apptainer registry login \
+              --username "${DT4ACC_REGISTRY_USER}" \
+              --password-stdin \
+              oras://gitlab-registry.synchrotron-soleil.fr
+
+      - name: Pull dt4acc twin image
+        run: |
+          mkdir -p "${RUNNER_TEMP}/apptainer"
+          apptainer pull --force --disable-cache \
+            "${RUNNER_TEMP}/apptainer/dt4acc-soleil-twin.sif" \
+            "${DT4ACC_IMAGE_URI}"
+
+      - name: Start dt4acc twin
+        run: |
+          LOG_FILE="${RUNNER_TEMP}/dt4acc-twin.log"
+          PID_FILE="${RUNNER_TEMP}/dt4acc-twin.pid"
+
+          ACCEL_SETUP_FILE=$(python -c "from pyaml_test_lattice import configurations; print(configurations['dt4acc/fodo_1gev_6d_dt4acc_tango.json'])")
+          LATTICE_FILE=$(python -c "from pyaml_test_lattice import lattices; print(lattices['fodo_1gev_6d.json'])")
+
+          bash tests/integration/start_dt4acc_twin.sh \
+            --accelerator-setup-file "${ACCEL_SETUP_FILE}" \
+            --lattice-file "${LATTICE_FILE}" \
+            --tango-host "${TANGO_HOST%:*}" \
+            --tango-port "${TANGO_HOST##*:}" \
+            --sif "${RUNNER_TEMP}/apptainer/dt4acc-soleil-twin.sif" \
+            --log-file "${LOG_FILE}" \
+            --pid-file "${PID_FILE}" \
+            --timeout 900 \
+            --detach
+
+      - name: Run pyAML dt4acc smoke test
+        env:
+          PYAML_DT4ACC_INTEGRATION: "1"
+          TANGO_HOST: "127.0.0.1:10000"
+        run: |
+          python -m pytest -v tests/integration/test_dt4acc_twin_smoke.py
+
+      - name: Stop dt4acc twin
+        if: always()
+        run: |
+          PID_FILE="${RUNNER_TEMP}/dt4acc-twin.pid"
+          if [ -f "${PID_FILE}" ]; then
+            TWIN_PID="$(cat "${PID_FILE}")"
+            kill -- "-${TWIN_PID}" 2>/dev/null || kill "${TWIN_PID}" 2>/dev/null || true
+            sleep 5
+            kill -KILL -- "-${TWIN_PID}" 2>/dev/null || kill -KILL "${TWIN_PID}" 2>/dev/null || true
+          fi
+          if [ -f "${RUNNER_TEMP}/dt4acc-twin.log" ]; then
+            tail -n 200 "${RUNNER_TEMP}/dt4acc-twin.log" || true
+          fi
+
+      - name: Upload dt4acc logs
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: dt4acc-twin-log
+          path: ${{ runner.temp }}/dt4acc-twin.log

.github/workflows/github-release.yml

@@ -0,0 +1,49 @@
+name: GitHub Release
+
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+*'
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    name: Build and create release on GitHub
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out source
+        uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.11"
+
+      - name: Install Hatch
+        run: python -m pip install --upgrade hatch
+
+      - name: Build distribution
+        run: hatch build
+
+      - name: Determine whether this is a pre-release
+        id: release_type
+        shell: bash
+        run: |
+          tag="${GITHUB_REF_NAME#v}"
+
+          if [[ "$tag" =~ (\.dev[0-9]+|a[0-9]+|b[0-9]+|rc[0-9]+)$ ]]; then
+            echo "prerelease=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "prerelease=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v3
+        with:
+          draft: false
+          prerelease: ${{ steps.release_type.outputs.prerelease }}
+          generate_release_notes: true
+          files: dist/*

.github/workflows/ruff_formatting.yml

@@ -4,7 +4,6 @@ on:
   push:
     branches: [ main ]
   pull_request:
-    branches: [ main ]
 
 jobs:
   ruff-check:

.github/workflows/tests.yml → .github/workflows/unit-tests.yml

@@ -1,13 +1,13 @@
-# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# This workflow will install Python dependencies, run tests and lint with a several version of Python
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
-name: run tests
+name: Run unit tests
 
 on:
   push:
     branches: [ "main" ]
   pull_request:
-    branches: [ "main" ]
+  workflow_dispatch:
 
 permissions:
   contents: read
@@ -16,27 +16,39 @@ jobs:
   build:
 
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: >-
+          ${{ (github.event_name == 'push' || github.event_name == 'workflow_dispatch')
+              && fromJSON(vars.PYTHON_ALL_SUPPORTED_TEST_VERSIONS)
+              || fromJSON(vars.PYTHON_DEFAULT_TEST_VERSIONS) }}
 
     steps:
-    - uses: actions/checkout@v4
-      with:
-        submodules: recursive
-    - name: Set up Python 3.12
-      uses: actions/setup-python@v3
+    - uses: actions/checkout@v6
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v7
       with:
-        python-version: ">=3.12"
+        python-version: ${{ matrix.python-version }}
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install .[test]
         pip install ./tests/dummy_cs/tango-pyaml
         pip install ./tests/external
         pip install flake8
+
+    - name: Display Python version
+      run: python -c "import sys; print(sys.version)"
+
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+
     - name: Test with pytest
       run: python -m pytest tests

.readthedocs.yaml

@@ -1,39 +1,25 @@
-# .readthedocs.yaml
 # Read the Docs configuration file
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 
 # Required
 version: 2
 
-# Set the OS, Python version and other tools you might need
+# Set the OS, Python version, and other tools you might need
 build:
   os: ubuntu-24.04
   tools:
     python: "3.13"
-    # You can also specify other tool versions:
-    # nodejs: "23"
-    # rust: "1.82"
-    # golang: "1.23"
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
-  configuration: docs/conf.py
+   configuration: docs/source/conf.py
 
-# Optionally build your docs in additional formats such as PDF and ePub
-# formats:
-#    - pdf
-#    - epub
-
-# Optional but recommended, declare the Python requirements required
-# to build your documentation
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:
   install:
+    - requirements: docs/requirements.txt
     - method: pip
       path: .
-      extra_requirements:
-      - doc
-
-submodules:
-  include: all
-  recursive: true
+      extra_requirements: []