tridec/pyproject.toml at master · bledden/tridec · GitHub

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
[build-system]
requires = ["setuptools>=68"]
build-backend = "setuptools.build_meta"

[project]
name = "tridec"
version = "0.2.2"
description = "Vendor-portable GPU decoders for quantum LDPC codes: Triton min-sum BP and Relay-BP on NVIDIA (CUDA), AMD (ROCm), and experimental Apple-silicon (Metal), with CPU reference implementations, consuming any stim DetectorErrorModel or raw parity-check matrices."
readme = "README.md"
requires-python = ">=3.10"
license = { text = "Apache-2.0" }
authors = [{ name = "Blake Ledden" }]
keywords = ["quantum error correction", "qLDPC", "decoder", "belief propagation", "triton", "stim", "GPU"]
classifiers = [
    "Development Status :: 3 - Alpha",
    "Intended Audience :: Science/Research",
    "License :: OSI Approved :: Apache Software License",
    "Programming Language :: Python :: 3",
    "Topic :: Scientific/Engineering :: Physics",
]

# Version floors are the oldest versions this package is validated against.
# Known-good (validated) combinations — see README "Compatibility" for the full matrix:
#   stim 1.15.0, ldpc 2.4.1, relay-bp 0.2.2,
#   torch 2.4.1 + triton 3.0.0 (CUDA 12.4, H200),
#   torch 2.9 + triton 3.4 (ROCm 7.0, MI300X).
dependencies = [
    "numpy>=1.24",
    "scipy>=1.10",
    "stim>=1.13",
]

[project.urls]
Repository = "https://github.com/bledden/tridec"
Documentation = "https://github.com/bledden/tridec/blob/master/docs/benchmark.md"
Issues = "https://github.com/bledden/tridec/issues"

[project.optional-dependencies]
# torch backend: batched BP that runs on CPU and CUDA/ROCm devices.
torch = ["torch>=2.4"]
# gpu: the Triton fast path (NVIDIA CUDA or AMD ROCm builds of torch+triton).
gpu = ["torch>=2.4", "triton>=3.0"]
# decoders: optional CPU reference decoder adapters (validation targets).
decoders = ["ldpc>=2.4.1", "relay-bp[stim]>=0.2.2"]
# sinter: the sinter.collect custom-decoder integration (tridec.sinter).
sinter = ["sinter>=1.15"]
dev = ["pytest>=8.0", "sinter>=1.15", "pymatching>=2.1"]

[tool.setuptools.packages.find]
where = ["src"]

[tool.pytest.ini_options]
testpaths = ["tests"]
addopts = "-ra"
# Environment markers: the suite runs on three kinds of machines —
#   CPU-only      : gpu + metal tests skip (importorskip / module-level skips)
#   CUDA/ROCm GPU : gpu tests run, metal tests skip
#   Apple silicon + triton-msl : metal tests run, gpu tests skip
markers = [
    "gpu: requires triton + a CUDA/ROCm GPU",
    "metal: requires the experimental triton-msl environment (Apple silicon)",
]