pdaude / pulseq

Open source framework for pulse sequences

Introduction

Pulseq is an open source framework for the development, representation and execution of magnetic resonance (MR) sequences. A central contribution of this project is an open file format to compactly describe MR sequences suitable for execution on an MRI scanner or NMR spectrometer. MATLAB and C++ source code is provided for reading and writing sequence files. The main homepage for Pulseq is http://pulseq.github.io/. This readme is part of the GitHub repository of the source code.

This project is open source under the MIT License. See LICENSE for details.

The directories are organized as follows:

• doc/ - Contains the file specification and HTML source code documentation
• examples/ - Contains example sequence files (*.seq)
• src/ - C++ class for reading sequence files
• matlab/ - MATLAB code for reading, writing, modifying and visualizing sequence files

System requirements

System requirements vary depending on which features one intends to use or modify. In short,

• doxygen is required to generate HTML source code documentation
• latex is required to build the file specification PDF
• python is required to run the build tests and to generate advanced RF pulses
• python's sigpy package is required to generate advanced RF pulses

These are optional and not essential to start using Pulseq.