Skip to main content

Python utilities package used across most of Ubermag packages.

Project description

ubermagutil

Marijan Beg1,2 and Hans Fangohr1,2

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

Description Badge
Releases PyPI version
Anaconda-Server Badge
Builds Build Status
Build status
Coverage codecov
Documentation Documentation Status
Binder Binder
Platforms Platforms
Downloads Downloads
License License
DOI DOI

About

ubermagutil is a Python package used across Ubermag. It provides:

  • definition of typesystem descriptors and decorators,

  • documentation inheritance decorators, and

  • determining SI prefixes.

It is available on Windows, MacOS, and Linux. It requires Python 3.6+.

Documentation

APIs and tutorials are available in documentation. To access them, use the documentation 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 Binder badge in the table above.

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.

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 this package, 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. M. Beg and H. Fangohr. ubermag/ubermagutil: Python utilities package used across Ubermag. Zenodo. DOI: 10.5281/zenodo.3539490 (2020).

Acknowledgements

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

  • EPSRC Programme grant on Skyrmionics (EP/N032128/1).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ubermagutil-0.2.6.tar.gz (13.3 kB view details)

Uploaded Source

Built Distribution

ubermagutil-0.2.6-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file ubermagutil-0.2.6.tar.gz.

File metadata

  • Download URL: ubermagutil-0.2.6.tar.gz
  • Upload date:
  • Size: 13.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0.post20200518 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3

File hashes

Hashes for ubermagutil-0.2.6.tar.gz
Algorithm Hash digest
SHA256 c15729ec3f48d3e19f284ff42d9e79c1339e3d5a2e0b9ce2fbbce16026720c62
MD5 b9d0fc155a30a20d8255be85cff7880d
BLAKE2b-256 390b2fca5f424d326715df07626b4e7528ecc230535be73a96bcc37ac417254d

See more details on using hashes here.

File details

Details for the file ubermagutil-0.2.6-py3-none-any.whl.

File metadata

  • Download URL: ubermagutil-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0.post20200518 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3

File hashes

Hashes for ubermagutil-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 101a96b922ca7878ce3cda3cbd7fd9ffe721a4a2f44478bd9e137f55242759dd
MD5 86e99f5338ff965ef917beffe846a352
BLAKE2b-256 457c1bf05a52bfeda7d94700992ad9ebe8eee31c4bd7ae64e5ff3b9494cd0347

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page