ubermagutil

Marijan Beg^1,2 and Hans Fangohr^1,2,3

¹ Faculty of Engineering and Physical Sciences, University of Southampton, Southampton SO17 1BJ, United Kingdom
² European XFEL GmbH, Holzkoppel 4, 22869 Schenefeld, Germany
³ Max Planck Institute for the Structure and Dynamics of Matter, Luruper Chaussee 149, 22761 Hamburg, Germany

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

About

ubermagutil is a Python package used across Ubermag, providing:

• definition of typesystem descriptors and decorators,

• documentation inheritance decorators,

• determining SI prefixes, and

• various convenience functions.

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:

• Thomas Kluyver (@takluyver), European XFEL, Germany
• Natalie Downing (@gamdow), University of Southampton, United Kingdom

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, 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).

2. M. Beg and H. Fangohr. ubermagutil: Utility package used across Ubermag. DOI: 10.5281/zenodo.3539490 (2020).

Acknowledgements

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

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