Skip to content

Commit eb3e224

Browse files
authored
Remove sinter-in-development warnings (#274)
1 parent d121640 commit eb3e224

2 files changed

Lines changed: 6 additions & 17 deletions

File tree

doc/developer_documentation.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ These notes generally assume you are on a Linux system.
4040
- [autoformating code](#autoformat)
4141
- [with clang-format](#autoformat.clang-format)
4242

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

4545
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.
4646

@@ -67,9 +67,12 @@ A *spandrel* is an implementation detail that has observable effects, but which
6767
- Commit changes
6868
- `git tag vX.Y.Z`
6969
- Push tag to github
70+
- Check github `Actions` tab and confirm ci is running on the tag
71+
- Wait for ci to finish validating and producing artifacts for the tag
7072
- Get `stim` wheels [from cibuildwheels](#pypackage.stim.cibuildwheels) of this tag
7173
- Build `stimcirq` sdist on this tag [using python setup.py sdist](#pypackage.stimcirq.python)
72-
- Combine `stim` and `stimcirq` package files into one directory
74+
- Build `sinter` sdist on this tag [using python setup.py sdist](#pypackage.sinter.python)
75+
- Combine `stim`, `stimcirq`, and `sinter` package files into one directory
7376
- Bump to next dev version on main branch
7477
- Update version to `vX.Y.dev0` in all setup.py files
7578
- Update `INTENTIONAL_VERSION_SEED_INCOMPATIBILITY` in `src/stim/circuit/circuit.h`
@@ -79,7 +82,7 @@ A *spandrel* is an implementation detail that has observable effects, but which
7982
- Flagship changes section
8083
- Notable changes section
8184
- Include wheels/sdists as attachments
82-
- Do irreversible steps last
85+
- Do these irreversible and public viewable steps last!
8386
- Upload wheels/sdists to pypi using `twine`
8487
- Publish the github release notes
8588
- Add gates reference page to wiki for the new version

glue/sample/README.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# sinter: fast QEC sampling
22

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

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

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

40-
**sinter is still in development. Its API is not stable.**
41-
4236
Sinter is available as a pypi package. It can be installed using pip:
4337

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

56-
> **sinter is still in development. Its API is not stable.**
57-
5850
This example assumes you are in a python environment with sinter
5951
installed.
6052

@@ -143,8 +135,6 @@ and the corresponding image saved to `plot.png`:
143135
144136
## python API utility methods
145137
146-
> **sinter is still in development. Its API is not stable.**
147-
148138
Sinter's python module exposes a variety of methods that are handy for plotting
149139
or analyzing QEC data. These include:
150140
@@ -163,8 +153,6 @@ or analyzing QEC data. These include:
163153
<a name="how_to_use_linux"></a>
164154
# How to use: Linux Command Line
165155
166-
> **sinter is still in development. Its API is not stable.**
167-
168156
This example assumes you are using a linux command line in a python virtualenv with `sinter` installed.
169157
170158
## pick circuits
@@ -281,8 +269,6 @@ Which will save a png image of, and also open a window showing, a plot like this
281269
# The csv format for sample statistics
282270
283271
284-
> **sinter is still in development. Its API is not stable.**
285-
286272
Sinter saves samples as a table using a Comma Separated Value format.
287273
For example:
288274

0 commit comments

Comments
 (0)