Skip to content

Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Support Matrix

This page separates what hpc-compose can build, what CI currently exercises, and what is officially supported for real workflows.

Support levels

LevelMeaning
Officially supportedMaintained target for user-facing workflows and issue triage
CI-testedExercised in the repository’s automated checks today
Release-builtPrebuilt archive is published, but that is not a promise of full runtime support

Officially supported

PlatformScopeNotes
Linux x86_64Full CLI and runtime workflowsRequires Slurm client tools plus at least one supported runtime backend: Pyxis/Enroot, Apptainer, Singularity, or host software modules
Linux arm64Full CLI and runtime workflowsSame cluster requirements as Linux x86_64
macOS x86_64Authoring and local non-runtime commandsSuitable for project-local authoring flows such as new, setup, context, plan, validate, inspect, render, and completions; not for Slurm/Enroot runtime commands
macOS arm64Authoring and local non-runtime commandsSame scope as macOS x86_64

CI-tested

PlatformWhat is tested today
Ubuntu 24.04 x86_64formatting, clippy, unit/integration tests, docs build, link checks, installer smoke tests, and coverage
macOS arm64authoring-focused tests, validate/render/schema smoke tests, installer smoke tests, and Homebrew smoke tests
macOS x86_64authoring-focused tests, validate/render/schema smoke tests, and Homebrew smoke tests

Current CI validates full runtime-facing behavior on Ubuntu and authoring/distribution behavior on macOS. Other published builds should be treated as lower-confidence until corresponding CI coverage exists.

Release-built

PlatformStatus
Linux x86_64Release archive published
Linux arm64Release archive published
macOS x86_64Release archive published
macOS arm64Release archive published
Windows x86_64Release archive published, but runtime workflows are not officially supported

Windows status

Windows archives are published so users can inspect the CLI surface or experiment with non-runtime commands, but Windows is currently release-built only:

  • Slurm plus HPC runtime workflows are not an officially supported Windows target.
  • Issues that are specific to Windows runtime execution may be closed as out of scope until the support policy changes.

Cluster assumptions for full support

For full runtime support on Linux, the target environment should provide:

  • sbatch, srun, and related Slurm client tools on the submission host
  • one supported runtime path:
    • Pyxis container support in srun plus Enroot on the submission host,
    • Apptainer on the submission host and compute nodes,
    • Singularity on the submission host and compute nodes,
    • or module/vendor software available on the host runtime path
  • shared storage for the resolved cache directory

Use Runtime Backends, Runbook, and Execution Model before adapting a real workload to a cluster.