Skip to main content

Interactive Pulseq MRI sequence viewer for Jupyter — lightweight, beautiful, replaces seq.plot() in pypulseq.

Project description

SeqEyes — Interactive Pulseq MRI Sequence Viewer for Python

SeqEyes is a lightweight Python package that provides interactive visualization of Pulseq text (.seq) and binary (.bseq) MRI sequences in Jupyter notebooks. It works as a drop‑in replacement for pypulseq.Sequence.plot(), rendering an interactive viewer directly in Jupyter notebook cell output — just like Plotly.

Features

  • 🎛️ Interactive waveform viewer — zoom, pan, per‑channel amplitude zoom
  • 📍 Tooltip with block details (RF amplitude, gradient strength, ADC params)
  • 🗺️ 3D k‑space trajectory viewer — rotate, zoom, depth‑sorted rendering
  • 🎨 8 colour themes — system, light, dark, dracula, nord, and more
  • 📏 Unit conversion — time (s / ms / µs), gradient (Hz/m / mT/m / G/cm)
  • 📐 Minimap with TR/TE overlay and viewport indicator
  • 💾 Export to standalone HTML — shareable, no Python needed
  • 🔌 Drop‑in pypulseq integrationseq.plot() just works

Installation

pip install seqeyes-python

For pypulseq integration:

pip install seqeyes-python[pypulseq]

Quick Start

import seqeyes

# Enable SeqEyes (once per session) — seq.plot() is now interactive
seqeyes.set(theme="dark", time_disp="ms")

# Build your sequence with pypulseq as usual
seq.plot()                          # interactive viewer in Jupyter
seq.plot(show_blocks=True)          # per‑call overrides
seq.plot(time_range=(0, 0.05))      # zoom to first 50 ms

# Restore matplotlib at any time
seqeyes.reset()

In a plain .py script (no Jupyter), seq.plot() opens the viewer in a desktop pop‑up window (requires pywebview) or falls back to your default browser.

Using without pypulseq

from seqeyes import SeqEyesViewer

with open('my_sequence.seq') as f:
    viewer = SeqEyesViewer(f.read(), theme="dark")

viewer  # renders inline in Jupyter

Open either supported file format directly:

from seqeyes import SeqEyesViewer

SeqEyesViewer.from_file("my_sequence.seq", theme="dark")
SeqEyesViewer.from_file("my_sequence.bseq", theme="dark")

API Reference

Function Description
seqeyes.set(**kwargs) Enable SeqEyes and set global defaults (theme, show_blocks, time_disp, grad_disp, time_range)
seqeyes.reset() Restore matplotlib seq.plot() and clear all defaults
SeqEyesViewer(source, ...) Low-level viewer for raw .seq text or .bseq bytes
SeqEyesViewer.from_file(path, ...) Open a local .seq or .bseq file without pypulseq

Viewer Controls

Action How
Zoom Scroll wheel
Pan Click + drag
Amplitude zoom (per channel) Ctrl + scroll wheel
Tooltip Hover over waveform
Toggle channels Click legend labels
K‑Space viewer Click "K‑Space" button
Rotate k‑space Click + drag in panel
Minimap navigation Click on minimap strip
Open another file 📂 Open button

Requirements

  • Python ≥ 3.9
  • numpy ≥ 1.21
  • pypulseq ≥ 1.4 (optional, for seq.plot() integration)
  • pywebview ≥ 5 (optional, for native desktop pop‑up windows)

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

seqeyes_python-0.2.9.tar.gz (567.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

seqeyes_python-0.2.9-py3-none-any.whl (63.2 kB view details)

Uploaded Python 3

File details

Details for the file seqeyes_python-0.2.9.tar.gz.

File metadata

  • Download URL: seqeyes_python-0.2.9.tar.gz
  • Upload date:
  • Size: 567.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for seqeyes_python-0.2.9.tar.gz
Algorithm Hash digest
SHA256 88b25f59ec52126ba5bae3b5c96228d83367268c6d4c67a761d4e182ad49b499
MD5 aad19a9eeccebf1cbdf2179debea2121
BLAKE2b-256 1943a08f7d81c10f47ce53c09cad4d2c1918124c13b6fcfff1128ad820fbe8ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for seqeyes_python-0.2.9.tar.gz:

Publisher: publish.yml on bughht/seqeyes_plugin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file seqeyes_python-0.2.9-py3-none-any.whl.

File metadata

  • Download URL: seqeyes_python-0.2.9-py3-none-any.whl
  • Upload date:
  • Size: 63.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for seqeyes_python-0.2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 ba087ecbcf6ccf84394fc8c33042778f679a87b1b657661d9225548df769e7d9
MD5 7bb77c76b5a5df5490876923f03cd05a
BLAKE2b-256 ed3081e4fd6bdc98b1a4aa3782bae8ce1254d96a9ae550b7c3e5500dffee105f

See more details on using hashes here.

Provenance

The following attestation bundles were made for seqeyes_python-0.2.9-py3-none-any.whl:

Publisher: publish.yml on bughht/seqeyes_plugin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page