Skip to main content

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:

Metadata

Release files for pycoilgen 0.2.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pycoilgen 0.2.4
File Size Uploaded
pycoilgen-0.2.4.tar.gz 134.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pycoilgen 0.2.4
File Interpreter ABI Platform
pycoilgen-0.2.4-py3-none-any.whl Python 3 none any Details

Total release size: 299.2 kB

Release files / pycoilgen-0.2.4.tar.gz

Download URL pycoilgen-0.2.4.tar.gz
Size 134.0 kB
Tags Source
SHA-256 checksum
How to use checksums
b4522cda9b23277e4b5f47b15c5efdcc737379b1072b374b02b902abd379d358
BLAKE2b-256 checksum
How to use checksums
cef5c49c482fe2d62a38f391fe093ec49684de90bdbdcd4074a967f09d683b2e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.32.5

Release files / pycoilgen-0.2.4-py3-none-any.whl

Download URL pycoilgen-0.2.4-py3-none-any.whl
Size 165.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
19b120a73b9a1b5314173b667bde14517af1dee04c245be8a3b919dbddc5dba9
BLAKE2b-256 checksum
How to use checksums
69599fdfce944aeb2cab9bcc46ced659d95df3dce8bb36448ddbb947cd02b496
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.32.5

Release history Release notifications | RSS feed

This release

0.2.4 This release

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.11

2 release files

0.0.10

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page