search

ubermag / mumax3c

mumax3 calculator.
https://ubermag.github.io
BSD 3-Clause "New" or "Revised" License
22 stars 7 forks source link

readme

mumax3c

Marijan Beg1,2, Samuel Holt2,3, Swapneel Amit Pathak2,4, Martin Lang2, Jeroen Mulkers5, Jonathan Leliaert5, Vanessa Nehruji2, Gary Downing2, Ryan A. Pepper6, Martin Lang2, Thomas Kluyver7, and Hans Fangohr2,4,8

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 Faculty of Sciences, Ghent University, Krijgslaan 281, S12, 9000 Ghent, Belgium
6 Research Software Group, University of Birmingham, Birmingham B15 2TT, UK
7 European XFEL GmbH, Holzkoppel 4, 22869 Schenefeld, Germany
8 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

mumax3c is a Python package, integrated with Jupyter, providing:

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, Samuel Holt, Swapneel Amit Pathak, Martin Lang, Jeroen Mulkers, Jonathan Leliaert, Vanessa Nehruji, Gary Downing, Ryan A. Pepper, Martin Lang, Thomas Kluyver, and Hans Fangohr. mumax3c: Python interface to mumax3 integrated into Jupyter notebook. DOI: 10.5281/zenodo.3539461 (2023).

Acknowledgements