Skip to main content

Python-based domain-specific language for computational magnetism

Project description

micromagneticmodel

Marijan Beg1,2, Martin Lang2, Samuel Holt2,3, Swapneel Amit Pathak2,4, and Hans Fangohr2,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 Build status
Linting pre-commit.ci status
Code style: black
Releases PyPI version
Anaconda-Server Badge
Coverage codecov
Documentation Documentation
YouTube YouTube
Binder Binder
Platforms Platforms
Downloads Downloads
License License
DOI DOI

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.

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.

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 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 repository, and we are going to help you get started and assist you on the way.

Contributors:

License

Licensed under the BSD 3-Clause "New" or "Revised" License. For details, please refer to the 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 (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 (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 (2023).

Acknowledgements

  • OpenDreamKit – Horizon 2020 European Research Infrastructure project (676541)

  • EPSRC Programme Grant on Skyrmionics (EP/N032128/1)

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

micromagneticmodel-0.63.2.tar.gz (35.4 kB view details)

Uploaded Source

Built Distribution

micromagneticmodel-0.63.2-py3-none-any.whl (56.1 kB view details)

Uploaded Python 3

File details

Details for the file micromagneticmodel-0.63.2.tar.gz.

File metadata

  • Download URL: micromagneticmodel-0.63.2.tar.gz
  • Upload date:
  • Size: 35.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.17

File hashes

Hashes for micromagneticmodel-0.63.2.tar.gz
Algorithm Hash digest
SHA256 bdc46223e0709bac34cb824f2757971b1836a90c32affb6654c4047e076536cf
MD5 1d02640ac07cbaf83c7014e4920f7768
BLAKE2b-256 7b585bfda8884750b079bd9d58f1c8abec6d9228b75fdf3a78173c728acc9b1f

See more details on using hashes here.

File details

Details for the file micromagneticmodel-0.63.2-py3-none-any.whl.

File metadata

File hashes

Hashes for micromagneticmodel-0.63.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3286b94d1db411940da6c67ec42ae2ee11077b16d923550a8882291c55de8259
MD5 9c685b45415cca08593055d89182e817
BLAKE2b-256 c23d17ff6b1da0d895feb16f2d9b97c9472736280ab8c6defb7f1fc33213f056

See more details on using hashes here.

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