diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 415c331..68e97f9 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -3,7 +3,7 @@ name: Release # Publishes to PyPI when a GitHub release is published (tag it vX.Y.Z to match the version # in pyproject.toml). Uses PyPI trusted publishing, so no API token is stored in the repo. # One-time setup: on PyPI, add this repository and workflow (release.yml) as a trusted -# publisher for the "pelagos" project, using the "pypi" environment. +# publisher for the "pelagos-decoder" project, using the "pypi" environment. on: release: diff --git a/README.md b/README.md index db4a70d..c1509ed 100644 --- a/README.md +++ b/README.md @@ -46,9 +46,9 @@ accordingly. ## Install ```bash -pip install pelagos[gpu] # decoder + torch/triton -pip install pelagos[gpu,rust] # + the Rust CPU reference, side by side -pip install pelagos[gpu,stim] # + stim / DEM support +pip install pelagos-decoder[gpu] # decoder + torch/triton +pip install pelagos-decoder[gpu,rust] # + the Rust CPU reference, side by side +pip install pelagos-decoder[gpu,stim] # + stim / DEM support ``` Development uses [uv](https://docs.astral.sh/uv/): @@ -127,7 +127,7 @@ decoder = RelayBPDecoder(H_csr=cm.check_matrix, error_priors=cm.error_priors, al ``` Note the field is `cm.error_priors`, not `cm.priors`. This path requires -the `stim` extra (`pip install pelagos[stim]`), which pulls in +the `stim` extra (`pip install pelagos-decoder[stim]`), which pulls in `beliefmatching`. ## Tutorials @@ -155,7 +155,7 @@ important ones are `--backend {rust,triton}`, `--circuit`, `--basis`, needs `pandas`, which ships in the `bench` extra: ```bash -pip install "pelagos[gpu,bench]" # or: uv sync --extra gpu --extra bench +pip install "pelagos-decoder[gpu,bench]" # or: uv sync --extra gpu --extra bench ``` ```bash diff --git a/pyproject.toml b/pyproject.toml index 66c90f9..27a350e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ requires = ["hatchling"] build-backend = "hatchling.build" [project] -name = "pelagos" +name = "pelagos-decoder" version = "0.1.0" description = "GPU-accelerated Relay-BP decoder for qLDPC codes, implemented in Triton." readme = "README.md" @@ -73,12 +73,12 @@ bench = [ ] # Dependencies for running the notebooks in tutorials/. tutorials = [ - "pelagos[gpu,stim]", + "pelagos-decoder[gpu,stim]", "matplotlib", "jupyterlab", ] all = [ - "pelagos[gpu,rust,stim,test,bench,tutorials]", + "pelagos-decoder[gpu,rust,stim,test,bench,tutorials]", ] [tool.hatch.build.targets.wheel] diff --git a/tutorials/01_single_gpu_quickstart.ipynb b/tutorials/01_single_gpu_quickstart.ipynb index 0f239a3..4da4e35 100644 --- a/tutorials/01_single_gpu_quickstart.ipynb +++ b/tutorials/01_single_gpu_quickstart.ipynb @@ -30,7 +30,7 @@ "**Requirements:** a CUDA or ROCm GPU and the tutorial dependencies:\n", "\n", "```bash\n", - "pip install \"pelagos[tutorials]\" # or, from a clone: uv sync --extra tutorials\n", + "pip install \"pelagos-decoder[tutorials]\" # or, from a clone: uv sync --extra tutorials\n", "```\n", "\n", "**Runtime:** about 3–4 minutes on a laptop GPU (RTX 3000 Ada, 8 GB). The first decode of each\n", @@ -639,7 +639,7 @@ "(`tests/test_triton_against_rust.py`). Here we run both decoders with the same parameters on\n", "the same shots. Their random number streams differ, so individual decodings can differ.\n", "The logical error rates should agree within statistical error. Install the reference with\n", - "`pip install \"pelagos[rust]\"`." + "`pip install \"pelagos-decoder[rust]\"`." ] }, { @@ -669,7 +669,7 @@ " import relay_bp\n", "except ImportError:\n", " relay_bp = None\n", - " print(\"relay-bp not installed; skipping (pip install 'pelagos[rust]').\")\n", + " print(\"relay-bp not installed; skipping (pip install 'pelagos-decoder[rust]').\")\n", "\n", "if relay_bp is not None:\n", " n = 512\n", diff --git a/uv.lock b/uv.lock index bdd208e..5fe561e 100644 --- a/uv.lock +++ b/uv.lock @@ -1,5 +1,5 @@ version = 1 -revision = 3 +revision = 5 requires-python = ">=3.11" resolution-markers = [ "python_full_version >= '3.14' and sys_platform == 'win32'", @@ -1962,7 +1962,7 @@ wheels = [ ] [[package]] -name = "pelagos" +name = "pelagos-decoder" version = "0.1.0" source = { editable = "." } dependencies = [ @@ -2021,8 +2021,8 @@ requires-dist = [ { name = "numpy" }, { name = "nvidia-ml-py", marker = "extra == 'gpu'" }, { name = "pandas", marker = "extra == 'bench'" }, - { name = "pelagos", extras = ["gpu", "rust", "stim", "test", "bench", "tutorials"], marker = "extra == 'all'" }, - { name = "pelagos", extras = ["gpu", "stim"], marker = "extra == 'tutorials'" }, + { name = "pelagos-decoder", extras = ["gpu", "rust", "stim", "test", "bench", "tutorials"], marker = "extra == 'all'" }, + { name = "pelagos-decoder", extras = ["gpu", "stim"], marker = "extra == 'tutorials'" }, { name = "pytest", marker = "extra == 'test'" }, { name = "relay-bp", marker = "extra == 'rust'", specifier = ">=0.0.2" }, { name = "scipy" },