pycoilgen 0.2.4

Magnetic Field Coil Generator for Python.

pyCoilGen

The pyCoilGen project is an open source tool for generating coil winding layouts, such as gradient field coils, within the MRI and NMR environments. pyCoilGen is based on a boundary element method and generates interconnected non-overlapping wire-tracks on 3D support structures.

This Python project is a port of the MATLAB CoilGen code developed by Philipp Amrein.

For detailed documentation, refer to the pyCoilGen Documentation.

Installation

Refer to the Installation Guide for detailed instructions on how to install and set up pyCoilGen.

Examples

The examples directory contains several examples for how to use pyCoilGen. These examples demonstrate different scenarios and configurations for generating coil layouts.

Acknowledgements

The porting of the code from MATLAB to Python was facilitated by ChatGPT, May 24 through August 3 Version with manual corrections.

Additional cross-checking was done using MATLAB Online provided by MathWorks.

Contributing

If you'd like to contribute to pyCoilGen, follow the guidelines outlined in the Contributing Guide.

License

See LICENSE.txt for more information.

Contact

For inquiries and discussion, use pyCoilGen Discussions.

Issues

For issues related to this Python implementation, visit the Issues page.

Citation

Use the following publication, if you need to cite this work:

• Amrein, P., Jia, F., Zaitsev, M., & Littin, S. (2022). CoilGen: Open-source MR coil layout generator. Magnetic Resonance in Medicine, 88(3), 1465-1479.