Metadata-Version: 2.1
Name: magoptlib
Version: 0.1.0
Summary: Global spherical harmonic analysis for optimal magnet positioning.
License: MIT
Author: Palma Inczeffy
Requires-Python: >=3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: matplotlib (>=3.7)
Requires-Dist: numpy (>=1.26.0,<2.0.0)
Requires-Dist: scikit-learn (>=1.5.1,<2.0.0)
Requires-Dist: scipy (>=1.13.0)
Description-Content-Type: text/markdown

# magoptlib

Global spherical harmonic analysis for optimal magnet positioning.

## Installation

```bash
$ pip install magoptlib
```

## Usage

- TODO

## Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

## License

`magoptlib` was created by Palma Inczeffy. It is licensed under the terms of the MIT license.

## Credits

`magoptlib` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).

This package is inspired by dipy, which provided the foundational ideas for the spherical harmonic coefficient calcuation.



