mag2exp

Samuel Holt^1,2, Martin Lang¹, James Loudon³, Thomas Hicken⁴, Swapneel Amit Pathak^1,5, David Cortés Ortuño⁶, Marijan Beg^7,1, and Hans Fangohr^1,5,8

¹ Faculty of Engineering and Physical Sciences, University of Southampton, Southampton SO17 1BJ, UK
² Department of Physics, University of Warwick, Coventry CV4 7AL, UK
³ Department of Materials Science and Metallurgy, University of Cambridge, Cambridge, CB3 0FS, United Kingdom
⁴ Department of Physics, Durham University, Durham, DH1 3LE, United Kingdom
⁵ Max Planck Institute for the Structure and Dynamics of Matter, Luruper Chaussee 149, 22761 Hamburg, Germany
⁶ Paleomagnetic Laboratory Fort Hoofddijk, Utrecht University, Utrecht, 3584 CD, Netherlands
⁷ Department of Earth Science and Engineering, Imperial College London, London SW7 2AZ, UK
⁸ Center for Free-Electron Laser Science, Luruper Chaussee 149, 22761 Hamburg, Germany

Description	Badge
Tests
Linting
Releases
Coverage
Documentation
YouTube
Binder
Platforms
Downloads
License
DOI

About

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

• simulations of experimental techniques perfomed on magnetisation textures,
• the ability to perform "virtual" experiments,
• the functionality to compare of real experimental results agaist simulated experiments.

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. Samuel Holt, Martin Lang, James Loudon, Thomas Hicken, Swapneel Amit Pathak, David Cortés Ortuño, Marijan Beg, and Hans Fangohr. mag2exp: Simulate experimental measurements for magnetic materials DOI: 10.5281/zenodo.3539461 (2023).

Acknowledgements

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

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