pypulseqpp
Pulseq sequence design and analysis with a C++ core and a PyPulseq-compatible Python interface.
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.
1 maintainer
Release files for pypulseqpp 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pypulseqpp-0.0.1.tar.gz | 1.2 MB | Details |
Built distributions (wheels)
Total release size: 16.4 MB
Release files / pypulseqpp-0.0.1.tar.gz
| Download URL | pypulseqpp-0.0.1.tar.gz |
|---|---|
| Size | 1.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ad323b658369993a8a367a674e82acc0936efb9e445a10b2e09587dc45fd1559
|
|
BLAKE2b-256 checksum How to use checksums |
7d9f8064a98beb01ffc069afa8b9398227d285cd65178a0b2628189685920ef0
|
| 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 14, 2026.
Transparency logRelease files / pypulseqpp-0.0.1-cp313-cp313-win_amd64.whl
| Download URL | pypulseqpp-0.0.1-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 1.0 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
db0baf33611f6fec2ce30ef6c06fde344271c7b755f5faab5f06db571178f87a
|
|
BLAKE2b-256 checksum How to use checksums |
b2b21ebb26ef527bb419fce5216bd4a73a22a1f7b0f3bb604770ff9f920c7fe5
|
| 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 14, 2026.
Transparency logRelease files / pypulseqpp-0.0.1-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
| Download URL | pypulseqpp-0.0.1-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl |
|---|---|
| Size | 950.1 kB |
| Tags | CPython 3.13 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
a245b3f004f0d1cea2615fc0920112befecc92fa5ceeccdaf66c41ec2fb52442
|
|
BLAKE2b-256 checksum How to use checksums |
dab25d56b7064f5d22df65102ce912d645c5de3f0608b616d34a8e30de4888fe
|
| 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 14, 2026.
Transparency logRelease files / pypulseqpp-0.0.1-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | pypulseqpp-0.0.1-cp313-cp313-macosx_11_0_arm64.whl |
|---|---|
| Size | 863.0 kB |
| Tags | CPython 3.13 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
2612db3295b24ae06861e6dfa0872358d839c3d9492ecdfea46e260974bb7691
|
|
BLAKE2b-256 checksum How to use checksums |
b4e9e0804c30d1d0ce975d46b5137d077195d114151d1e295a29cbaf6026f8c6
|
| 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 14, 2026.
Transparency logRelease files / pypulseqpp-0.0.1-cp313-cp313-macosx_10_13_x86_64.whl
| Download URL | pypulseqpp-0.0.1-cp313-cp313-macosx_10_13_x86_64.whl |
|---|---|
| Size | 968.4 kB |
| Tags | CPython 3.13 macOS 10.13+ x86-64 |
|
SHA-256 checksum How to use checksums |
a5c74c3ed19755d986d07b15ad6d1f3b7d95be353bd2fcb7f53d880aeca3b4d2
|
|
BLAKE2b-256 checksum How to use checksums |
05ae1ab45f208c4b874067351b5888cbd95ee153df34d3c9960882cac61885af
|
| 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 14, 2026.
Transparency logRelease files / pypulseqpp-0.0.1-cp312-cp312-win_amd64.whl
| Download URL | pypulseqpp-0.0.1-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 1.0 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
daf6cf1263865e8c253063ce8602b0e2bace61744f9ff6c694a8068d0dd4ab91
|
|
BLAKE2b-256 checksum How to use checksums |
8fa4c46870e69ac352a9ce83da16e9a2ebcb15d12ee10cab9aa99a598073a3a2
|
| 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 14, 2026.
Transparency logRelease files / pypulseqpp-0.0.1-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
| Download URL | pypulseqpp-0.0.1-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl |
|---|---|
| Size | 950.0 kB |
| Tags | CPython 3.12 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
06112cc89c4048d95a1af357fa003e5ced694d7c9d51c2c3f4140e9c1d8b8476
|
|
BLAKE2b-256 checksum How to use checksums |
3494514a435ec4337cb6960c3688622a1910d0dfcc0e438253bd9ab6b6875268
|
| 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 14, 2026.
Transparency logRelease files / pypulseqpp-0.0.1-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | pypulseqpp-0.0.1-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 862.9 kB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
7a36b00f94d8bfb00d5326a5ebc5dee2830b52d06db34ba4e8eed89a37aed1e0
|
|
BLAKE2b-256 checksum How to use checksums |
d9b8304094690cb80e555bc40db0c0b5bc9dd1b80204469947f8e05cc23a2469
|
| 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 14, 2026.
Transparency logRelease files / pypulseqpp-0.0.1-cp312-cp312-macosx_10_13_x86_64.whl
| Download URL | pypulseqpp-0.0.1-cp312-cp312-macosx_10_13_x86_64.whl |
|---|---|
| Size | 968.4 kB |
| Tags | CPython 3.12 macOS 10.13+ x86-64 |
|
SHA-256 checksum How to use checksums |
f3632baf53bf6e23c05317934c59b49a1257784469b1e5e36a6f4b5eb29c6894
|
|
BLAKE2b-256 checksum How to use checksums |
5ac0dba7d37e987e6624d5bda762ad2a738f9c3abaf923b27ac641d808efa224
|
| 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 14, 2026.
Transparency logRelease files / pypulseqpp-0.0.1-cp311-cp311-win_amd64.whl
| Download URL | pypulseqpp-0.0.1-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 1.0 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
4861ba64a87086760aa819202a32b715fd228767d65aa1f3d4ded237b18d342e
|
|
BLAKE2b-256 checksum How to use checksums |
658320ca11210c53833578367ef214f358b7c8c42419a02d0d9369e42280632d
|
| 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 14, 2026.
Transparency logRelease files / pypulseqpp-0.0.1-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
| Download URL | pypulseqpp-0.0.1-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl |
|---|---|
| Size | 945.0 kB |
| Tags | CPython 3.11 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
63dae787b16658459f056735d96897ae20fec0c3361cd817a9b584fb7d762f0c
|
|
BLAKE2b-256 checksum How to use checksums |
1ba90c94e8c786800598aeca2c3bb3438ed89fd9caf01b5f64de7924822b4739
|
| 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 14, 2026.
Transparency logRelease files / pypulseqpp-0.0.1-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | pypulseqpp-0.0.1-cp311-cp311-macosx_11_0_arm64.whl |
|---|---|
| Size | 859.6 kB |
| Tags | CPython 3.11 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
bb3a37abddf9453c2504c4de333b9181437fe2a858f5286a20f5747e7608a660
|
|
BLAKE2b-256 checksum How to use checksums |
da8608043e479f2b47feb335bfde744f5d66433fa246d1b433eadc8e48671ec9
|
| 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 14, 2026.
Transparency logRelease files / pypulseqpp-0.0.1-cp311-cp311-macosx_10_9_x86_64.whl
| Download URL | pypulseqpp-0.0.1-cp311-cp311-macosx_10_9_x86_64.whl |
|---|---|
| Size | 956.4 kB |
| Tags | CPython 3.11 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
c43baafd46f0e1578017ead84ba3e8c79779b2ab053a526402affc92347ee19f
|
|
BLAKE2b-256 checksum How to use checksums |
e335b4faa545c68f7bc673bc21c2399ad529563410818970bb5664ba4bb1ae32
|
| 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 14, 2026.
Transparency logRelease files / pypulseqpp-0.0.1-cp310-cp310-win_amd64.whl
| Download URL | pypulseqpp-0.0.1-cp310-cp310-win_amd64.whl |
|---|---|
| Size | 1.0 MB |
| Tags | CPython 3.10 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
6cfcc52b7b9661707a2598bd90493b92a502f5a21afce70b3fcbb156904b0bc7
|
|
BLAKE2b-256 checksum How to use checksums |
c413bc8c170cbebe53d719fbb7d4fd239b46bfe8029efe390f45790fa2c710c4
|
| 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 14, 2026.
Transparency logRelease files / pypulseqpp-0.0.1-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
| Download URL | pypulseqpp-0.0.1-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl |
|---|---|
| Size | 944.0 kB |
| Tags | CPython 3.10 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
45980ebe8c45e7952117f2f89e71aa85237cee1bd49b2d46961d510ac1a0b620
|
|
BLAKE2b-256 checksum How to use checksums |
9bbb7df1654b646acb0664d710b1366587ae0aa75f1f622b550648d31d23a169
|
| 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 14, 2026.
Transparency logRelease files / pypulseqpp-0.0.1-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | pypulseqpp-0.0.1-cp310-cp310-macosx_11_0_arm64.whl |
|---|---|
| Size | 858.5 kB |
| Tags | CPython 3.10 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
75c5767f6469854c4d231eeb608e054cfe485a1070ac9f473d6a872d62cc7a27
|
|
BLAKE2b-256 checksum How to use checksums |
c568ebae8e8420f187d77dbe20bf02f7a0869006aefb4ef5c27716cee7dc66ff
|
| 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 14, 2026.
Transparency logRelease files / pypulseqpp-0.0.1-cp310-cp310-macosx_10_9_x86_64.whl
| Download URL | pypulseqpp-0.0.1-cp310-cp310-macosx_10_9_x86_64.whl |
|---|---|
| Size | 955.2 kB |
| Tags | CPython 3.10 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
b43c65faa25bf0c2f80d0f76a1f9afcb71187b7b2ce22597dc7df180398a8945
|
|
BLAKE2b-256 checksum How to use checksums |
ab0d009c53de4c6aa0bb053c332528fafa57aba27ec2833d4d7d1821a4f36b4b
|
| 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 14, 2026.
Transparency log
