feat: Refactor to support custom gates

.github/workflows/build_wheels.yml

@@ -4,11 +4,15 @@ on:
   pull_request:
     branches:
       - main
+      - 0.2-series
       - 0.3-series
+      - 1.0-series
   push:
     branches:
       - main
+      - 0.2-series
       - 0.3-series
+      - 1.0-series
     tags:
       - "*"
   workflow_dispatch:

.github/workflows/ci_rust.yml

@@ -4,7 +4,9 @@ on:
   pull_request:
     branches:
     - main
+    - 0.2-series
     - 0.3-series
+    - 1.0-series
 
 concurrency:
   group: ${{ github.head_ref || github.run_id }}

.github/workflows/nitpick.yml

@@ -10,7 +10,9 @@ on:
   push:
     branches:
       - main
+      - 0.2-series
       - 0.3-series
+      - 1.0-series
 
 env:
   CARGO_TERM_COLOR: always

.github/workflows/release-please.yml

@@ -5,7 +5,9 @@ on:
   push:
     branches:
       - main
+      - 0.2-series
       - 0.3-series
+      - 1.0-series
 
 permissions:
   contents: write

.release-please-manifest.json

@@ -1,4 +1,4 @@
 {
-    "selene-core": "0.3.0-alpha.1",
-    ".": "0.3.0-alpha.1"
+    "selene-core": "1.0.0-alpha.0",
+    ".": "1.0.0-alpha.0"
 }

Cargo.toml

@@ -19,7 +19,7 @@ members = [
 rust-version = "1.94"
 authors = ["Jake Arkinstall <jake.arkinstall@quantinuum.com>"]
 edition = "2024"
-version = "0.3.0-alpha.1"
+version = "1.0.0-alpha.0"
 repository = "https://github.com/quantinuum/selene"
 license = "Apache-2.0"
 

README.md

@@ -6,7 +6,8 @@ Selene is a quantum computer emulation platform written primarily in Rust with a
 
 Selene is built with flexibility in mind. This includes:
 
-- A plugin system for the addition of additional components including simulators, error models, quantum runtimes to be provided within Selene or as third party plugins
+- A descriptor-based plugin system for simulators, error models, quantum runtimes, and link-time utilities provided either within Selene or as third-party packages.
+- Gatewire gatesets, allowing interfaces and plugins to negotiate custom gate vocabularies before a run starts.
 - Support for custom input formats and device APIs through [the selene-core build system](selene-core/python/selene_core/build_utils).
 
 ## What's included
@@ -32,7 +33,17 @@ Error models that are currently provided include:
 And we offer two example quantum runtimes, including:
 
 - Simple, which executes the program as-is, without any modifications
-- SoftRZ, which elides Z rotations through RXY gates, providing the same observable behaviour with fewer quantum operations
+- SoftRZ, which accepts `RZ` operations and elides physical Z rotations through subsequent gates, providing the same observable behaviour with fewer quantum operations
+
+## Documentation
+
+- [Extensibility docs](docs/extensibility/README.md) cover plugins, utilities,
+  custom gates, and the gatewire handshake.
+- [0.3 migration guide](docs/migration/0.3.md) covers the breaking plugin and
+  gate API changes from the 0.2 series.
+- [Clifford+T stack example](examples/clifford_t_stack/README.md) is a complete
+  custom-gateset project with Python bindings, Rust runtime/error-model
+  plugins, and a C++ simulator plugin.
 
 ## Installation
 

devenv.nix

@@ -4,6 +4,7 @@
     packages = with pkgs; [
       cmake
       just
+      stdenv.cc
       zlib
       libxml2
       ncurses
@@ -69,6 +70,7 @@
         ];
         excludes = [
           "selene-sim/python/tests"
+          "selene-ext/utilities/argreader/python/tests"
           "selene-ext/simulators/quest/python/gate_definitions.py"
           "selene-ext/simulators/stim/python/gate_definitions.py"
         ];

docs/README.md

@@ -0,0 +1,10 @@
+# Selene Documentation
+
+This directory contains user-facing documentation for extending Selene.
+
+If you are moving from Selene 0.2 to the 0.3 series, start with the
+[0.3 migration guide](migration/0.3.md).
+
+Start with [Extensibility](extensibility/README.md) if you want to write a
+plugin, define gates, write a utility, or understand how Selene connects a
+Python-facing interface to runtime, error model, and simulator backends.