ubermag / micromagnetictests

Testing package for computational magnetism tools.

ubermag

Marijan Beg^1,2, Martin Lang², Samuel Holt^2,3, Swapneel Amit Pathak^2,4, Ryan A. Pepper⁵, Thomas Kluyver⁶, Jeroen Mulkers⁷, Jonathan Leliaert⁷, and Hans Fangohr^2,4,8

¹ Department of Earth Science and Engineering, Imperial College London, London SW7 2AZ, UK
² Faculty of Engineering and Physical Sciences, University of Southampton, Southampton SO17 1BJ, UK
³ Department of Physics, University of Warwick, Coventry CV4 7AL, UK
⁴ Max Planck Institute for the Structure and Dynamics of Matter, Luruper Chaussee 149, 22761 Hamburg, Germany
⁵ Research Software Group, University of Birmingham, Birmingham B15 2TT, UK
⁶ European XFEL GmbH, Holzkoppel 4, 22869 Schenefeld, Germany
⁷ Faculty of Sciences, Ghent University, Krijgslaan 281, S12, 9000 Ghent, Belgium
⁸ 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

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

• Meta package for Ubermag project,

• Logging control in Ubermag packages.

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, Ryan A. Pepper, Thomas Kluyver, Jeroen Mulkers, Jonathan Leliaert, and Hans Fangohr. ubermag: Meta package for Ubermag project. DOI: 10.5281/zenodo.3539495 (2022).

Acknowledgements

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

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

micromagnetictests's Issues

Update notebooks

Use new discretisedfield syntax

Test results should be compared for all test

For many tests we just test if the simulation runs. We should test the resulting values (with certain accuracy) to better detect changes/failures.

Improve test_schedule

The test for scheduling (schedule.py::test_schedule) currently does not run on Windows due to limitations of the implementation. We should modify the test so that it can run on all platforms. I would suggest to use python as executable instead of oommf. Needs to be tested on Windows.

Tests should write to temporary directories provided by pytest