You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: add crates.io READMEs for the published crates - #265
The 0.1.0 crates went out without READMEs, so their crates.io pages are empty. This adds a short README.md to each of the 11 published crates that lacked one (ppvm-cli already has its own and is unchanged).
Each README has a one- or two-sentence description taken from the crate's description and crate-level docs, a cargo add line, links to the docs site and docs.rs, and the license. No code examples, so nothing can go stale. Cargo picks up README.md from the crate directory automatically, so no Cargo.toml changes are needed. Links are absolute, so they work on crates.io.
crates.io shows the README of the published version, so these appear with the next release (0.1.1).
Avoid advertising nonexistent public LossyPauliSum type
crates/ppvm-pauli-sum/README.md:3
This crate does not export a Rust LossyPauliSum type. src/sum/mod.rs exports PauliSum, and tests/loss.rs:7–9 defines a local LossyPauliSum alias using a configuration with LossyPauliWord. Advertising a separate public type sends readers looking for an unavailable import. Describe loss-aware PauliSum configurations instead.
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`.
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.
This branch has not been deployed
No deployments
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The 0.1.0 crates went out without READMEs, so their crates.io pages are empty. This adds a short
README.mdto each of the 11 published crates that lacked one (ppvm-clialready has its own and is unchanged).Each README has a one- or two-sentence description taken from the crate's
descriptionand crate-level docs, acargo addline, links to the docs site and docs.rs, and the license. No code examples, so nothing can go stale. Cargo picks upREADME.mdfrom the crate directory automatically, so noCargo.tomlchanges are needed. Links are absolute, so they work on crates.io.crates.io shows the README of the published version, so these appear with the next release (0.1.1).
Test plan
cargo package -p <crate> --listincludesREADME.md(checkedppvm-traits,ppvm-tui,ppvm-stim)🤖 Generated with Claude Code