ubermagutil

Marijan Beg^1,2, Thomas Kluyver¹, and Hans Fangohr^1,2

¹ European XFEL GmbH, Holzkoppel 4, 22869 Schenefeld, Germany
² Faculty of Engineering and Physical Sciences, University of Southampton, Southampton SO17 1BJ, United Kingdom

Description	Badge
Release
Build
Coverage
Documentation
Binder
Platforms
Dependecies
Downloads
License

About

ubermagutil is a Python package that provides:

• Definitions of descriptors and the typesystem decorator used in Ubermag packages

It is available on all major operating systems (Windows, MacOS, Linux) and requires Python 3.6 or higher.

Installation, testing, and upgrade

We support installation using conda and pip package managers. Instructions can be found here.

Binder

ubermagutil can be used in the cloud via Binder. This does not require you to have anything installed and no files will be created on your machine. To use ubermagutil in the cloud, use this link.

Documentation

Documentation for ubermagutil is available here, where APIs and tutorials (in the form of Jupyter notebooks) are available.

Support

If you require support on installation or usage of ubermagutil or if you want to report a problem, you are welcome to raise an issue in our ubermag/help repository.

License

Licensed under the BSD 3-Clause "New" or "Revised" License. For details, please refer to the LICENSE file.

How to cite

If you use ubermagutil in your research, please cite it as:

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. DOI will be available soon

Acknowledgements

ubermagutil was developed as a part of OpenDreamKit – Horizon 2020 European Research Infrastructure project (676541).