Experimental noise model and simulation module

.github/workflows/benchmark_base.yml

@@ -9,13 +9,13 @@ on:
 jobs:
   benchmark_base_branch:
     name: Continuous Benchmarking with Bencher
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v2
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
         with:
-          python-version: '3.9' 
+          python-version: '3.12' 
       - uses: actions/cache@v4
         with:
           path: .venv

.github/workflows/benchmark_pr.yml

@@ -8,13 +8,13 @@ jobs:
     if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository
     permissions:
       pull-requests: write
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v2
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
         with:
-          python-version: '3.9' 
+          python-version: '3.12' 
       - uses: actions/cache@v4
         with:
           path: .venv

.github/workflows/publish.yml

@@ -11,8 +11,10 @@ jobs:
     name: Build and Publish
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v3
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
     - uses: snok/install-poetry@v1
       with:
         virtualenvs-in-project: true
@@ -42,8 +44,10 @@ jobs:
       id-token: write
       contents: read
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v3
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
     - uses: snok/install-poetry@v1
       with:
         virtualenvs-in-project: true
@@ -55,7 +59,7 @@ jobs:
       run: |
         poetry build --no-interaction
     - name: Upload wheels as artifacts
-      uses: actions/upload-artifact@v2 
+      uses: actions/upload-artifact@v4 
       with: 
         name: wheels
         path: dist
@@ -78,7 +82,7 @@ jobs:
       # Determine the tags to publish based on the release tag
       - name: Docker Metadata
         id: meta
-        uses: docker/metadata-action@v4
+        uses: docker/metadata-action@v5
         with:
           images: |
             ${{ vars.DOCKER_IMAGE_NAME }}
@@ -88,9 +92,9 @@ jobs:
             type=raw,value=${{ env.PYQUIL_TAG_RC }},enable=${{ env.PYQUIL_TAG_RC != '' }}
       # Checkout is needed to use the path context: .
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Build and Test
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v6
         with:
           context: .
           load: true
@@ -102,12 +106,12 @@ jobs:
           docker run --rm "${{ vars.DOCKER_IMAGE_NAME }}:test" python -c "from pyquil import get_qc"
       # Build and publish the image
       - name: Login to Docker Hub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_PASSWORD }}
       - name: Build and Push
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v6
         with:
           context: .
           push: true

.github/workflows/release.yml

@@ -20,7 +20,7 @@ jobs:
     env:
       GITHUB_TOKEN: ${{ secrets.PAT }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
         token: ${{ secrets.PAT }}

.github/workflows/test.yml

@@ -12,11 +12,11 @@ jobs:
     name: Build and test documentation
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
         with:
-          python-version: '3.9'
+          python-version: '3.11'
       - uses: actions/cache@v4
         with:
           path: .venv
@@ -32,11 +32,11 @@ jobs:
     name: Check formatting
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
         with:
-          python-version: '3.9'
+          python-version: '3.11'
       - uses: actions/cache@v4
         with:
           path: .venv
@@ -51,11 +51,11 @@ jobs:
     name: Check style
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
         with:
-          python-version: '3.9'
+          python-version: '3.11'
       - uses: actions/cache@v4
         with:
           path: .venv
@@ -70,11 +70,11 @@ jobs:
     name: Check types
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
         with:
-          python-version: '3.9'
+          python-version: '3.11'
       - uses: actions/cache@v4
         with:
           path: .venv
@@ -90,7 +90,7 @@ jobs:
     name: Check dependencies for vulnerabilities
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Go
       uses: actions/setup-go@v5
     - name: Install OSV scanner
@@ -105,11 +105,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.11", "3.12"]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - uses: actions/cache@v4
@@ -133,11 +133,11 @@ jobs:
       pull-requests: write # allows coverage bot to comment
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.11", "3.12"]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - uses: actions/cache@v4
@@ -165,11 +165,11 @@ jobs:
     name: Check docker image
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.10
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: '3.11'
       - uses: actions/cache@v4
         with:
           path: .venv
@@ -180,7 +180,7 @@ jobs:
           . scripts/ci_install_deps
           poetry build -o wheels
       - name: Build and Test
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v6
         with:
           file: Dockerfile.test
           context: .
@@ -195,11 +195,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.11", "3.12"]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - uses: actions/cache@v4

Dockerfile

@@ -1,11 +1,11 @@
 # use multi-stage builds to independently pull dependency versions
 ARG quilc_version=1.20.0
 ARG qvm_version=1.17.1
-ARG python_version=3.10
+ARG python_version=3.11
 
 # use multi-stage builds to independently pull dependency versions
 FROM rigetti/quilc:$quilc_version as quilc
 FROM rigetti/qvm:$qvm_version as qvm
 FROM python:$python_version-trixie
 
 # passed in by `.github/workflows/publish.yml`, should match the version just published to pypi

Dockerfile.test

@@ -1,11 +1,11 @@
 # use multi-stage builds to independently pull dependency versions
 ARG quilc_version=1.20.0
 ARG qvm_version=1.17.1
-ARG python_version=3.10
+ARG python_version=3.11
 
 # use multi-stage builds to independently pull dependency versions
 FROM rigetti/quilc:$quilc_version as quilc
 FROM rigetti/qvm:$qvm_version as qvm
 FROM python:$python_version-trixie
 
 # copy over the pre-built quilc binary from the first build stage

Makefile

@@ -3,6 +3,14 @@ DEFAULT_QUILC_URL=tcp://localhost:5555
 DEFAULT_QVM_URL=http://localhost:5000
 DOCKER_TAG=rigetti/forest:$(COMMIT_HASH)
 
+.DEFAULT := help
+
+.PHONY: help
+help:
+	@awk 'BEGIN { FS=":.*##"; print "Supported Makefile commands:\n" } \
+          /^[a-zA-Z0-9_-]+:.*##/ { cmd=$$1; desc=$$2; printf "    \033[36m%-20s\033[0m %s\n", cmd, desc } \
+          END { print "" }' $(MAKEFILE_LIST)
+
 .PHONY: all
 all: dist
 

docs/source/compiler.rst

@@ -364,8 +364,7 @@ For example, consider running a ``CZ`` on non-neighboring qubits on a linear dev
 
 .. testoutput:: swaps
 
-   CZ 2 1
-   HALT
+   CZ 2 1...
 
 We see that the resulting program has only a single ``CZ`` even though the original program would
 usually require the insertion of a ``SWAP`` gate. The compiler instead opted to just relabel (or

docs/source/getting_started.rst

@@ -40,7 +40,7 @@ If you would like to stay up to date with the latest changes and bug fixes, you
 
 .. note::
 
-    pyQuil requires Python 3.9 or later.
+    pyQuil requires Python 3.11 or later and supports Python versions earlier than 3.13.
 
 .. testcode:: verify-min-version
     :hide:
@@ -58,7 +58,7 @@ If you would like to stay up to date with the latest changes and bug fixes, you
 .. testoutput:: verify-min-version
     :hide:
 
-    ^3.9...
+    >=3.11, <3.13
 
 .. note::
 
@@ -165,7 +165,7 @@ the terminal windows where your servers are running, you should see output print
     pyQuil also provides the :py:func:`~pyquil.api.local_forest_runtime()` context manager to ensure both ``quilc`` and ``qvm`` servers are running
     by starting them as subprocesses if they aren't already.
 
-    .. testcode:: first-program
+    .. code:: python
 
         from pyquil import get_qc, Program
         from pyquil.gates import CNOT, Z, MEASURE

docs/source/index.rst

@@ -32,6 +32,8 @@ If you’re new to pyQuil, head to the `getting started <getting_started>`_ guid
    wavefunction_simulator
    compiler
    noise
+   simulation_architecture
+   dynamic_simulator_benchmark
    advanced_usage
    troubleshooting
    introducing_v4