Add CUDA image

.github/workflows/cuda.yml

@@ -0,0 +1,105 @@
+name: CUDA Docker Build and Push
+run-name: CUDA Image Build and Push triggered by ${{ github.ref_name }} on ${{ github.event_name }} event
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+on:
+  push:
+    # Publish semver tags as releases.
+    tags: ["cuda-v*.*.*", "cuda-v*.*.*-r*"]
+    # Path filters are not evaluated for pushes of tags. https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/triggering-a-workflow#using-filters-to-target-specific-paths-for-pull-request-or-push-events
+
+  pull_request:
+    branches: ["main"]
+    # Only run when changes happen in the cuda directory
+    # TODO: Check this path filter works as expected
+    paths:
+      - "cuda/**"
+
+env:
+  # Use docker.io for Docker Hub if empty
+  REGISTRY: ghcr.io
+  # Use account name of GitHub reoisitory and name as "cuda"
+  # github.repository as <account>/<repo>
+  IMAGE_NAME: ${{ github.repository_owner }}/cuda
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      # This is used to complete the identity challenge
+      # with sigstore/fulcio when running outside of PRs.
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Install the cosign tool except on PR
+      # https://github.com/sigstore/cosign-installer
+      - name: Install cosign
+        if: github.event_name != 'pull_request'
+        uses: sigstore/cosign-installer@59acb6260d9c0ba8f4a2f9d9b48431a222b68e20 #v3.5.0
+        with:
+          cosign-release: "v2.2.4"
+
+      # Set up BuildKit Docker container builder to be able to build
+      # multi-platform images and export cache
+      # https://github.com/docker/setup-buildx-action
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226 # v3.0.0
+
+      # Login against a Docker registry except on PR
+      # https://github.com/docker/login-action
+      - name: Log into registry ${{ env.REGISTRY }}
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Extract metadata (tags, labels) for Docker
+      # https://github.com/docker/metadata-action
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 # v5.0.0
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=match,pattern=cuda-v([0-9]+\.[0-9]+\.[0-9]+-r[0-9]+),group=1 # Only matches revisioned tags
+            type=match,pattern=cuda-v([0-9]+\.[0-9]+\.[0-9]+),group=1,enable=${{ startsWith(github.ref_name, 'cuda-v') && !contains(github.ref_name, '-r') }} # Only matches base tags
+            type=sha
+
+      # Build and push Docker image with Buildx (don't push on PR)
+      # https://github.com/docker/build-push-action
+      - name: Build and push Docker image
+        id: build-and-push
+        uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09 # v5.0.0
+        with:
+          context: ./cuda
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+      # Sign the resulting Docker image digest except on PRs.
+      # This will only write to the public Rekor transparency log when the Docker
+      # repository is public to avoid leaking data.  If you would like to publish
+      # transparency data even for private images, pass --force to cosign below.
+      # https://github.com/sigstore/cosign
+      - name: Sign the published Docker image
+        if: ${{ github.event_name != 'pull_request' }}
+        env:
+          # https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-an-intermediate-environment-variable
+          TAGS: ${{ steps.meta.outputs.tags }}
+          DIGEST: ${{ steps.build-and-push.outputs.digest }}
+        # This step uses the identity token to provision an ephemeral certificate
+        # against the sigstore community Fulcio instance.
+        run: echo "${TAGS}" | xargs -I {} cosign sign --yes {}@${DIGEST}

cuda/Dockerfile

@@ -0,0 +1,28 @@
+# from https://dev.to/yuesu/setting-up-vgpu-in-docker-container-with-specific-python-version-5ei6
+
+# Use an official NVIDIA CUDA runtime as a parent image
+FROM nvidia/cuda:12.8.1-base-ubuntu22.04
+
+
+# Set environment variables
+ENV PYTHONUNBUFFERED=1
+ENV DEBIAN_FRONTEND=noninteractive
+ENV TZ=Europe/Helsinki
+
+# Install Python and pip
+RUN apt-get update && apt-get install -y \
+  python3 \
+  python3-pip \
+  && rm -rf /var/lib/apt/lists/*
+
+RUN pip install --upgrade pip
+
+RUN python3 --version
+RUN pip3 --version
+
+# Create symbolic links for Python
+RUN ln -sf /usr/bin/python3 /usr/bin/python
+
+COPY requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
+

cuda/README.md

@@ -0,0 +1,24 @@
+# Introduction
+
+This serves as a base image for containers that need GPU accelerated quantum simulators like Qiskit Aer or PennyLine Lightning.
+
+## Release a new version
+
+1. Update the `Dockerfile` to change the base image.
+2. Update the `requirements.txt` to set the desired dependencies.
+3. Commit the changes.
+4. Create a Git tag using the format: `cuda-vX.Y.Z` for a base version, or `cuda-vX.Y.Z-rN` for a revision (replace X.Y.Z with the CUDA version used in `Dockerfile` and N with the revision number).
+
+```sh
+# For a base version
+git tag cuda-vX.Y.Z
+git push origin cuda-vX.Y.Z
+# For a revision
+git tag cuda-vX.Y.Z-rN
+git push origin cuda-vX.Y.Z-rN
+```
+
+5. The Github workflow (pipeline) will automatically build and push the image to Github image registry.
+6. The newly created Qubernetes compatible CUDA image can be found in:
+   - `ghcr.io/qubernetes-dev/cuda:X.Y.Z` (for base tags like `cuda-vX.Y.Z`)
+   - `ghcr.io/qubernetes-dev/cuda:X.Y.Z-rN` (for revision tags like `cuda-vX.Y.Z-rN`)

cuda/requirements.txt

@@ -0,0 +1,8 @@
+# needed by qiskit-aer
+# https://github.com/Qiskit/qiskit-aer/blob/main/CONTRIBUTING.md#building-with-cuda-support
+
+nvidia-cuda-runtime-cu12==12.3.101
+nvidia-cublas-cu12==12.3.4.1
+nvidia-cusolver-cu12==11.5.4.101
+nvidia-cusparse-cu12==12.2.0.103
+cuquantum-cu12==23.10.0