<div align='center'> <h1> MagnetoPyElastica </h1> </div>
[![CI][badge-CI]][link-CI] [![codecov][badge-codecov]][link-codecov] [![DOI][badge-doi]][link-doi]
MagnetoPyElastica is an *open-source* project for simulating magnetic Cosserat rods interacting with external magnetic environments, and is an extension of [PyElastica][pyelastica-repo].
https://user-images.githubusercontent.com/33580851/185485978-f5962c41-89a4-4df7-b935-1ba92a55f1da.mov
[//]: # ([![gallery][link-readme-gallary]][link-project-website])
Visit [cosseratrods.org][link-project-website] to learn more about Elastica and Cosserat rod theory.
## Installation
[//]: # ([![PyPI version][badge-pypi]][link-pypi])
MagnetoPyElastica is compatible with Python 3.8 - 3.10. The easiest way to install MagnetoPyElastica is with PIP.
~~~bash
$ pip install magneto_pyelastica
~~~
[//]: # (## Documentation)
[//]: # ([![Documentation Status][badge-docs-status]][link-docs-status])
[//]: # ()
[//]: # (Documentation of PyElastica is available [here][link-docs-website])
## Tutorials
We have included example scripts for some illustration cases and these scripts located under examples folder ([`examples/`](examples/)).
## Contribution
If you would like to participate, please read our [contribution guideline](CONTRIBUTING.md)
MagnetoPyElastica is developed by the [Gazzola Lab][link-lab-website] at the University of Illinois at Urbana-Champaign.
## Citation
```
@software{yashraj_bhosale_2023_7658892,
author = {Yashraj Bhosale and
Arman Tekinalp},
title = {{MagnetoPyElastica: Open-source software for
simulating magnetic Cosserat rods}},
month = feb,
year = 2023,
publisher = {Zenodo},
version = {v.0.0.1.post1},
doi = {10.5281/zenodo.7658892},
url = {https://doi.org/10.5281/zenodo.7658892}
}
```
## Senior Developers ✨
_Names arranged alphabetically_
- [Arman Tekinalp](https://github.com/armantekinalp)
- [Yashraj Bhosale](https://github.com/bhosale2)
[//]: # (Collection of URLs.)
[//]: # ([link-readme-gallary]: https://github.com/skim0119/PyElastica/blob/assets_logo/assets/alpha_gallery.gif)
[link-project-website]: https://cosseratrods.org
[link-lab-website]: http://mattia-lab.com/
[link-docs-website]: https://docs.cosseratrods.org/
[badge-CI]: https://github.com/armantekinalp/MagnetoPyElastica/workflows/CI/badge.svg
[badge-codecov]: https://codecov.io/gh/armantekinalp/MagnetoPyElastica/branch/main/graph/badge.svg
[badge-doi]: https://zenodo.org/badge/513349542.svg
[link-CI]: https://github.com/armantekinalp/MagnetoPyElastica/actions
[link-codecov]: https://codecov.io/gh/armantekinalp/MagnetoPyElastica
[link-doi]: https://zenodo.org/badge/latestdoi/513349542
[pyelastica-repo]: ttps://github.com/GazzolaLab/PyElastica
Raw data
{
"_id": null,
"home_page": "https://github.com/armantekinalp/MagnetoPyElastica",
"name": "magneto-pyelastica",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.11",
"maintainer_email": "",
"keywords": "python,simulation,elastica,cosserat-rod,magneto-elastodynamics",
"author": "Arman Tekinalp",
"author_email": "armant2@illinois.edu",
"download_url": "https://files.pythonhosted.org/packages/3c/9d/0948f1371826f4367975c8a83ff65493407d16049f504ff42742269f6b8e/magneto_pyelastica-0.0.1.post2.tar.gz",
"platform": null,
"description": "<div align='center'> <h1> MagnetoPyElastica </h1> </div>\n\n[![CI][badge-CI]][link-CI] [![codecov][badge-codecov]][link-codecov] [![DOI][badge-doi]][link-doi]\n\nMagnetoPyElastica is an *open-source* project for simulating magnetic Cosserat rods interacting with external magnetic environments, and is an extension of [PyElastica][pyelastica-repo].\n\nhttps://user-images.githubusercontent.com/33580851/185485978-f5962c41-89a4-4df7-b935-1ba92a55f1da.mov\n\n[//]: # ([![gallery][link-readme-gallary]][link-project-website])\n\nVisit [cosseratrods.org][link-project-website] to learn more about Elastica and Cosserat rod theory.\n\n## Installation\n\n[//]: # ([![PyPI version][badge-pypi]][link-pypi])\n\nMagnetoPyElastica is compatible with Python 3.8 - 3.10. The easiest way to install MagnetoPyElastica is with PIP.\n\n~~~bash\n$ pip install magneto_pyelastica\n~~~\n\n[//]: # (## Documentation)\n\n[//]: # ([![Documentation Status][badge-docs-status]][link-docs-status])\n\n[//]: # ()\n[//]: # (Documentation of PyElastica is available [here][link-docs-website])\n\n## Tutorials\n\nWe have included example scripts for some illustration cases and these scripts located under examples folder ([`examples/`](examples/)).\n\n\n## Contribution\n\nIf you would like to participate, please read our [contribution guideline](CONTRIBUTING.md)\n\nMagnetoPyElastica is developed by the [Gazzola Lab][link-lab-website] at the University of Illinois at Urbana-Champaign.\n\n## Citation\n\n```\n@software{yashraj_bhosale_2023_7658892,\n author = {Yashraj Bhosale and\n Arman Tekinalp},\n title = {{MagnetoPyElastica: Open-source software for \n simulating magnetic Cosserat rods}},\n month = feb,\n year = 2023,\n publisher = {Zenodo},\n version = {v.0.0.1.post1},\n doi = {10.5281/zenodo.7658892},\n url = {https://doi.org/10.5281/zenodo.7658892}\n}\n```\n\n## Senior Developers \u2728\n_Names arranged alphabetically_\n- [Arman Tekinalp](https://github.com/armantekinalp)\n- [Yashraj Bhosale](https://github.com/bhosale2)\n\n[//]: # (Collection of URLs.)\n\n[//]: # ([link-readme-gallary]: https://github.com/skim0119/PyElastica/blob/assets_logo/assets/alpha_gallery.gif)\n\n[link-project-website]: https://cosseratrods.org\n[link-lab-website]: http://mattia-lab.com/\n[link-docs-website]: https://docs.cosseratrods.org/\n\n[badge-CI]: https://github.com/armantekinalp/MagnetoPyElastica/workflows/CI/badge.svg\n[badge-codecov]: https://codecov.io/gh/armantekinalp/MagnetoPyElastica/branch/main/graph/badge.svg\n[badge-doi]: https://zenodo.org/badge/513349542.svg\n[link-CI]: https://github.com/armantekinalp/MagnetoPyElastica/actions\n[link-codecov]: https://codecov.io/gh/armantekinalp/MagnetoPyElastica\n[link-doi]: https://zenodo.org/badge/latestdoi/513349542\n[pyelastica-repo]: ttps://github.com/GazzolaLab/PyElastica\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python software for simulating magnetic Cosserat rods.",
"version": "0.0.1.post2",
"project_urls": {
"Homepage": "https://github.com/armantekinalp/MagnetoPyElastica",
"Repository": "https://github.com/armantekinalp/MagnetoPyElastica"
},
"split_keywords": [
"python",
"simulation",
"elastica",
"cosserat-rod",
"magneto-elastodynamics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1ea5616801332690f281660fc40f5a639410879ab63726e81393b832d5dca30e",
"md5": "52b262d77f0da926aa7940210919b844",
"sha256": "5a50a3cb99b146f428c4f9812d89bb82126b734673f1d7408191cce87bfb1604"
},
"downloads": -1,
"filename": "magneto_pyelastica-0.0.1.post2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "52b262d77f0da926aa7940210919b844",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.11",
"size": 6702,
"upload_time": "2023-05-12T23:46:43",
"upload_time_iso_8601": "2023-05-12T23:46:43.917532Z",
"url": "https://files.pythonhosted.org/packages/1e/a5/616801332690f281660fc40f5a639410879ab63726e81393b832d5dca30e/magneto_pyelastica-0.0.1.post2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3c9d0948f1371826f4367975c8a83ff65493407d16049f504ff42742269f6b8e",
"md5": "5a00475e4c3a6de0d1c06cef7ec9ca85",
"sha256": "0a46cd3404796d9a83686d6e693650372c06a352a91a797eb077c6ab98ddd85d"
},
"downloads": -1,
"filename": "magneto_pyelastica-0.0.1.post2.tar.gz",
"has_sig": false,
"md5_digest": "5a00475e4c3a6de0d1c06cef7ec9ca85",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.11",
"size": 5634,
"upload_time": "2023-05-12T23:46:45",
"upload_time_iso_8601": "2023-05-12T23:46:45.750326Z",
"url": "https://files.pythonhosted.org/packages/3c/9d/0948f1371826f4367975c8a83ff65493407d16049f504ff42742269f6b8e/magneto_pyelastica-0.0.1.post2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-12 23:46:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "armantekinalp",
"github_project": "MagnetoPyElastica",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "magneto-pyelastica"
}
JSON
