Skip to content

tblazey/x_epi

Repository files navigation

drawing
Logo designed by Alyssa Weisenstein

 

Documentation Status Pylint codecov Code style: black Static Badge License: MIT

x_epi is a Python package for creating EPI sequences for X-nucleus imaging. It was designed for hyperpolarized 13C imaging, but can be used for 1H and other NMR sensitive nuclei. It uses the PyPulseq package to create vendor neutral sequences in the Pulseq format.

Users can create a custom EPI sequence using python functions, a command line program, or a simple graphical user interface.

A paper describing the sequence/program has been published in Magnetic Resonance in Medicine.

Installation

If you have Python 3.10, you can install the package using pip:

pip install git+https://github.com/tblazey/x_epi.git

Please see the documentation for more details on installation.

Quick start

Once installed, you can type x_epi_gui in a command prompt to launch the user interface. You will then be prompted to either load a custom JSON configuration file or use the default. If you don't have a JSON configuration, simply click 'Use Default' to get started.

You can also create a sequence using x_epi_cmd:

x_epi_cmd -out example -fov 320 320 320 -symm_ro -acq_3d -met -name 'pyr' \
          -size 16 16 16 -flip 10 -met -name 'lac' -size 12 12 12 -flip 45

The command above creates a 3D EPI sequence with two different metabolites. For more information about creating sequences, see the documentation

About

EPI sequence creation tools for X-nucleus imaging

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages