A fast library for analyzing with quantum stabilizer circuits.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for mneeley from gravatar.com mneeley Avatar for strilanc from gravatar.com strilanc Avatar for viathor from gravatar.com viathor

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache 2
  • Author: Craig Gidney
  • Requires: Python >=3.6.0

Project description

Stim

Stim is a fast simulator for quantum stabilizer circuits.

API references are available on the stim github wiki: https://github.com/quantumlib/stim/wiki

Stim can be installed into a python 3 environment using pip:

pip install stim

Once stim is installed, you can import stim and use it. There are three supported use cases:

  1. Interactive simulation with stim.TableauSimulator.
  2. High speed sampling with samplers compiled from stim.Circuit.
  3. Independent exploration using stim.Tableau and stim.PauliString.

Interactive Simulation

Use stim.TableauSimulator to simulate operations one by one while inspecting the results:

import stim

s = stim.TableauSimulator()

# Create a GHZ state.
s.h(0)
s.cnot(0, 1)
s.cnot(0, 2)

# Look at the simulator state re-inverted to be forwards:
t = s.current_inverse_tableau()
print(t**-1)
# prints:
# +-xz-xz-xz-
# | ++ ++ ++
# | ZX _Z _Z
# | _X XZ __
# | _X __ XZ

# Measure the GHZ state.
print(s.measure_many(0, 1, 2))
# prints one of:
# [True, True, True]
# or:
# [False, False, False]

High Speed Sampling

By creating a stim.Circuit and compiling it into a sampler, samples can be generated very quickly:

import stim

# Create a circuit that measures a large GHZ state.
c = stim.Circuit()
c.append("H", [0])
for k in range(1, 30):
    c.append("CNOT", [0, k])
c.append("M", range(30))

# Compile the circuit into a high performance sampler.
sampler = c.compile_sampler()

# Collect a batch of samples.
# Note: the ideal batch size, in terms of speed per sample, is roughly 1024.
# Smaller batches are slower because they are not sufficiently vectorized.
# Bigger batches are slower because they use more memory.
batch = sampler.sample(1024)
print(type(batch))  # numpy.ndarray
print(batch.dtype)  # numpy.uint8
print(batch.shape)  # (1024, 30)
print(batch)
# Prints something like:
# [[1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1]
#  [0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0]
#  [1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1]
#  ...
#  [1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1]
#  [1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1]
#  [0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0]
#  [1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1]]

This also works on circuits that include noise:

import stim
import numpy as np

c = stim.Circuit("""
    X_ERROR(0.1) 0
    Y_ERROR(0.2) 1
    Z_ERROR(0.3) 2
    DEPOLARIZE1(0.4) 3
    DEPOLARIZE2(0.5) 4 5
    M 0 1 2 3 4 5
""")
batch = c.compile_sampler().sample(2**20)
print(np.mean(batch, axis=0).round(3))
# Prints something like:
# [0.1   0.2   0.    0.267 0.267 0.266]

You can also sample annotated detection events using stim.Circuit.compile_detector_sampler.

For a list of gates that can appear in a stim.Circuit, see the latest readme on github.

Independent Exploration

Stim provides data types stim.PauliString and stim.Tableau, which support a variety of fast operations.

import stim

xx = stim.PauliString("XX")
yy = stim.PauliString("YY")
assert xx * yy == -stim.PauliString("ZZ")

s = stim.Tableau.from_named_gate("S")
print(repr(s))
# prints:
# stim.Tableau.from_conjugated_generators(
#     xs=[
#         stim.PauliString("+Y"),
#     ],
#     zs=[
#         stim.PauliString("+Z"),
#     ],
# )

s_dag = stim.Tableau.from_named_gate("S_DAG")
assert s**-1 == s_dag
assert s**1000000003 == s_dag

cnot = stim.Tableau.from_named_gate("CNOT")
cz = stim.Tableau.from_named_gate("CZ")
h = stim.Tableau.from_named_gate("H")
t = stim.Tableau(5)
t.append(cnot, [1, 4])
t.append(h, [4])
t.append(cz, [1, 4])
t.prepend(h, [4])
assert t == stim.Tableau(5)

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for mneeley from gravatar.com mneeley Avatar for strilanc from gravatar.com strilanc Avatar for viathor from gravatar.com viathor

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache 2
  • Author: Craig Gidney
  • Requires: Python >=3.6.0

Release history Release notifications | RSS feed

1.15.dev1730523741 pre-release

1.15.dev1730500841 pre-release

1.15.dev1730154364 pre-release

1.15.dev1728688449 pre-release

1.15.dev1727166840 pre-release

1.14.0

1.14.dev1727164676 pre-release

1.14.dev1727163064 pre-release

1.14.dev1727161109 pre-release

1.14.dev1726902167 pre-release

1.14.dev1726900525 pre-release

1.14.dev1726895845 pre-release

1.14.dev1726889409 pre-release

1.14.dev1726430915 pre-release

1.14.dev1726206696 pre-release

This version

1.14.dev1726187406 pre-release

1.14.dev1726091180 pre-release

1.14.dev1725679825 pre-release

1.14.dev1724712001 pre-release

1.14.dev1723057703 pre-release

1.14.dev1722854600 pre-release

1.14.dev1722650154 pre-release

1.14.dev1722409480 pre-release

1.14.dev1722326436 pre-release

1.14.dev1722293989 pre-release

1.14.dev1722042181 pre-release

1.14.dev1721777478 pre-release

1.14.dev1720938100 pre-release

1.14.dev1720861949 pre-release

1.14.dev1719978558 pre-release

1.14.dev1719957432 pre-release

1.14.dev1719955661 pre-release

1.14.dev1719295897 pre-release

1.14.dev1718081493 pre-release

1.14.dev1718079560 pre-release

1.14.dev1717459827 pre-release

1.14.dev1716327428 pre-release

1.14.dev1714789520 pre-release

1.14.dev1714773685 pre-release

1.14.dev1714772198 pre-release

1.14.dev1712965049 pre-release

1.14.dev1712946644 pre-release

1.14.dev1712884560 pre-release

1.14.dev1712801263 pre-release

1.14.dev1712661380 pre-release

1.14.dev1712659430 pre-release

1.14.dev1711709508 pre-release

1.14.dev1711670133 pre-release

1.14.dev1711582216 pre-release

1.14.dev1711525906 pre-release

1.14.dev1711415157 pre-release

1.14.dev1711001478 pre-release

1.14.dev1710997887 pre-release

1.14.dev1710971876 pre-release

1.14.dev1710899196 pre-release

1.14.dev1710897753 pre-release

1.14.dev1710743364 pre-release

1.13.0

1.13.dev1710740471 pre-release

1.13.dev1710726537 pre-release

1.13.dev1710720884 pre-release

1.13.dev1710546840 pre-release

1.13.dev1710483042 pre-release

1.13.dev1710431323 pre-release

1.13.dev1710218260 pre-release

1.13.dev1710209153 pre-release

1.13.dev1710203367 pre-release

1.13.dev1709227811 pre-release

1.13.dev1709175168 pre-release

1.13.dev1708338768 pre-release

1.13.dev1708140965 pre-release

1.13.dev1708139192 pre-release

1.13.dev1707966721 pre-release

1.13.dev1707955768 pre-release

1.13.dev1706570159 pre-release

1.13.dev1706081724 pre-release

1.13.dev1702511128 pre-release

1.13.dev1702289706 pre-release

1.13.dev1701377008 pre-release

1.13.dev1701334149 pre-release

1.13.dev1701315447 pre-release

1.13.dev1701144542 pre-release

1.13.dev1701045685 pre-release

1.13.dev1700958181 pre-release

1.13.dev1700898803 pre-release

1.13.dev1700871912 pre-release

1.13.dev1700545551 pre-release

1.12.1

1.12.0

1.11.0

1.10.0

1.9.0

1.8.0

1.7.1

1.7.0

1.6.0

1.5.0

1.4.0

1.3.0

1.2.1

1.2

1.1.0

1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stim-1.14.dev1726187406.tar.gz (809.7 kB view hashes)

Uploaded Source

Built Distributions

stim-1.14.dev1726187406-cp312-cp312-win_amd64.whl (2.5 MB view hashes)

Uploaded CPython 3.12 Windows x86-64

stim-1.14.dev1726187406-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.7 MB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64

stim-1.14.dev1726187406-cp312-cp312-macosx_11_0_arm64.whl (1.7 MB view hashes)

Uploaded CPython 3.12 macOS 11.0+ ARM64

stim-1.14.dev1726187406-cp312-cp312-macosx_10_9_x86_64.whl (1.9 MB view hashes)

Uploaded CPython 3.12 macOS 10.9+ x86-64

stim-1.14.dev1726187406-cp311-cp311-win_amd64.whl (2.5 MB view hashes)

Uploaded CPython 3.11 Windows x86-64

stim-1.14.dev1726187406-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.7 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

stim-1.14.dev1726187406-cp311-cp311-macosx_11_0_arm64.whl (1.7 MB view hashes)

Uploaded CPython 3.11 macOS 11.0+ ARM64

stim-1.14.dev1726187406-cp311-cp311-macosx_10_9_x86_64.whl (1.8 MB view hashes)

Uploaded CPython 3.11 macOS 10.9+ x86-64

stim-1.14.dev1726187406-cp310-cp310-win_amd64.whl (2.5 MB view hashes)

Uploaded CPython 3.10 Windows x86-64

stim-1.14.dev1726187406-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.7 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

stim-1.14.dev1726187406-cp310-cp310-macosx_11_0_arm64.whl (1.7 MB view hashes)

Uploaded CPython 3.10 macOS 11.0+ ARM64

stim-1.14.dev1726187406-cp310-cp310-macosx_10_9_x86_64.whl (1.8 MB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

stim-1.14.dev1726187406-cp39-cp39-win_amd64.whl (2.5 MB view hashes)

Uploaded CPython 3.9 Windows x86-64

stim-1.14.dev1726187406-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.7 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

stim-1.14.dev1726187406-cp39-cp39-macosx_11_0_arm64.whl (1.7 MB view hashes)

Uploaded CPython 3.9 macOS 11.0+ ARM64

stim-1.14.dev1726187406-cp39-cp39-macosx_10_9_x86_64.whl (1.8 MB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

stim-1.14.dev1726187406-cp38-cp38-win_amd64.whl (2.5 MB view hashes)

Uploaded CPython 3.8 Windows x86-64

stim-1.14.dev1726187406-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.7 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

stim-1.14.dev1726187406-cp38-cp38-macosx_11_0_arm64.whl (3.3 MB view hashes)

Uploaded CPython 3.8 macOS 11.0+ ARM64

stim-1.14.dev1726187406-cp38-cp38-macosx_10_9_x86_64.whl (3.5 MB view hashes)

Uploaded CPython 3.8 macOS 10.9+ x86-64

stim-1.14.dev1726187406-cp37-cp37m-win_amd64.whl (2.5 MB view hashes)

Uploaded CPython 3.7m Windows x86-64

stim-1.14.dev1726187406-cp37-cp37m-win32.whl (2.2 MB view hashes)

Uploaded CPython 3.7m Windows x86

stim-1.14.dev1726187406-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.7 MB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ x86-64

stim-1.14.dev1726187406-cp37-cp37m-manylinux_2_17_i686.manylinux2014_i686.whl (4.9 MB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ i686

stim-1.14.dev1726187406-cp37-cp37m-macosx_10_9_x86_64.whl (3.5 MB view hashes)

Uploaded CPython 3.7m macOS 10.9+ x86-64

stim-1.14.dev1726187406-cp36-cp36m-win_amd64.whl (2.5 MB view hashes)

Uploaded CPython 3.6m Windows x86-64

stim-1.14.dev1726187406-cp36-cp36m-win32.whl (2.2 MB view hashes)

Uploaded CPython 3.6m Windows x86

stim-1.14.dev1726187406-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.7 MB view hashes)

Uploaded CPython 3.6m manylinux: glibc 2.17+ x86-64

stim-1.14.dev1726187406-cp36-cp36m-manylinux_2_17_i686.manylinux2014_i686.whl (4.9 MB view hashes)

Uploaded CPython 3.6m manylinux: glibc 2.17+ i686

stim-1.14.dev1726187406-cp36-cp36m-macosx_10_9_x86_64.whl (3.5 MB view hashes)

Uploaded CPython 3.6m macOS 10.9+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page