User guide#

Installation, a first sequence and getting help. If you are new to Pulseq, the Course is the place to start; if you already have PyPulseq scripts, PyPulseq compatibility shows what changes.

Supported platforms#

You need Python 3.10 to 3.14. CI tests Python 3.14 on Linux, macOS and Windows, and Python 3.10 on Linux.

Wheels are published for:

Platform

Architectures

Linux

x86-64, glibc (manylinux)

macOS

Apple silicon and x86-64

Windows

AMD64

Each wheel carries the compiled C++ core. On any other platform pip builds from source, which needs a C++17 compiler, CMake and the Python development headers; those builds are not release-tested.

Installation#

pip install pypulseqpp

Three extras add optional features:

Extra

Command

Adds

plot

pip install 'pypulseqpp[plot]'

The interactive SeqEyes viewer, distributed separately under the GPL.

mkl

pip install 'pypulseqpp[mkl]'

Intel MKL as the FFT backend of mech_resonance_spectrum, on x86-64.

design

pip install 'pypulseqpp[design]'

blochsim, which designs the refocusing schedules of the fast spin echo: Busse and PD trains, their effective TE, and the optimized trains.

To work on pypulseqpp itself, follow Installation.

Shipped sequences#

Each shipped sequence is a module of pypulseqpp.sequences. You call the module with the prescription as keyword arguments and get the sequence back; the parameters each one takes, with their units, are on its page in the catalogue.

>>> from pypulseqpp import sequences
>>> seq = sequences.gre2D_sequence(n_x=64, n_y=64, n_slices=1)
>>> signature = seq.write("gre_2d.seq")

Every module is also a command-line program, with one option per parameter:

python -m pypulseqpp.sequences.sequence.gre2D_sequence --help

Getting help#

Report a reproducible defect, a documentation error or a narrowly scoped feature request on the issue tracker. Include the pypulseqpp, PyPulseq and Python versions, your operating system and the smallest script that reproduces the problem.

Ask usage questions and propose broad design ideas in GitHub Discussions, after searching the existing topics.

Report a vulnerability through GitHub private vulnerability reporting, never in a public issue. The policy is in SECURITY.md.