From 0ae5f913c9fe8222061d3c0cdeae2063a9d71d5f Mon Sep 17 00:00:00 2001 From: David Plankensteiner Date: Thu, 22 Oct 2026 14:27:34 +0200 Subject: [PATCH 1/4] docs: add crates.io READMEs for the published crates Co-Authored-By: Claude Opus 5.5 (1M context) --- crates/ppvm-pauli-sum/README.md | 20 ++++++++++++++++++++ crates/ppvm-pauli-word/README.md | 18 ++++++++++++++++++ crates/ppvm-stim/README.md | 18 ++++++++++++++++++ crates/ppvm-sym/README.md | 18 ++++++++++++++++++ crates/ppvm-tableau-sum/README.md | 18 ++++++++++++++++++ crates/ppvm-tableau/README.md | 18 ++++++++++++++++++ crates/ppvm-traits/README.md | 20 ++++++++++++++++++++ crates/ppvm-tui/README.md | 18 ++++++++++++++++++ crates/ppvm-vihaco/README.md | 18 ++++++++++++++++++ crates/stim-parser/README.md | 18 ++++++++++++++++++ crates/vihaco-circuit-isa/README.md | 18 ++++++++++++++++++ 11 files changed, 202 insertions(+) create mode 100644 crates/ppvm-pauli-sum/README.md create mode 100644 crates/ppvm-pauli-word/README.md create mode 100644 crates/ppvm-stim/README.md create mode 100644 crates/ppvm-sym/README.md create mode 100644 crates/ppvm-tableau-sum/README.md create mode 100644 crates/ppvm-tableau/README.md create mode 100644 crates/ppvm-traits/README.md create mode 100644 crates/ppvm-tui/README.md create mode 100644 crates/ppvm-vihaco/README.md create mode 100644 crates/stim-parser/README.md create mode 100644 crates/vihaco-circuit-isa/README.md diff --git a/crates/ppvm-pauli-sum/README.md b/crates/ppvm-pauli-sum/README.md new file mode 100644 index 000000000..a35d35b8f --- /dev/null +++ b/crates/ppvm-pauli-sum/README.md @@ -0,0 +1,20 @@ +# ppvm-pauli-sum + +Pauli-propagation engine for ppvm: `PauliSum` and `LossyPauliSum`, truncation strategies, and ready-made `Config` bundles. + +Propagation runs in the Heisenberg picture, so gates are applied in reverse circuit order. + +Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. + +## Usage + +```sh +cargo add ppvm-pauli-sum +``` + +- [Documentation](https://queracomputing.github.io/ppvm/) +- [API reference](https://docs.rs/ppvm-pauli-sum) + +## License + +Apache-2.0. See [LICENSE](https://github.com/QuEraComputing/ppvm/blob/main/LICENSE) and [NOTICE](https://github.com/QuEraComputing/ppvm/blob/main/NOTICE). diff --git a/crates/ppvm-pauli-word/README.md b/crates/ppvm-pauli-word/README.md new file mode 100644 index 000000000..05a9e90de --- /dev/null +++ b/crates/ppvm-pauli-word/README.md @@ -0,0 +1,18 @@ +# ppvm-pauli-word + +Packed Pauli-string types for the ppvm simulators: `PauliWord`, `PhasedPauliWord`, `LossyPauliWord` and `PauliPattern`. + +Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. + +## Usage + +```sh +cargo add ppvm-pauli-word +``` + +- [Documentation](https://queracomputing.github.io/ppvm/) +- [API reference](https://docs.rs/ppvm-pauli-word) + +## License + +Apache-2.0. See [LICENSE](https://github.com/QuEraComputing/ppvm/blob/main/LICENSE) and [NOTICE](https://github.com/QuEraComputing/ppvm/blob/main/NOTICE). diff --git a/crates/ppvm-stim/README.md b/crates/ppvm-stim/README.md new file mode 100644 index 000000000..d9436bdcc --- /dev/null +++ b/crates/ppvm-stim/README.md @@ -0,0 +1,18 @@ +# ppvm-stim + +Parse and run [Stim](https://github.com/quantumlib/Stim) circuits on the ppvm `GeneralizedTableau`. + +Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. + +## Usage + +```sh +cargo add ppvm-stim +``` + +- [Documentation](https://queracomputing.github.io/ppvm/) +- [API reference](https://docs.rs/ppvm-stim) + +## License + +Apache-2.0. See [LICENSE](https://github.com/QuEraComputing/ppvm/blob/main/LICENSE) and [NOTICE](https://github.com/QuEraComputing/ppvm/blob/main/NOTICE). diff --git a/crates/ppvm-sym/README.md b/crates/ppvm-sym/README.md new file mode 100644 index 000000000..50097241c --- /dev/null +++ b/crates/ppvm-sym/README.md @@ -0,0 +1,18 @@ +# ppvm-sym + +Symbolic, parametric Pauli propagation for ppvm. Coefficients are polynomials in sines and cosines of symbolic parameters, so a parametric circuit can be propagated once and evaluated at concrete angles later. + +Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. + +## Usage + +```sh +cargo add ppvm-sym +``` + +- [Documentation](https://queracomputing.github.io/ppvm/) +- [API reference](https://docs.rs/ppvm-sym) + +## License + +Apache-2.0. See [LICENSE](https://github.com/QuEraComputing/ppvm/blob/main/LICENSE) and [NOTICE](https://github.com/QuEraComputing/ppvm/blob/main/NOTICE). diff --git a/crates/ppvm-tableau-sum/README.md b/crates/ppvm-tableau-sum/README.md new file mode 100644 index 000000000..51cab6d4d --- /dev/null +++ b/crates/ppvm-tableau-sum/README.md @@ -0,0 +1,18 @@ +# ppvm-tableau-sum + +Sums of generalized stabilizer tableaux for ppvm, with gates, measurement, noise and sampling. + +Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. + +## Usage + +```sh +cargo add ppvm-tableau-sum +``` + +- [Documentation](https://queracomputing.github.io/ppvm/) +- [API reference](https://docs.rs/ppvm-tableau-sum) + +## License + +Apache-2.0. See [LICENSE](https://github.com/QuEraComputing/ppvm/blob/main/LICENSE) and [NOTICE](https://github.com/QuEraComputing/ppvm/blob/main/NOTICE). diff --git a/crates/ppvm-tableau/README.md b/crates/ppvm-tableau/README.md new file mode 100644 index 000000000..9bfa6b2b1 --- /dev/null +++ b/crates/ppvm-tableau/README.md @@ -0,0 +1,18 @@ +# ppvm-tableau + +Generalized stabilizer-tableau simulator for ppvm. `Tableau` handles Clifford circuits; `GeneralizedTableau` adds non-Clifford gates by tracking a sparse vector of coefficients over bitstrings. + +Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. + +## Usage + +```sh +cargo add ppvm-tableau +``` + +- [Documentation](https://queracomputing.github.io/ppvm/) +- [API reference](https://docs.rs/ppvm-tableau) + +## License + +Apache-2.0. See [LICENSE](https://github.com/QuEraComputing/ppvm/blob/main/LICENSE) and [NOTICE](https://github.com/QuEraComputing/ppvm/blob/main/NOTICE). diff --git a/crates/ppvm-traits/README.md b/crates/ppvm-traits/README.md new file mode 100644 index 000000000..2651bfa75 --- /dev/null +++ b/crates/ppvm-traits/README.md @@ -0,0 +1,20 @@ +# ppvm-traits + +Core traits shared by the ppvm crates: the `Config` trait, the single-qubit `Pauli` alphabet, and the `ACMap`/`Trace` map implementations. + +Most users will want a higher-level crate such as `ppvm-pauli-sum` or `ppvm-tableau` instead. + +Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. + +## Usage + +```sh +cargo add ppvm-traits +``` + +- [Documentation](https://queracomputing.github.io/ppvm/) +- [API reference](https://docs.rs/ppvm-traits) + +## License + +Apache-2.0. See [LICENSE](https://github.com/QuEraComputing/ppvm/blob/main/LICENSE) and [NOTICE](https://github.com/QuEraComputing/ppvm/blob/main/NOTICE). diff --git a/crates/ppvm-tui/README.md b/crates/ppvm-tui/README.md new file mode 100644 index 000000000..23f8e604b --- /dev/null +++ b/crates/ppvm-tui/README.md @@ -0,0 +1,18 @@ +# ppvm-tui + +Ratatui components and app state for the `ppvm` terminal UI. The crate does not own a terminal or run an event loop, so the components can be embedded in another ratatui app. The `ppvm` binary itself is in `ppvm-cli`. + +Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. + +## Usage + +```sh +cargo add ppvm-tui +``` + +- [Documentation](https://queracomputing.github.io/ppvm/) +- [API reference](https://docs.rs/ppvm-tui) + +## License + +Apache-2.0. See [LICENSE](https://github.com/QuEraComputing/ppvm/blob/main/LICENSE) and [NOTICE](https://github.com/QuEraComputing/ppvm/blob/main/NOTICE). diff --git a/crates/ppvm-vihaco/README.md b/crates/ppvm-vihaco/README.md new file mode 100644 index 000000000..3526b6f02 --- /dev/null +++ b/crates/ppvm-vihaco/README.md @@ -0,0 +1,18 @@ +# ppvm-vihaco + +Run [vihaco](https://crates.io/crates/vihaco) circuit programs on the ppvm simulators. Parses, compiles and executes `.sst` programs and their `.ssb` bytecode. + +Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. + +## Usage + +```sh +cargo add ppvm-vihaco +``` + +- [Documentation](https://queracomputing.github.io/ppvm/) +- [API reference](https://docs.rs/ppvm-vihaco) + +## License + +Apache-2.0. See [LICENSE](https://github.com/QuEraComputing/ppvm/blob/main/LICENSE) and [NOTICE](https://github.com/QuEraComputing/ppvm/blob/main/NOTICE). diff --git a/crates/stim-parser/README.md b/crates/stim-parser/README.md new file mode 100644 index 000000000..a268370c2 --- /dev/null +++ b/crates/stim-parser/README.md @@ -0,0 +1,18 @@ +# stim-parser + +Parser for the [Stim](https://github.com/quantumlib/Stim) circuit format, including an extended dialect used by ppvm. Reports errors as source diagnostics. + +Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. + +## Usage + +```sh +cargo add stim-parser +``` + +- [Documentation](https://queracomputing.github.io/ppvm/) +- [API reference](https://docs.rs/stim-parser) + +## License + +Apache-2.0. See [LICENSE](https://github.com/QuEraComputing/ppvm/blob/main/LICENSE) and [NOTICE](https://github.com/QuEraComputing/ppvm/blob/main/NOTICE). diff --git a/crates/vihaco-circuit-isa/README.md b/crates/vihaco-circuit-isa/README.md new file mode 100644 index 000000000..13f61ba49 --- /dev/null +++ b/crates/vihaco-circuit-isa/README.md @@ -0,0 +1,18 @@ +# vihaco-circuit-isa + +Quantum-circuit instruction set for the [vihaco](https://crates.io/crates/vihaco) virtual machine, used by ppvm. + +Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. + +## Usage + +```sh +cargo add vihaco-circuit-isa +``` + +- [Documentation](https://queracomputing.github.io/ppvm/) +- [API reference](https://docs.rs/vihaco-circuit-isa) + +## License + +Apache-2.0. See [LICENSE](https://github.com/QuEraComputing/ppvm/blob/main/LICENSE) and [NOTICE](https://github.com/QuEraComputing/ppvm/blob/main/NOTICE). From 018561a36534107a983a6a9e3dfa5326a29cf378 Mon Sep 17 00:00:00 2001 From: David Plankensteiner Date: Thu, 22 Oct 2026 14:32:07 +0200 Subject: [PATCH 2/4] docs: expand crate README descriptions Co-Authored-By: Claude Opus 5.5 (1M context) --- crates/ppvm-pauli-sum/README.md | 2 +- crates/ppvm-pauli-word/README.md | 2 ++ crates/ppvm-stim/README.md | 2 ++ crates/ppvm-sym/README.md | 4 +++- crates/ppvm-tableau-sum/README.md | 4 +++- crates/ppvm-tableau/README.md | 4 +++- crates/ppvm-traits/README.md | 2 ++ crates/ppvm-tui/README.md | 4 +++- crates/ppvm-vihaco/README.md | 4 +++- crates/stim-parser/README.md | 6 +++++- crates/vihaco-circuit-isa/README.md | 2 ++ 11 files changed, 29 insertions(+), 7 deletions(-) diff --git a/crates/ppvm-pauli-sum/README.md b/crates/ppvm-pauli-sum/README.md index a35d35b8f..0eab6c068 100644 --- a/crates/ppvm-pauli-sum/README.md +++ b/crates/ppvm-pauli-sum/README.md @@ -2,7 +2,7 @@ Pauli-propagation engine for ppvm: `PauliSum` and `LossyPauliSum`, truncation strategies, and ready-made `Config` bundles. -Propagation runs in the Heisenberg picture, so gates are applied in reverse circuit order. +You start from an observable and apply the circuit's gates to it in reverse order (Heisenberg picture), then evaluate the result against an initial state. The number of terms can grow quickly, so truncation strategies such as `MaxPauliWeight`, `CoefficientThreshold` and `MaxLossWeight` drop terms as you go. `CombinedStrategy` applies two of them in sequence. Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. diff --git a/crates/ppvm-pauli-word/README.md b/crates/ppvm-pauli-word/README.md index 05a9e90de..968f4c995 100644 --- a/crates/ppvm-pauli-word/README.md +++ b/crates/ppvm-pauli-word/README.md @@ -2,6 +2,8 @@ Packed Pauli-string types for the ppvm simulators: `PauliWord`, `PhasedPauliWord`, `LossyPauliWord` and `PauliPattern`. +`PhasedPauliWord` carries a phase alongside the word. `LossyPauliWord` adds an `L` symbol for a lost qubit. `PauliPattern` matches sets of words; for example, `Z?` matches any word made of `I` and `Z`. + Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. ## Usage diff --git a/crates/ppvm-stim/README.md b/crates/ppvm-stim/README.md index d9436bdcc..58dd3804f 100644 --- a/crates/ppvm-stim/README.md +++ b/crates/ppvm-stim/README.md @@ -2,6 +2,8 @@ Parse and run [Stim](https://github.com/quantumlib/Stim) circuits on the ppvm `GeneralizedTableau`. +Parse a circuit once with `parse_extended`, then run a single shot with `execute` or many with `sample`. Parsing is done by `stim-parser`, so circuits can also use ppvm's extensions for non-Clifford gates, qubit loss and leakage. The optional `rayon` feature parallelises multi-shot sampling. + Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. ## Usage diff --git a/crates/ppvm-sym/README.md b/crates/ppvm-sym/README.md index 50097241c..b03e2a179 100644 --- a/crates/ppvm-sym/README.md +++ b/crates/ppvm-sym/README.md @@ -1,6 +1,8 @@ # ppvm-sym -Symbolic, parametric Pauli propagation for ppvm. Coefficients are polynomials in sines and cosines of symbolic parameters, so a parametric circuit can be propagated once and evaluated at concrete angles later. +Symbolic, parametric Pauli propagation for ppvm. + +Coefficients are `Term`s: polynomials in sines and cosines of symbolic parameters. A parametric circuit, such as a variational ansatz, can be propagated once and then evaluated at many concrete angles. Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. diff --git a/crates/ppvm-tableau-sum/README.md b/crates/ppvm-tableau-sum/README.md index 51cab6d4d..7c1a09ab3 100644 --- a/crates/ppvm-tableau-sum/README.md +++ b/crates/ppvm-tableau-sum/README.md @@ -1,6 +1,8 @@ # ppvm-tableau-sum -Sums of generalized stabilizer tableaux for ppvm, with gates, measurement, noise and sampling. +Sums of generalized stabilizer tableaux for ppvm. + +`GeneralizedTableauSum` represents a state as a weighted sum of `GeneralizedTableau`s. Measurement and noise split the state into branches; matching branches are merged and branches below a weight cutoff are dropped. Includes gates, measurement, noise channels and a `Sampler` for drawing shots. Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. diff --git a/crates/ppvm-tableau/README.md b/crates/ppvm-tableau/README.md index 9bfa6b2b1..d8fe890e2 100644 --- a/crates/ppvm-tableau/README.md +++ b/crates/ppvm-tableau/README.md @@ -1,6 +1,8 @@ # ppvm-tableau -Generalized stabilizer-tableau simulator for ppvm. `Tableau` handles Clifford circuits; `GeneralizedTableau` adds non-Clifford gates by tracking a sparse vector of coefficients over bitstrings. +Generalized stabilizer-tableau simulator for ppvm. + +`Tableau` simulates Clifford circuits. `GeneralizedTableau` adds non-Clifford gates by tracking a sparse vector of coefficients over bitstrings, so circuits with few non-Clifford gates stay cheap. Both evolve forward in circuit order (Schrödinger picture) and support measurement, expectation values, and noise channels including qubit loss. The optional `rayon` feature parallelises parts of the simulation. Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. diff --git a/crates/ppvm-traits/README.md b/crates/ppvm-traits/README.md index 2651bfa75..9571b9fee 100644 --- a/crates/ppvm-traits/README.md +++ b/crates/ppvm-traits/README.md @@ -2,6 +2,8 @@ Core traits shared by the ppvm crates: the `Config` trait, the single-qubit `Pauli` alphabet, and the `ACMap`/`Trace` map implementations. +`Config` is a compile-time bundle that fixes the storage, coefficient type, truncation strategy, hasher, Pauli-word representation and map for one `PauliSum` type. The other ppvm crates are generic over it, so choosing a configuration costs nothing at runtime. + Most users will want a higher-level crate such as `ppvm-pauli-sum` or `ppvm-tableau` instead. Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. diff --git a/crates/ppvm-tui/README.md b/crates/ppvm-tui/README.md index 23f8e604b..884df46d6 100644 --- a/crates/ppvm-tui/README.md +++ b/crates/ppvm-tui/README.md @@ -1,6 +1,8 @@ # ppvm-tui -Ratatui components and app state for the `ppvm` terminal UI. The crate does not own a terminal or run an event loop, so the components can be embedded in another ratatui app. The `ppvm` binary itself is in `ppvm-cli`. +Ratatui components and app state for the `ppvm` terminal UI. + +It provides widgets for the program listing, simulator state, measurement record and command line, plus a line editor. The crate does not own a terminal or run an event loop, so the components can be embedded in another ratatui app. The `ppvm` binary itself is in `ppvm-cli`. Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. diff --git a/crates/ppvm-vihaco/README.md b/crates/ppvm-vihaco/README.md index 3526b6f02..e22482368 100644 --- a/crates/ppvm-vihaco/README.md +++ b/crates/ppvm-vihaco/README.md @@ -1,6 +1,8 @@ # ppvm-vihaco -Run [vihaco](https://crates.io/crates/vihaco) circuit programs on the ppvm simulators. Parses, compiles and executes `.sst` programs and their `.ssb` bytecode. +Run [vihaco](https://crates.io/crates/vihaco) circuit programs on the ppvm simulators. + +It parses and compiles `.sst` programs to `.ssb` bytecode, and runs either form. `run_shots` runs many independent shots of a compiled program; with the optional `rayon` feature the shots run in parallel. This is the library behind the `ppvm` command-line tool in `ppvm-cli`. Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. diff --git a/crates/stim-parser/README.md b/crates/stim-parser/README.md index a268370c2..56142f3bb 100644 --- a/crates/stim-parser/README.md +++ b/crates/stim-parser/README.md @@ -1,6 +1,10 @@ # stim-parser -Parser for the [Stim](https://github.com/quantumlib/Stim) circuit format, including an extended dialect used by ppvm. Reports errors as source diagnostics. +Parser for the [Stim](https://github.com/quantumlib/Stim) circuit format. + +It is written in pure Rust and does not depend on Stim, so you can parse, validate and print Stim circuits without the Stim C++ library or Python package. + +`parse` returns the standard Stim syntax tree. `parse_extended` also understands ppvm's extensions, written as Stim instruction tags, for non-Clifford rotations, qubit loss, correlated loss and leakage. Errors are reported as diagnostics that point into the source. A printer turns either tree back into canonical Stim text, and parsing the printed output gives the same tree. Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. diff --git a/crates/vihaco-circuit-isa/README.md b/crates/vihaco-circuit-isa/README.md index 13f61ba49..6385b66fd 100644 --- a/crates/vihaco-circuit-isa/README.md +++ b/crates/vihaco-circuit-isa/README.md @@ -2,6 +2,8 @@ Quantum-circuit instruction set for the [vihaco](https://crates.io/crates/vihaco) virtual machine, used by ppvm. +It defines the `Circuit` component that vihaco programs call into: Pauli and Clifford gates, `T`, single- and two-qubit rotations, `U3`, measurement and reset, Pauli and depolarizing noise, qubit loss and leakage, plus `Truncate` and `Trace`. This crate only describes the instructions; `ppvm-vihaco` executes them. + Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. ## Usage From 64f912bf4b2ed2a323c3006f3a63d7a5c2254dec Mon Sep 17 00:00:00 2001 From: David Plankensteiner Date: Fri, 23 Oct 2026 14:07:00 +0200 Subject: [PATCH 3/4] docs: correct crate README API claims Use the valid `Z?*` pattern syntax, scope expectation values and loss to `GeneralizedTableau`, and describe lossy `PauliSum` as a config rather than a nonexistent `LossyPauliSum` type. Co-Authored-By: Claude Opus 5.5 (1M context) --- crates/ppvm-pauli-sum/README.md | 2 +- crates/ppvm-pauli-word/README.md | 2 +- crates/ppvm-tableau/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/crates/ppvm-pauli-sum/README.md b/crates/ppvm-pauli-sum/README.md index 0eab6c068..78451b30a 100644 --- a/crates/ppvm-pauli-sum/README.md +++ b/crates/ppvm-pauli-sum/README.md @@ -1,6 +1,6 @@ # ppvm-pauli-sum -Pauli-propagation engine for ppvm: `PauliSum` and `LossyPauliSum`, truncation strategies, and ready-made `Config` bundles. +Pauli-propagation engine for ppvm: `PauliSum`, truncation strategies, and ready-made `Config` bundles. A `Config` built on `LossyPauliWord` makes `PauliSum` track qubit loss. You start from an observable and apply the circuit's gates to it in reverse order (Heisenberg picture), then evaluate the result against an initial state. The number of terms can grow quickly, so truncation strategies such as `MaxPauliWeight`, `CoefficientThreshold` and `MaxLossWeight` drop terms as you go. `CombinedStrategy` applies two of them in sequence. diff --git a/crates/ppvm-pauli-word/README.md b/crates/ppvm-pauli-word/README.md index 968f4c995..12a1412df 100644 --- a/crates/ppvm-pauli-word/README.md +++ b/crates/ppvm-pauli-word/README.md @@ -2,7 +2,7 @@ Packed Pauli-string types for the ppvm simulators: `PauliWord`, `PhasedPauliWord`, `LossyPauliWord` and `PauliPattern`. -`PhasedPauliWord` carries a phase alongside the word. `LossyPauliWord` adds an `L` symbol for a lost qubit. `PauliPattern` matches sets of words; for example, `Z?` matches any word made of `I` and `Z`. +`PhasedPauliWord` carries a phase alongside the word. `LossyPauliWord` adds an `L` symbol for a lost qubit. `PauliPattern` matches sets of words; for example, `Z?*` matches any word made of `I` and `Z`. Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. diff --git a/crates/ppvm-tableau/README.md b/crates/ppvm-tableau/README.md index d8fe890e2..cde537e08 100644 --- a/crates/ppvm-tableau/README.md +++ b/crates/ppvm-tableau/README.md @@ -2,7 +2,7 @@ Generalized stabilizer-tableau simulator for ppvm. -`Tableau` simulates Clifford circuits. `GeneralizedTableau` adds non-Clifford gates by tracking a sparse vector of coefficients over bitstrings, so circuits with few non-Clifford gates stay cheap. Both evolve forward in circuit order (Schrödinger picture) and support measurement, expectation values, and noise channels including qubit loss. The optional `rayon` feature parallelises parts of the simulation. +`Tableau` simulates Clifford circuits. `GeneralizedTableau` adds non-Clifford gates by tracking a sparse vector of coefficients over bitstrings, so circuits with few non-Clifford gates stay cheap. Both evolve forward in circuit order (Schrödinger picture) and support measurement and Pauli and depolarizing noise. `GeneralizedTableau` also computes expectation values and models qubit loss and leakage. The optional `rayon` feature parallelises parts of the simulation. Part of [ppvm](https://github.com/QuEraComputing/ppvm), the Programmable Pauli Virtual Machine. From a71c9a79691941b52690332ae4b7111b942f05f3 Mon Sep 17 00:00:00 2001 From: David Plankensteiner Date: Fri, 23 Oct 2026 14:08:07 +0200 Subject: [PATCH 4/4] docs(pauli-sum): drop stale LossyPauliSum from crate docs Co-Authored-By: Claude Opus 5.5 (1M context) --- crates/ppvm-pauli-sum/src/lib.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/ppvm-pauli-sum/src/lib.rs b/crates/ppvm-pauli-sum/src/lib.rs index 097ba4adb..98031f0d2 100644 --- a/crates/ppvm-pauli-sum/src/lib.rs +++ b/crates/ppvm-pauli-sum/src/lib.rs @@ -1,7 +1,7 @@ // SPDX-FileCopyrightText: 2026 The PPVM Authors // SPDX-License-Identifier: Apache-2.0 -//! `PauliSum` / `LossyPauliSum` Pauli-propagation engine, truncation +//! `PauliSum` Pauli-propagation engine, truncation //! strategies, and pre-built `Config` bundles. Built on `ppvm-traits` and //! `ppvm-pauli-word`. pub mod config;