Magnetic Field Coil Generator for Python.
Project description
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:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pycoilgen-0.2.2.tar.gz
.
File metadata
- Download URL: pycoilgen-0.2.2.tar.gz
- Upload date:
- Size: 130.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.31.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a05e9a283007d7f33c7596e03d68cece752074c3bcdee938d2a303ca8e6e16ac |
|
MD5 | d13fd1c667e3d4a079e0ab9c7d1d277b |
|
BLAKE2b-256 | 6aef4ce41b2376b5553bf4cd2b55271f7b28f631adfe95c427e7f8c651e0e2be |
File details
Details for the file pycoilgen-0.2.2-py3-none-any.whl
.
File metadata
- Download URL: pycoilgen-0.2.2-py3-none-any.whl
- Upload date:
- Size: 159.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.31.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca17e7e76119dd014677d96a9211ede884687f17cf94c262eeb209ec56fb0b56 |
|
MD5 | fe9445959feb0cd0340c4db361110271 |
|
BLAKE2b-256 | a8cec2a3b9c671341b05e0f2e71a483a4cc3d4a566fa3941888be0b27fa23b20 |