https://github.com/ubermag/ubermagutil

Utility package used across Ubermag.
https://github.com/ubermag/ubermagutil

anaconda binder bsd-3-clause docs documentation-tool epsrc horizon2020 jupyter linux macos micromagnetics pypi python scientific-computing si-units typesystem ubermag units windows zenodo

Last synced: 4 months ago
JSON representation

Utility package used across Ubermag.

• Host: GitHub
• URL: https://github.com/ubermag/ubermagutil
• Owner: ubermag
• License: bsd-3-clause
• Created: 2016-10-04T13:20:30.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2025-10-20T23:21:24.000Z (4 months ago)
• Last Synced: 2025-10-21T20:57:15.017Z (4 months ago)
• Topics: anaconda, binder, bsd-3-clause, docs, documentation-tool, epsrc, horizon2020, jupyter, linux, macos, micromagnetics, pypi, python, scientific-computing, si-units, typesystem, ubermag, units, windows, zenodo
• Language: Python
• Homepage: http://ubermag.github.io
• Size: 354 KB
• Stars: 5
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ubermagutil

[Marijan Beg](https://github.com/marijanbeg)1,2, [Martin Lang](https://github.com/lang-m)2, [Samuel Holt](https://github.com/samjrholt)2,3, [Swapneel Amit Pathak](https://github.com/swapneelap)2,4, and [Hans Fangohr](https://github.com/fangohr)2,4,5

1 *Department of Earth Science and Engineering, Imperial College London, London SW7 2AZ, UK*  

2 *Faculty of Engineering and Physical Sciences, University of Southampton, Southampton SO17 1BJ, UK*  

3 *Department of Physics, University of Warwick, Coventry CV4 7AL, UK*  

4 *Max Planck Institute for the Structure and Dynamics of Matter, Luruper Chaussee 149, 22761 Hamburg, Germany*  

5 *Center for Free-Electron Laser Science, Luruper Chaussee 149, 22761 Hamburg, Germany*  

| Description | Badge |

| --- | --- |

| Tests | [![tests](https://github.com/ubermag/ubermagutil/actions/workflows/test.yml/badge.svg)](https://github.com/ubermag/ubermagutil/actions/workflows/test.yml) |

| Linting | [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ubermag/ubermagutil/master.svg)](https://results.pre-commit.ci/latest/github/ubermag/ubermagutil/master) |

|         | [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) |

| Releases | [![PyPI version](https://badge.fury.io/py/ubermagutil.svg)](https://badge.fury.io/py/ubermagutil) |

|          | [![Anaconda-Server Badge](https://anaconda.org/conda-forge/ubermagutil/badges/version.svg)](https://anaconda.org/conda-forge/ubermagutil) |

| Coverage | [![codecov](https://codecov.io/gh/ubermag/ubermagutil/branch/master/graph/badge.svg?token=hcK4fofmrL)](https://codecov.io/gh/ubermag/ubermagutil) |

| Documentation | [![Documentation](https://img.shields.io/badge/Docs-ubermag.github.io-blue)](https://ubermag.github.io/documentation/ubermagutil.html) |

| YouTube | [![YouTube](https://img.shields.io/badge/YouTube-ubermag-blue)](https://www.youtube.com/channel/UC7MSqVQSMFV42R1jAYmKGLg) |

| Binder | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ubermag/ubermagutil/latest?urlpath=lab/tree/docs) |

| Platforms | [![Platforms](https://anaconda.org/conda-forge/ubermagutil/badges/platforms.svg)](https://anaconda.org/conda-forge/ubermagutil) |

| Downloads | [![Downloads](https://anaconda.org/conda-forge/ubermagutil/badges/downloads.svg)](https://anaconda.org/conda-forge/ubermagutil) |

| License | [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) |

| DOI | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3539489.svg)](https://doi.org/10.5281/zenodo.3539489) |

## 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](https://ubermag.github.io/installation.html).

## 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](https://www.youtube.com/channel/UC7MSqVQSMFV42R1jAYmKGLg).

## 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](https://github.com/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](https://github.com/ubermag/help) repository, and we are going to help you get started and assist you on the way.

**Contributors**:

- [Thomas Kluyver](https://github.com/takluyver)

- [Natalie Downing](https://github.com/gamdow)

## License

Licensed under the BSD 3-Clause "New" or "Revised" License. For details, please refer to the [LICENSE](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](https://doi.org/10.1109/TMAG.2021.3078896) (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](http://aip.scitation.org/doi/10.1063/1.4977225) (2017).

3. Marijan Beg, Martin Lang, Samuel Holt, Swapneel Amit Pathak, and Hans Fangohr. ubermagutil: Utility package used across Ubermag. DOI: [10.5281/zenodo.3539489](http://doi.org/10.5281/zenodo.3539489) (2025).

## Acknowledgements

- [OpenDreamKit](http://opendreamkit.org/) – Horizon 2020 European Research Infrastructure project (676541)

- EPSRC Programme Grant on [Skyrmionics](http://www.skyrmions.ac.uk) (EP/N032128/1)