Skip to main content

Magnetic Field Coil Generator for Python.

Project description

pyCoilGen

GitHub license PyPI - Python Version semver GitHub tag (latest SemVer) Code style: autopep8

pyCoilGen logo

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pycoilgen-0.1.0.tar.gz (129.3 kB view details)

Uploaded Source

Built Distribution

pycoilgen-0.1.0-py3-none-any.whl (159.0 kB view details)

Uploaded Python 3

File details

Details for the file pycoilgen-0.1.0.tar.gz.

File metadata

  • Download URL: pycoilgen-0.1.0.tar.gz
  • Upload date:
  • Size: 129.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.31.0

File hashes

Hashes for pycoilgen-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ca745bb63f2db0ab5cc1da585508f74b4b019116eb62fe8b8fdfabff3dddff2a
MD5 03c2cb08db1ecb56e4f03f557facdd85
BLAKE2b-256 06fe2fd592270e23d75ae025bf618a1530eafd2b40365f87d7862bc17de95a07

See more details on using hashes here.

Provenance

File details

Details for the file pycoilgen-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: pycoilgen-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 159.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.31.0

File hashes

Hashes for pycoilgen-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 98d2e9835cdb334a1a011be4f37c1b72a7a08187e496e2f00d5bc82129ea2392
MD5 8f24f33586d705ea3eefe631518812b8
BLAKE2b-256 4caaae89dc2e80c7ea1e5f5ce2a682ff81967b5dc4009f7fb5eafeb5d9b7dee9

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page