Welcome to shimming-toolbox!

Note

This website is a work in progress.

shimming-toolbox is an open-source Python software package enabling a variety of MRI shimming (magnetic field homogenization) techniques such as static and real-time shimming for use with standard manufacturer-supplied gradient/shim coils or with custom “multi-coil” arrays.

Contents:

• Introduction
• Flowchart
• Installation
  • Linux
  • macOS
    • Bash
    • Zsh
  • Windows
  • Git (optional)
  • Virtual Environment
  • shimming-toolbox
    • Development version
      • Updating
  • Testing the installation
    • Comprehensive test
    • Testing subsets of soft dependencies
• Getting Started
  • Examples
    • general_demo
• Help
• Contributing to shimming-toolbox
  • Introduction
  • Opening an issue
    • Before Submitting a New Issue
    • Submitting an Issue
      • Issue Examples
  • Opening a Branch
  • Developing
    • Pre-commit checks
    • Conflicts
    • Code style
    • Documentation and docstrings
    • Testing
    • Licensing
  • Committing
    • Commit Titles
    • Commit Sequences
  • Submitting a Pull Request
    • PR Labels
    • Work in progress
    • Continuous Integration
    • Reviewers
    • Merging your PR
  • Versioning
• Contributors
• License and warranty
• Assembly
• Description of hardware with amplifiers
• CLI Reference
  • mask
    • box
    • rect
    • threshold
• API Reference
  • unwrap
  • masking
  • coils
    • siemens_basis
    • spherical_harmonics
  • numerical_model
  • misc