Skip to main content

pypulseqpp

Pulseq sequence design and analysis with a C++ core and a PyPulseq-compatible Python interface.

Tests codecov PyPI License: MIT

pypulseqpp combines compiled event storage, block registration and analysis with PyPulseq event factories. It also provides RF and gradient design, sampling patterns, and composable excitation, preparation and readout modules.

Scope

  • Pulseq text and binary reading/writing, signatures and event deduplication.
  • Waveform expansion, k-space trajectories, sequence reports and structural repetition detection.
  • Timing, gradient amplitude, slew and boundary-continuity checks, a mechanical-resonance check against forbidden gradient bands, and a PNS check under the SAFE or the rheobase-chronaxie model, and VOP-based SAR.
  • Logical-frame FOV scaling, rotation and translation.
  • Pulse, trajectory and sampling design, with reusable sequence modules.

This is an alpha package, not a complete replacement for every PyPulseq feature. Passing the checks does not establish scanner or patient safety.

Scanner execution, protocol orchestration and reconstruction integration belong to Pulserver.

Install

Requires Python 3.10 or later. Runtime dependencies are NumPy, SciPy and PyPulseq; the native core is included in platform wheels.

pip install pypulseqpp

The optional viewer is a separate GPL-licensed package:

pip install 'pypulseqpp[plot]'

Basic use

import pypulseqpp as pp

system = pp.Opts(max_grad=40, grad_unit="mT/m", max_slew=150, slew_unit="T/m/s")
seq = pp.Sequence(system)
gx = pp.make_trapezoid("x", area=100, system=system)
seq.add_block(gx)
ok, errors = seq.check_timing()
seq.write("example.seq")

Sequence-module classes are available from pypulseqpp.sequences. The API reference groups sequence operations, event design, sampling, modules and checks.

Development and documentation

See the contribution guide for installation and checks. Build the local Markdown/Sphinx documentation with:

pip install -e '.[doc]'
bash scripts/build_docs.sh

The script compiles the checkout into docs/build/site and generates the pages from that build.

Open docs/build/html/index.html. The API reference is populated; the user guide, developer guide and examples sections are scaffolds.

Release files for pypulseqpp 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pypulseqpp 0.0.2
File Size Uploaded
pypulseqpp-0.0.2.tar.gz 1.2 MB Details

Built distributions (wheels)

Table of built distributions (wheels) for pypulseqpp 0.0.2
File
pypulseqpp-0.0.2-cp313-cp313-win_amd64.whl CPython 3.13 CPython 3.13 Windows x86-64 Details
pypulseqpp-0.0.2-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl CPython 3.13 CPython 3.13 Linux glibc 2.27+ x86-64, Linux glibc 2.28+ x86-64 Details
pypulseqpp-0.0.2-cp313-cp313-macosx_11_0_arm64.whl CPython 3.13 CPython 3.13 macOS 11.0+ ARM64 Details
pypulseqpp-0.0.2-cp313-cp313-macosx_10_13_x86_64.whl CPython 3.13 CPython 3.13 macOS 10.13+ x86-64 Details
pypulseqpp-0.0.2-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details
pypulseqpp-0.0.2-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl CPython 3.12 CPython 3.12 Linux glibc 2.27+ x86-64, Linux glibc 2.28+ x86-64 Details
pypulseqpp-0.0.2-cp312-cp312-macosx_11_0_arm64.whl CPython 3.12 CPython 3.12 macOS 11.0+ ARM64 Details
pypulseqpp-0.0.2-cp312-cp312-macosx_10_13_x86_64.whl CPython 3.12 CPython 3.12 macOS 10.13+ x86-64 Details
pypulseqpp-0.0.2-cp311-cp311-win_amd64.whl CPython 3.11 CPython 3.11 Windows x86-64 Details
pypulseqpp-0.0.2-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl CPython 3.11 CPython 3.11 Linux glibc 2.27+ x86-64, Linux glibc 2.28+ x86-64 Details
pypulseqpp-0.0.2-cp311-cp311-macosx_11_0_arm64.whl CPython 3.11 CPython 3.11 macOS 11.0+ ARM64 Details
pypulseqpp-0.0.2-cp311-cp311-macosx_10_9_x86_64.whl CPython 3.11 CPython 3.11 macOS 10.9+ x86-64 Details
pypulseqpp-0.0.2-cp310-cp310-win_amd64.whl CPython 3.10 CPython 3.10 Windows x86-64 Details
pypulseqpp-0.0.2-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl CPython 3.10 CPython 3.10 Linux glibc 2.27+ x86-64, Linux glibc 2.28+ x86-64 Details
pypulseqpp-0.0.2-cp310-cp310-macosx_11_0_arm64.whl CPython 3.10 CPython 3.10 macOS 11.0+ ARM64 Details
pypulseqpp-0.0.2-cp310-cp310-macosx_10_9_x86_64.whl CPython 3.10 CPython 3.10 macOS 10.9+ x86-64 Details

Total release size: 17.8 MB

Release files / pypulseqpp-0.0.2.tar.gz

Download URL pypulseqpp-0.0.2.tar.gz
Size 1.2 MB
Tags Source
SHA-256 checksum
How to use checksums
4fa9f7dcbbd82c19b38619bdadaae6015765b294cdd2de15258084e5e82b81d6
BLAKE2b-256 checksum
How to use checksums
beb2ec3dc92edb36a5939e2663eeeebec5c02c21227e43895c31e6af214e8c92
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / pypulseqpp-0.0.2-cp313-cp313-win_amd64.whl

Download URL pypulseqpp-0.0.2-cp313-cp313-win_amd64.whl
Size 1.1 MB
Tags CPython 3.13 Windows x86-64
SHA-256 checksum
How to use checksums
9027efcfcc3debc96bc06ea1ac15846bf39cd6007b5b5f3ddabf3a1b4e676a74
BLAKE2b-256 checksum
How to use checksums
1703df33a17973310348dd5bd3d446f99ab280065eb7aba0ffe64a654f065b61
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / pypulseqpp-0.0.2-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL pypulseqpp-0.0.2-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Size 1.0 MB
Tags CPython 3.13 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
60621f7ffdd8c86e6dc37147e1dec729f4a5f795526cbbce734b0d6f7a9b64cf
BLAKE2b-256 checksum
How to use checksums
19dd56e4444fca5664493661aeab316bd1228083afe5584458750a193c869ff9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / pypulseqpp-0.0.2-cp313-cp313-macosx_11_0_arm64.whl

Download URL pypulseqpp-0.0.2-cp313-cp313-macosx_11_0_arm64.whl
Size 947.2 kB
Tags CPython 3.13 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
2a99e7572f204ed810f158ca13b5bc124cc84509df6278263d97248360a9330e
BLAKE2b-256 checksum
How to use checksums
5b2e233f52185e847fb5689335b3f11bdb6cc55bde29cdc98c2691550eda663c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / pypulseqpp-0.0.2-cp313-cp313-macosx_10_13_x86_64.whl

Download URL pypulseqpp-0.0.2-cp313-cp313-macosx_10_13_x86_64.whl
Size 1.1 MB
Tags CPython 3.13 macOS 10.13+ x86-64
SHA-256 checksum
How to use checksums
b771ac7665481bbcddf993d2e7b0f6980dcc3a074dae09c1cdedb6c021776efa
BLAKE2b-256 checksum
How to use checksums
995e9a481d712b990ac2a5cc4f299552a06a59881f2255a81d5aab669e78f299
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / pypulseqpp-0.0.2-cp312-cp312-win_amd64.whl

Download URL pypulseqpp-0.0.2-cp312-cp312-win_amd64.whl
Size 1.1 MB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
1d09eb660641491d37b8642bf54b6898aad08927ec4fc60603007990885d9c54
BLAKE2b-256 checksum
How to use checksums
b6e16e46378d76c5f5687a293ac16d914eac3aa904252fa399f9fd0b77ae84ab
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / pypulseqpp-0.0.2-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL pypulseqpp-0.0.2-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Size 1.0 MB
Tags CPython 3.12 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
9a497da0121aacf1bd2f1fe0b54034e92e5b6e081621e69909f4f6613e11411f
BLAKE2b-256 checksum
How to use checksums
69bfda6b03e9a910aa4ea38251b6348756dbaf2ca5815a2106581750762ae213
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / pypulseqpp-0.0.2-cp312-cp312-macosx_11_0_arm64.whl

Download URL pypulseqpp-0.0.2-cp312-cp312-macosx_11_0_arm64.whl
Size 947.1 kB
Tags CPython 3.12 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
a066ff546830cf3caa17ca2dfdf45c220436357f206bef8aff4b171d6384b057
BLAKE2b-256 checksum
How to use checksums
fb02b02c3634b448a2f6436ccfd575d2a1914cc8a2d761f003ae7969bea9263e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / pypulseqpp-0.0.2-cp312-cp312-macosx_10_13_x86_64.whl

Download URL pypulseqpp-0.0.2-cp312-cp312-macosx_10_13_x86_64.whl
Size 1.1 MB
Tags CPython 3.12 macOS 10.13+ x86-64
SHA-256 checksum
How to use checksums
1ee15e15f5b7c395904e00d5f634caed8750ff3665adc831a7ff14cb270c0a3c
BLAKE2b-256 checksum
How to use checksums
b940eac6dd8b1b2a8f079bf892e07a4ce44536f43a2a6ed4607d30625383b703
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / pypulseqpp-0.0.2-cp311-cp311-win_amd64.whl

Download URL pypulseqpp-0.0.2-cp311-cp311-win_amd64.whl
Size 1.1 MB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
7dac071a274bcc247dd3caf653ec93a3e58b53a9ac6b731a48d5e318d423e7c6
BLAKE2b-256 checksum
How to use checksums
5c6cf4317a6591f78ecc67c384955e7ecc0553d111f246e9042d1e1066a51209
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / pypulseqpp-0.0.2-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL pypulseqpp-0.0.2-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Size 1.0 MB
Tags CPython 3.11 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
e994f3163f25a168de13f92572518a4b63f0cd197c5ddbc54e9cfddf4ede62f1
BLAKE2b-256 checksum
How to use checksums
82b63536250204668be589a684400b89351e895670d79ed83d01d235c0862aed
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / pypulseqpp-0.0.2-cp311-cp311-macosx_11_0_arm64.whl

Download URL pypulseqpp-0.0.2-cp311-cp311-macosx_11_0_arm64.whl
Size 943.7 kB
Tags CPython 3.11 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
7497ca827939ec128a54d9b6590f57fdda666e7eaf37457e2a44b90d0aaa6b41
BLAKE2b-256 checksum
How to use checksums
f8b24276e30eab852859f66d66ad810c8e0171d81850a4c555aaa354b94ff79c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / pypulseqpp-0.0.2-cp311-cp311-macosx_10_9_x86_64.whl

Download URL pypulseqpp-0.0.2-cp311-cp311-macosx_10_9_x86_64.whl
Size 1.0 MB
Tags CPython 3.11 macOS 10.9+ x86-64
SHA-256 checksum
How to use checksums
02c23490545c0c2f0d85ab8f8cd700c2b5fda310b66c205e23cf15e446b3d07e
BLAKE2b-256 checksum
How to use checksums
02b7987a532899933f1ce0b3ad40f3b66cff8d3120ced92f634d674d3bef4982
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / pypulseqpp-0.0.2-cp310-cp310-win_amd64.whl

Download URL pypulseqpp-0.0.2-cp310-cp310-win_amd64.whl
Size 1.1 MB
Tags CPython 3.10 Windows x86-64
SHA-256 checksum
How to use checksums
37d810e5beca1ca275a423bb34d8d658541454cc9d9f1a753dd121c0ba167b91
BLAKE2b-256 checksum
How to use checksums
0ffc29cc35b702f501fb844e665e158a75b3d2da15f0a1cfb82f94867f3d9a5a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / pypulseqpp-0.0.2-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL pypulseqpp-0.0.2-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Size 1.0 MB
Tags CPython 3.10 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
550f3d9e1327c78602e27ccdb7bfcc0317f97df511bc99b2c4eb5278e91a28e6
BLAKE2b-256 checksum
How to use checksums
2158b91c0ab32b87a5d3162bce3cae9e172c114c0f940859af90954eec223360
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / pypulseqpp-0.0.2-cp310-cp310-macosx_11_0_arm64.whl

Download URL pypulseqpp-0.0.2-cp310-cp310-macosx_11_0_arm64.whl
Size 942.7 kB
Tags CPython 3.10 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
37582447d82814cd3ee02340dbd3ab17c222722fb94c1f1de74f9fcc7d1d224b
BLAKE2b-256 checksum
How to use checksums
1c4d99d22e581a57b86cef8f26348bbb045fc2179a69c801686233704151b398
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release files / pypulseqpp-0.0.2-cp310-cp310-macosx_10_9_x86_64.whl

Download URL pypulseqpp-0.0.2-cp310-cp310-macosx_10_9_x86_64.whl
Size 1.0 MB
Tags CPython 3.10 macOS 10.9+ x86-64
SHA-256 checksum
How to use checksums
c2ba68ba1476a8dfcaff55a4b4cdda458ce3c992685a6f526bf440c186ac6698
BLAKE2b-256 checksum
How to use checksums
18d596989bb90cb8cfa9b2069ecb16b276080a26d168182d1be15bd4fab719a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.

Transparency log

Release history Release notifications | RSS feed

0.0.9

17 release files

0.0.8

17 release files

0.0.7

17 release files

0.0.6

17 release files

0.0.5

17 release files

0.0.4

17 release files

0.0.3

17 release files

This release

0.0.2 This release

17 release files

0.0.1

17 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page