Skip to content

Commit

Permalink
Remove sinter-in-development warnings (#274)
Browse files Browse the repository at this point in the history
  • Loading branch information
Strilanc authored Jul 2, 2022
1 parent d121640 commit eb3e224
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 17 deletions.
9 changes: 6 additions & 3 deletions doc/developer_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ These notes generally assume you are on a Linux system.
- [autoformating code](#autoformat)
- [with clang-format](#autoformat.clang-format)

# <a name="release-checklist"></a>Compatibility guarantees across versions
# <a name="compatibility></a>Compatibility guarantees across versions

A *bug* is bad behavior that wasn't intended. For example, the program crashing instead of returning empty results when sampling from an empty circuit would be a bug.

Expand All @@ -67,9 +67,12 @@ A *spandrel* is an implementation detail that has observable effects, but which
- Commit changes
- `git tag vX.Y.Z`
- Push tag to github
- Check github `Actions` tab and confirm ci is running on the tag
- Wait for ci to finish validating and producing artifacts for the tag
- Get `stim` wheels [from cibuildwheels](#pypackage.stim.cibuildwheels) of this tag
- Build `stimcirq` sdist on this tag [using python setup.py sdist](#pypackage.stimcirq.python)
- Combine `stim` and `stimcirq` package files into one directory
- Build `sinter` sdist on this tag [using python setup.py sdist](#pypackage.sinter.python)
- Combine `stim`, `stimcirq`, and `sinter` package files into one directory
- Bump to next dev version on main branch
- Update version to `vX.Y.dev0` in all setup.py files
- Update `INTENTIONAL_VERSION_SEED_INCOMPATIBILITY` in `src/stim/circuit/circuit.h`
Expand All @@ -79,7 +82,7 @@ A *spandrel* is an implementation detail that has observable effects, but which
- Flagship changes section
- Notable changes section
- Include wheels/sdists as attachments
- Do irreversible steps last
- Do these irreversible and public viewable steps last!
- Upload wheels/sdists to pypi using `twine`
- Publish the github release notes
- Add gates reference page to wiki for the new version
Expand Down
14 changes: 0 additions & 14 deletions glue/sample/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# sinter: fast QEC sampling

> **sinter is still in development. Its API is not stable.**
Sinter is a software tool/library for doing fast monte carlo sampling of
quantum error correction circuits.

Expand All @@ -14,8 +12,6 @@ quantum error correction circuits.
<a name="how_to_works"></a>
# How it works

> **sinter is still in development. Its API is not stable.**
Sinter takes Stim circuits annotated with noise, detectors, and logical
observables.
It uses stim to sample the circuits and pymatching to predict whether the
Expand All @@ -37,8 +33,6 @@ sinter generally achieves good resource utilization of the processes you assign
<a name="how_to_install"></a>
# How to install

**sinter is still in development. Its API is not stable.**

Sinter is available as a pypi package. It can be installed using pip:

```
Expand All @@ -53,8 +47,6 @@ to use sinter's python API.
<a name="how_to_use_python"></a>
# How to use: Python API

> **sinter is still in development. Its API is not stable.**
This example assumes you are in a python environment with sinter
installed.

Expand Down Expand Up @@ -143,8 +135,6 @@ and the corresponding image saved to `plot.png`:
## python API utility methods
> **sinter is still in development. Its API is not stable.**
Sinter's python module exposes a variety of methods that are handy for plotting
or analyzing QEC data. These include:
Expand All @@ -163,8 +153,6 @@ or analyzing QEC data. These include:
<a name="how_to_use_linux"></a>
# How to use: Linux Command Line
> **sinter is still in development. Its API is not stable.**
This example assumes you are using a linux command line in a python virtualenv with `sinter` installed.
## pick circuits
Expand Down Expand Up @@ -281,8 +269,6 @@ Which will save a png image of, and also open a window showing, a plot like this
# The csv format for sample statistics
> **sinter is still in development. Its API is not stable.**
Sinter saves samples as a table using a Comma Separated Value format.
For example:
Expand Down

0 comments on commit eb3e224

Please sign in to comment.