From 86bd8657a3fd5e7d27086249624b1612917b948e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roberto=20Di=20Remigio=20Eik=C3=A5s?= Date: Fri, 31 Jul 2026 14:46:14 +0200 Subject: [PATCH 1/4] fix: links to benchmarks in README.md --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4393c79..23b5864 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # monoprop > because your operators deserve to propagate at escape velocity -[![Documentation](https://github.com/Algorithmiq/monoprop/actions/workflows/docpages.yml/badge.svg)](https://docs.algorithmiq.fi/monoprop) +[![Documentation](https://github.com/Algorithmiq/monoprop/actions/workflows/docpages.yml/badge.svg)](https://docs.monoprop.algorithmiq.tech/) [![Test monoprop](https://github.com/Algorithmiq/monoprop/actions/workflows/test.yml/badge.svg)](https://github.com/Algorithmiq/monoprop/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/Algorithmiq/monoprop/graph/badge.svg?token=1GgmPnNUxk)](https://codecov.io/gh/Algorithmiq/monoprop) @@ -18,9 +18,15 @@ the operator across cores and across nodes with MPI. ## Benchmarks -Check out the comparison of `monoprop` against other open-source Pauli propagation engines in [benches/third_party]! -![Runtime Benchmark](benches/third_party/pauli_prop/runtime.png) -![Memory Benchmark](benches/third_party/pauli_prop/memory.png) +Check out the comparison of `monoprop` against other open-source Pauli propagation engines: + +![PP Benchmark](docs/public/benchmarks/pauli_results.png) + +and against [`MajoranaPropagation.jl`](https://github.com/SparqleSim/MajoranaPropagation.jl): + +![MP Benchmark](docs/public/benchmarks/majorana_results.png) + +Head to our [benchmarks page](https://docs.monoprop.algorithmiq.tech/benchmarks) for more details. 📖 **Full documentation:** @@ -43,7 +49,9 @@ from monoprop import MajoranaPropagator, ExpGate, Circuit, MajoranaOperator # Observable m_0 m_1 m_2 m_4, evolved under one Majorana rotation exp(-i θ/2 · M_γ), # generated by M_γ = i*m_4 m_5. observable = MajoranaOperator({(0, 1, 2, 4): 1.0}, num_modes=8) -gate = ExpGate(MajoranaOperator({(4, 5): 1j}, num_modes=8)) # Hermitian generator: weight-2 => imaginary coeff +gate = ExpGate( + MajoranaOperator({(4, 5): 1j}, num_modes=8) +) # Hermitian generator: weight-2 => imaginary coeff circuit = Circuit(gates=[gate], parameters=[0.5]) # one angle value per gate mp = MajoranaPropagator.from_circuit(circuit, observable, cutoff=16) @@ -56,7 +64,9 @@ Qubit (Pauli) operators are simulated with `PauliPropagator`. Here we back-propa ```python from monoprop import PauliPropagator, ExpGate, Circuit, PauliOperator, Pauli -observable = PauliOperator({"ZZ": 1.0}, num_qubits=2) # num_qubits lives on the observable +observable = PauliOperator( + {"ZZ": 1.0}, num_qubits=2 +) # num_qubits lives on the observable gate = ExpGate(PauliOperator({Pauli("X", 0): 1.0}, num_qubits=2)) # exp(-i θ/2 · X_0) circuit = Circuit(gates=[gate], parameters=[0.5]) # one angle value per gate From a3e31d63e878b8b8550da538476116bf5a243283 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roberto=20Di=20Remigio=20Eik=C3=A5s?= Date: Fri, 31 Jul 2026 15:24:02 +0200 Subject: [PATCH 2/4] docs: use plots with scaling wrt lattice size --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 23b5864..7435445 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,8 @@ the operator across cores and across nodes with MPI. Check out the comparison of `monoprop` against other open-source Pauli propagation engines: -![PP Benchmark](docs/public/benchmarks/pauli_results.png) +![PP Runtime Benchmark](docs/public/benchmarks/pauli_scaling_runtime.png) +![PP Memory Benchmark](docs/public/benchmarks/pauli_scaling_memory.png) and against [`MajoranaPropagation.jl`](https://github.com/SparqleSim/MajoranaPropagation.jl): From da591bf4eb85d92596cd124fdf947388dd536931 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roberto=20Di=20Remigio=20Eik=C3=A5s?= Date: Fri, 31 Jul 2026 15:34:09 +0200 Subject: [PATCH 3/4] style: resize images in readme --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7435445..7059576 100644 --- a/README.md +++ b/README.md @@ -20,12 +20,16 @@ the operator across cores and across nodes with MPI. Check out the comparison of `monoprop` against other open-source Pauli propagation engines: -![PP Runtime Benchmark](docs/public/benchmarks/pauli_scaling_runtime.png) -![PP Memory Benchmark](docs/public/benchmarks/pauli_scaling_memory.png) +

+ PP Runtime Benchmark + PP Memory Benchmark +

and against [`MajoranaPropagation.jl`](https://github.com/SparqleSim/MajoranaPropagation.jl): -![MP Benchmark](docs/public/benchmarks/majorana_results.png) +

+ MP Benchmark +

Date: Fri, 31 Jul 2026 15:36:43 +0200 Subject: [PATCH 4/4] style: more tweaking of image sizes --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7059576..585a8a9 100644 --- a/README.md +++ b/README.md @@ -21,14 +21,14 @@ the operator across cores and across nodes with MPI. Check out the comparison of `monoprop` against other open-source Pauli propagation engines:

- PP Runtime Benchmark - PP Memory Benchmark + PP Runtime Benchmark + PP Memory Benchmark

and against [`MajoranaPropagation.jl`](https://github.com/SparqleSim/MajoranaPropagation.jl):

- MP Benchmark + MP Benchmark