Skip to main content

MRI Nexus console application to run pulseq sequences on Spectrum-Instrumentation measurement cards.

Project description

Nexus-Console for Advanced Low-Field MRI

Python License Sphinx Docs Static Tests Pytest Coverage

This project aims to implement a versatile console for low-field magnetic resonance imaging (MRI) acquisitions. The central hardware components are two spectrum cards from Spectrum Instrumentation. They serve as arbitrary waveform generators (AWG) and analog to digital converter (digitizer). Depending on the measurement card specification, the Nexus console can also be used for higher frequencies (first experiments at 7T were conducted). This application controls AWG and digitizer cards to perform MRI scans by directly interpreting sequences defined by the open-source pulseq framework, i.e. the python implementation pypulseq. An interfaces to the open data MR raw data format ISMRMRD is implemented to directly enable Nexus with the latest reconstruction algorithms, e.g. from the Gadgetron toolbox.

Installation

It is recommended to install the package in a virtual environment (e.g. conda). Further documentation on setting up miniconda can be found here. The package was developed under Python 3.10 so it is recommended to use python==3.10.

To install the Nexus console application, clone the repository an ensure that you are in the repository directory, which is */nexus-console/. The package can be installed with different dependencies depending on the specific requirements:

`pip install -e .`

Installs all the necessary base dependencies to use the package (minimum required).

`pip install -e ".[lint]"`

Installs additional (optional) dependencies that are required to run the linter.

`pip install -e ".[test]"`

Installs additional (optional) dependencies that are required to run the linter.

`pip install -e ".[docs]"`

Installs additional (optional) dependencies that are required to build the sphinx documentation locally.

`pip install -e ".[dev]"`

Installs additional (optional) developer dependencies for profiling and developing in vs code.

Hint: Multiple dependency groups can be installed using ".[lint, test]" for instance.

Usage

Please follow the project documentation which contains a quick-start guide, some examples and a user guide.

Publications

If you find this useful in your work, please cite:

Schote D, Silemek B, O'Reilly T, Seifert F, Assmy JL, Kolbitsch C, Webb AG, Winter L. Nexus: A versatile console for advanced low-field MRI. Magn Reson Med. 2025. doi: 10.1002/mrm.30406.

Acknowledgments

This work is part of the Metrology for Artificial Intelligence for Medicine (M4AIM) project, which is funded by the Federal Ministry of Economic Affairs and Climate Action (BMWK) as part of the QI-Digital initiative. The projects 21NRM05 STASIS and 22HLT02 A4IM have received funding from the European Partnership on Metrology, cofinanced by the European Union's Horizon Europe Research and Innovation Program and by the Participating States. Partial support for this project is provided by a European Research Council Advanced Grant (PASMAR 101021218). This work is supported by the Open Source Imaging Initiative (OSI²)


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

nexus_console-0.0.1.tar.gz (43.4 kB view details)

Uploaded Source

Built Distribution

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

nexus_console-0.0.1-py3-none-any.whl (29.0 kB view details)

Uploaded Python 3

File details

Details for the file nexus_console-0.0.1.tar.gz.

File metadata

  • Download URL: nexus_console-0.0.1.tar.gz
  • Upload date:
  • Size: 43.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nexus_console-0.0.1.tar.gz
Algorithm Hash digest
SHA256 3eb958d86f54dfbecf70686cc47c4494436d488c39309d86cb75844618a07f49
MD5 3c2c275ba751ad42d8e4e26ea391d324
BLAKE2b-256 af5911f5c432d26b1736b21f3a00d9eb8ae76212f1c9622c9d4e4b998d4559c0

See more details on using hashes here.

File details

Details for the file nexus_console-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: nexus_console-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 29.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nexus_console-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 de85fd963b9153fa9bb95bfdf51632001f50e1ee5436d3c94890156de4547fe1
MD5 4635b7fe2284190d8a3c47c60675dca3
BLAKE2b-256 8d1b6a016bd5c9a057996cb385f8b7cfc9c40d317bb25304505e0903f88929fb

See more details on using hashes here.

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