search

PTB-MR / mrpro

MR image reconstruction and processing
Apache License 2.0
9 stars 3 forks source link

readme

MRpro

MR image reconstruction and processing package specifically developed for PyTorch.

This package supports ismrmrd-format for MR raw data. All data containers utilize PyTorch tensors to ensure easy integration in PyTorch-based network schemes.

Python License Coverage Bagde

If you want to give MRpro a try you can use Binder

You find the documentation here

Contributing

Installation for developers

  1. Clone the repo
  2. Create/select a python environment
  3. Open a terminal in the "MRpro" main folder
  4. Install "MRpro" in editable mode with linting and testing: pip install -e ".[lint,test]"
  5. Setup Pre-Commit Hook: pre-commit install

Recommended IDE and Extensions

We recommend to use Microsoft Visual Studio Code.

A list of recommended extensions for VSCode is given in the .vscode/extensions.json

Documentation

Please have a look at our contributor guide for more information on the structure of the repository, naming conventions and other useful information.