# pyCoilGen
[](https://github.com/kev-m/pyCoilGen/blob/main/LICENSE)
[](https://pypi.org/project/pycoilgen/)
[](https://semver.org/)
[](https://github.com/kev-m/pyCoilGen/releases)
[](https://pypi.org/project/autopep8/)
The **pyCoilGen** project is an open source tool for generating coil winding layouts, such as
[gradient field coils](https://mriquestions.com/gradient-coils.html), within the
[MRI](https://en.wikipedia.org/wiki/Magnetic_resonance_imaging) and
[NMR](https://en.wikipedia.org/wiki/Nuclear_magnetic_resonance) 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](https://github.com/Philipp-MR/CoilGen) developed by Philipp Amrein.
For detailed documentation, refer to the [pyCoilGen Documentation](https://pycoilgen.readthedocs.io/).
## Installation
Refer to the [Installation Guide](https://pycoilgen.readthedocs.io/en/latest/installation.html) for detailed instructions on how to install and set up **pyCoilGen**.
## Examples
The [`examples`](https://github.com/kev-m/pyCoilGen/blob/master/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](https://chat.openai.com) with manual corrections.
Additional cross-checking was done using [MATLAB Online](https://www.mathworks.com/products/matlab-online.html) provided by MathWorks.
## Contributing
If you'd like to contribute to **pyCoilGen**, follow the guidelines outlined in the [Contributing Guide](https://github.com/kev-m/pyCoilGen/blob/master/CONTRIBUTING.md).
## License
See [`LICENSE.txt`](https://github.com/kev-m/pyCoilGen/blob/master/LICENSE.txt) for more information.
## Contact
For inquiries and discussion, use [pyCoilGen Discussions](https://github.com/kev-m/pyCoilGen/discussions).
## Issues
For issues related to this Python implementation, visit the [Issues](https://github.com/kev-m/pyCoilGen/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.](https://onlinelibrary.wiley.com/doi/10.1002/mrm.29294)
Raw data
{
"_id": null,
"home_page": null,
"name": "pycoilgen",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "MRI, Magnetic Resonance Imaging, NMR, Nuclear Resonance Imaging, Target Field, Gradient Field, Physics, Coil",
"author": null,
"author_email": "Kevin Meyer <kevin@kmz.co.za>, Philipp Amrein <none@noreply.com>",
"download_url": "https://files.pythonhosted.org/packages/6a/ef/4ce41b2376b5553bf4cd2b55271f7b28f631adfe95c427e7f8c651e0e2be/pycoilgen-0.2.2.tar.gz",
"platform": null,
"description": "# pyCoilGen\n[](https://github.com/kev-m/pyCoilGen/blob/main/LICENSE)\n[](https://pypi.org/project/pycoilgen/)\n[](https://semver.org/)\n[](https://github.com/kev-m/pyCoilGen/releases)\n[](https://pypi.org/project/autopep8/)\n\n\n\nThe **pyCoilGen** project is an open source tool for generating coil winding layouts, such as\n[gradient field coils](https://mriquestions.com/gradient-coils.html), within the\n[MRI](https://en.wikipedia.org/wiki/Magnetic_resonance_imaging) and\n[NMR](https://en.wikipedia.org/wiki/Nuclear_magnetic_resonance) environments. **pyCoilGen** is based on a boundary element method and generates interconnected non-overlapping wire-tracks on 3D support structures.\n\nThis Python project is a port of the MATLAB [CoilGen code](https://github.com/Philipp-MR/CoilGen) developed by Philipp Amrein. \n\nFor detailed documentation, refer to the [pyCoilGen Documentation](https://pycoilgen.readthedocs.io/).\n\n## Installation\n\nRefer to the [Installation Guide](https://pycoilgen.readthedocs.io/en/latest/installation.html) for detailed instructions on how to install and set up **pyCoilGen**.\n\n## Examples\n\nThe [`examples`](https://github.com/kev-m/pyCoilGen/blob/master/examples) directory contains several examples for how to use **pyCoilGen**. These examples demonstrate different scenarios and configurations for generating coil layouts.\n\n## Acknowledgements\n\nThe porting of the code from MATLAB to Python was facilitated by [ChatGPT, May 24 through August 3 Version](https://chat.openai.com) with manual corrections. \n\nAdditional cross-checking was done using [MATLAB Online](https://www.mathworks.com/products/matlab-online.html) provided by MathWorks.\n\n## Contributing\n\nIf you'd like to contribute to **pyCoilGen**, follow the guidelines outlined in the [Contributing Guide](https://github.com/kev-m/pyCoilGen/blob/master/CONTRIBUTING.md).\n\n## License\n\nSee [`LICENSE.txt`](https://github.com/kev-m/pyCoilGen/blob/master/LICENSE.txt) for more information.\n\n## Contact\n\nFor inquiries and discussion, use [pyCoilGen Discussions](https://github.com/kev-m/pyCoilGen/discussions).\n\n## Issues\n\nFor issues related to this Python implementation, visit the [Issues](https://github.com/kev-m/pyCoilGen/issues) page.\n\n## Citation\n\nUse the following publication, if you need to cite this work:\n\n- [Amrein, P., Jia, F., Zaitsev, M., & Littin, S. (2022). CoilGen: Open-source MR coil layout generator. Magnetic Resonance in Medicine, 88(3), 1465-1479.](https://onlinelibrary.wiley.com/doi/10.1002/mrm.29294)\n",
"bugtrack_url": null,
"license": null,
"summary": "Magnetic Field Coil Generator for Python.",
"version": "0.2.2",
"project_urls": {
"Bug tracker": "https://github.com/kev-m/pyCoilGen/issues",
"Changelog": "https://github.com/kev-m/pyCoilGen/blob/release/CHANGELOG.md",
"Code of Conduct": "https://github.com/kev-m/pyCoilGen/blob/release/CODE_OF_CONDUCT.md",
"Contributing": "https://github.com/kev-m/pyCoilGen/blob/release/CONTRIBUTING.md",
"Documentation": "https://pycoilgen.readthedocs.io/",
"Home": "https://github.com/kev-m/pyCoilGen",
"Source": "https://github.com/kev-m/pyCoilGen"
},
"split_keywords": [
"mri",
" magnetic resonance imaging",
" nmr",
" nuclear resonance imaging",
" target field",
" gradient field",
" physics",
" coil"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a8cec2a3b9c671341b05e0f2e71a483a4cc3d4a566fa3941888be0b27fa23b20",
"md5": "fe9445959feb0cd0340c4db361110271",
"sha256": "ca17e7e76119dd014677d96a9211ede884687f17cf94c262eeb209ec56fb0b56"
},
"downloads": -1,
"filename": "pycoilgen-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fe9445959feb0cd0340c4db361110271",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 159524,
"upload_time": "2024-06-24T18:24:43",
"upload_time_iso_8601": "2024-06-24T18:24:43.587635Z",
"url": "https://files.pythonhosted.org/packages/a8/ce/c2a3b9c671341b05e0f2e71a483a4cc3d4a566fa3941888be0b27fa23b20/pycoilgen-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6aef4ce41b2376b5553bf4cd2b55271f7b28f631adfe95c427e7f8c651e0e2be",
"md5": "d13fd1c667e3d4a079e0ab9c7d1d277b",
"sha256": "a05e9a283007d7f33c7596e03d68cece752074c3bcdee938d2a303ca8e6e16ac"
},
"downloads": -1,
"filename": "pycoilgen-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "d13fd1c667e3d4a079e0ab9c7d1d277b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 130484,
"upload_time": "2024-06-24T18:24:46",
"upload_time_iso_8601": "2024-06-24T18:24:46.804603Z",
"url": "https://files.pythonhosted.org/packages/6a/ef/4ce41b2376b5553bf4cd2b55271f7b28f631adfe95c427e7f8c651e0e2be/pycoilgen-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-24 18:24:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kev-m",
"github_project": "pyCoilGen",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "pycoilgen"
}
JSON
