Metadata-Version: 2.4
Name: mrseq
Version: 0.260810
Summary: (Py)Pulseq-based MRI sequences.
Author-email: Patrick Schuenke <patrick.schuenke@ptb.de>, Christoph Kolbitsch <christoph.kolbitsch@ptb.de>
Project-URL: repository, https://github.com/PTB-MR/mrseq
Keywords: MRI, Pulseq, PyPulseq, pulse sequence
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: <3.15,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy<3.0,>=1.23
Requires-Dist: matplotlib<4.0
Requires-Dist: pypulseq>=1.4.1
Requires-Dist: ismrmrd>=1.14.1
Requires-Dist: raw2ismrmrd>=0.260630
Provides-Extra: tests
Requires-Dist: coverage; extra == "tests"
Requires-Dist: codecov; extra == "tests"
Requires-Dist: pre-commit; extra == "tests"
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: pytest-xdist; extra == "tests"
Provides-Extra: examples
Requires-Dist: mrzerocore<1.0,>=0.4.3; extra == "examples"
Requires-Dist: mrpro; extra == "examples"
Requires-Dist: cmap; extra == "examples"
Provides-Extra: dev
Requires-Dist: mrseq[examples,tests]; extra == "dev"
Requires-Dist: jupyter-book<2.0; extra == "dev"
Dynamic: license-file


![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
![Coverage Bagde](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/schuenke/330a0c00b5fa35d89bbc73ea6e8d99be/raw/coverage.json)

# MRseq - MR pulse sequences using Pulseq

`MRseq` is a collection of several useful functions, kernels and scripts for creating vendor-agnostic MR pulse sequences using the open-source Pulseq format.

- **Source code:** <https://github.com/PTB-MR/mrseq>
- **Bug reports:** <https://github.com/PTB-MR/mrseq/issues>
- **Documentation:** <https://ptb-mr.github.io/mrseq/intro.html>

## Contributing

We are looking forward to your contributions via Pull-Requests.

## Installation for developers

### Prerequisites for Windows

Before installing `MRseq` with development dependencies on Windows, you need:

1. **Visual Studio Build Tools**: The MRzeroCore dependency requires Rust compilation with Microsoft Visual C++ linker
   - Download "Build Tools for Visual Studio 2022" from https://visualstudio.microsoft.com/downloads/
   - During installation, select the "C++ build tools" workload
   - Ensure "Windows 10/11 SDK" is included
   - This is required for compiling native Rust extensions

2. **Rust toolchain** (automatically installed by MRzeroCore if not present)

### Installation steps

1. Clone the `MRseq` repository
2. Create/select a python environment
3. Install `MRseq` in editable mode including test dependencies: ``` pip install -e ".[dev]" ```
4. Setup pre-commit hook: ``` pre-commit install ```


## Licensing and Dependencies

The core source code of `MRseq` is licensed under the **Apache-2.0 license**. 

For quality control and demonstration purposes, the notebooks in the `examples/` directories utilize [MRZero](https://github.com/MRsources/MRzero-Core) which is AGPL-licensed. The notebooks in the `examples/` folder should be treated as **AGPLv3**. 

**Important for Commercial Users:**
The AGPL dependency is listed only as an optional dev dependency. Installing this package via `pip install mrseq` **does not** install the AGPL library. Your usage of the core library remains subject to the permissive Apache-2.0 terms, unaffected by the licensing of the test suite or examples.

## Contact
For questions or support, please contact us:

> Christoph Kolbitsch  
> Physikalisch-Technische Bundesanstalt (PTB)  
> Abbestraße 2-12  
> 10587 Berlin, Germany  
> christoph.kolbitsch@ptb.de

> Patrick Schünke  
> NVision Quantum Technologies GmbH  
> Wolfgang-Paul-Straße 2  
> 89081 Ulm, Germany  
> patrick.schuenke@nvision-quantum.com

## Acknowledgments
We would like to thank [NVision Quantum Technologies GmbH](https://www.nvision-quantum.com/) for their contributions to this project.
