https://github.com/ubermag/micromagneticmodel
Python-based domain-specific language for computational magnetism.
https://github.com/ubermag/micromagneticmodel
anaconda binder bsd-3-clause domain-specific-language epsrc horizon2020 jupyter latex linux macos micromagnetics modelling physics pypi python scientific-computing simulation ubermag windows zenodo
Last synced: 3 months ago
JSON representation
Python-based domain-specific language for computational magnetism.
- Host: GitHub
- URL: https://github.com/ubermag/micromagneticmodel
- Owner: ubermag
- License: bsd-3-clause
- Created: 2016-07-13T13:41:05.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-07-14T20:38:36.000Z (3 months ago)
- Last Synced: 2025-07-15T01:03:56.160Z (3 months ago)
- Topics: anaconda, binder, bsd-3-clause, domain-specific-language, epsrc, horizon2020, jupyter, latex, linux, macos, micromagnetics, modelling, physics, pypi, python, scientific-computing, simulation, ubermag, windows, zenodo
- Language: Python
- Homepage: http://ubermag.github.io
- Size: 1.27 MB
- Stars: 11
- Watchers: 3
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# micromagneticmodel
[Marijan Beg](https://github.com/marijanbeg)1,2, [Martin Lang](https://github.com/lang-m)2, [Samuel Holt](https://github.com/samjrholt)2,3, [Swapneel Amit Pathak](https://github.com/swapneelap)2,4, and [Hans Fangohr](https://github.com/fangohr)2,4,5
1 *Department of Earth Science and Engineering, Imperial College London, London SW7 2AZ, UK*
2 *Faculty of Engineering and Physical Sciences, University of Southampton, Southampton SO17 1BJ, UK*
3 *Department of Physics, University of Warwick, Coventry CV4 7AL, UK*
4 *Max Planck Institute for the Structure and Dynamics of Matter, Luruper Chaussee 149, 22761 Hamburg, Germany*
5 *Center for Free-Electron Laser Science, Luruper Chaussee 149, 22761 Hamburg, Germany*
| Description | Badge |
| --- | --- |
| Tests | [](https://github.com/ubermag/micromagneticmodel/actions/workflows/test.yml) |
| Linting | [](https://results.pre-commit.ci/latest/github/ubermag/micromagneticmodel/master) |
| | [](https://github.com/psf/black) |
| Releases | [](https://badge.fury.io/py/micromagneticmodel) |
| | [](https://anaconda.org/conda-forge/micromagneticmodel) |
| Coverage | [](https://codecov.io/gh/ubermag/micromagneticmodel) |
| Documentation | [](https://ubermag.github.io/documentation/micromagneticmodel.html) |
| YouTube | [](https://www.youtube.com/channel/UC7MSqVQSMFV42R1jAYmKGLg) |
| Binder | [](https://mybinder.org/v2/gh/ubermag/micromagneticmodel/latest?urlpath=lab/tree/docs) |
| Platforms | [](https://anaconda.org/conda-forge/micromagneticmodel) |
| Downloads | [](https://anaconda.org/conda-forge/micromagneticmodel) |
| License | [](https://opensource.org/licenses/BSD-3-Clause) |
| DOI | [](https://doi.org/10.5281/zenodo.3539479) |
## About
`micromagneticmodel` is a Python package, integrated with Jupyter, providing:
- Domain-specific language for computational magnetism.
It is available on Windows, MacOS, and Linux. It requires Python 3.8+.
## Documentation
APIs and tutorials are available in the documentation. To access the documentation, use the badge in the table above.
## Installation, testing, and upgrade
We recommend installation using `conda` package manager. Instructions can be found in the [documentation](https://ubermag.github.io/installation.html).
## Binder
This package can be used in the cloud via Binder. To access Binder, use the badge in the table above.
## YouTube
YouTube video tutorials are available on the [Ubermag channel](https://www.youtube.com/channel/UC7MSqVQSMFV42R1jAYmKGLg).
## Support
If you require support, have questions, want to report a bug, or want to suggest an improvement, please raise an issue in [ubermag/help](https://github.com/ubermag/help) repository.
## Contributions
All contributions are welcome, however small they are. If you would like to contribute, please fork the repository and create a pull request. If you are not sure how to contribute, please contact us by raising an issue in [ubermag/help](https://github.com/ubermag/help) repository, and we are going to help you get started and assist you on the way.
**Contributors**:
- [Thomas Kluyver](https://github.com/takluyver)
- [Ryan A. Pepper](https://github.com/rpep)
- [Sergii Mamedov](https://github.com/sergii-mamedov)
- [Natalie Downing](https://github.com/gamdow)
## License
Licensed under the BSD 3-Clause "New" or "Revised" License. For details, please refer to the [LICENSE](LICENSE) file.
## How to cite
1. M. Beg, M. Lang, and H. Fangohr. Ubermag: Towards more effective micromagnetic workflows. [*IEEE Transactions on Magnetics* **58**, 7300205](https://doi.org/10.1109/TMAG.2021.3078896) (2022).
2. M. Beg, R. A. Pepper, and H. Fangohr. User interfaces for computational science: A domain specific language for OOMMF embedded in Python. [*AIP Advances* **7**, 56025](http://aip.scitation.org/doi/10.1063/1.4977225) (2017).
3. Marijan Beg, Martin Lang, Samuel Holt, Swapneel Amit Pathak, and Hans Fangohr. micromagneticmodel: Python-based domain-specific language for computational magnetism DOI: [10.5281/zenodo.3539479](http://doi.org/10.5281/zenodo.3539479) (2025).
## Acknowledgements
- [OpenDreamKit](http://opendreamkit.org/) – Horizon 2020 European Research Infrastructure project (676541)
- EPSRC Programme Grant on [Skyrmionics](http://www.skyrmions.ac.uk) (EP/N032128/1)