ubermagutil

Marijan Beg^1,2, Martin Lang², Samuel Holt^2,3, Swapneel Amit Pathak^2,4, and Hans Fangohr^2,4,5

¹ 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
⁵ 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

ubermagutil is a Python package, integrated with Jupyter, 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:

License

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

How to cite

M. Beg, M. Lang, and H. Fangohr. Ubermag: Towards more effective micromagnetic workflows. IEEE Transactions on Magnetics 58, 7300205 (2022).
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).
Marijan Beg, Martin Lang, Samuel Holt, Swapneel Amit Pathak, and Hans Fangohr. ubermagutil: Utility package used across Ubermag. DOI: 10.5281/zenodo.3539489 (2025).

Acknowledgements

OpenDreamKit – Horizon 2020 European Research Infrastructure project (676541)
EPSRC Programme Grant on Skyrmionics (EP/N032128/1)

Metadata

Release files for ubermagutil 0.64.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ubermagutil 0.64.0
File	Size	Uploaded
ubermagutil-0.64.0.tar.gz	18.7 kB	Jun 1, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for ubermagutil 0.64.0
File	Interpreter	ABI	Platform	Reset
ubermagutil-0.64.0-py3-none-any.whl 19.3 kB Jun 1, 2025	Python 3	none	any	Details

Total release size: 38.0 kB

Release files / ubermagutil-0.64.0.tar.gz

Download URL	ubermagutil-0.64.0.tar.gz
Size	18.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`5441c9eef560b087247151073191c28cfd5a2762d823b1392458e45476073c6e`
BLAKE2b-256 checksum How to use checksums	`4759294c35b33d58353246d983b770a15ba7d3013f21975234e12e8bf3b723a2`
Upload date	Jun 1, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.12.9`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/ubermag/ubermagutil
Publishing commit: github.com/ubermag/ubermagutil/tree/7c4bd0fabfc2be78ae3c9d7185301fc05dec5064

Workflow

Publishing configuration: github.com/ubermag/ubermagutil/blob/7c4bd0fabfc2be78ae3c9d7185301fc05dec5064/.github/workflows/publish.yml
Publishing logs: github.com/ubermag/ubermagutil/actions/runs/15376731344/attempts/1

Artifact

Subject: ubermagutil-0.64.0.tar.gz
SHA-256 checksum: 5441c9eef560b087247151073191c28cfd5a2762d823b1392458e45476073c6e Verifying attestations

Release files / ubermagutil-0.64.0-py3-none-any.whl

Download URL	ubermagutil-0.64.0-py3-none-any.whl
Size	19.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`726a1831b7ade3b1fb262057ace96e76b579eb9f8bd99cf2ae97ebbf0d6938dc`
BLAKE2b-256 checksum How to use checksums	`2b3e754345711d66c29e9636db2e9a0d379a30b19fbd6b6aea102d48a427fee8`
Upload date	Jun 1, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.12.9`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/ubermag/ubermagutil
Publishing commit: github.com/ubermag/ubermagutil/tree/7c4bd0fabfc2be78ae3c9d7185301fc05dec5064

Workflow

Publishing configuration: github.com/ubermag/ubermagutil/blob/7c4bd0fabfc2be78ae3c9d7185301fc05dec5064/.github/workflows/publish.yml
Publishing logs: github.com/ubermag/ubermagutil/actions/runs/15376731344/attempts/1

Artifact

Subject: ubermagutil-0.64.0-py3-none-any.whl
SHA-256 checksum: 726a1831b7ade3b1fb262057ace96e76b579eb9f8bd99cf2ae97ebbf0d6938dc Verifying attestations