{"id":32178528,"url":"https://github.com/ubermag/ubermagutil","last_synced_at":"2025-10-21T20:57:22.310Z","repository":{"id":37406191,"uuid":"69966842","full_name":"ubermag/ubermagutil","owner":"ubermag","description":"Utility package used across Ubermag.","archived":false,"fork":false,"pushed_at":"2025-10-20T23:21:24.000Z","size":363,"stargazers_count":5,"open_issues_count":1,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-10-21T20:57:15.017Z","etag":null,"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"],"latest_commit_sha":null,"homepage":"http://ubermag.github.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ubermag.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2016-10-04T13:20:30.000Z","updated_at":"2025-06-26T07:34:22.000Z","dependencies_parsed_at":"2023-02-17T05:31:22.582Z","dependency_job_id":"5ef9ce1e-f96b-4f6d-be85-73960da3f743","html_url":"https://github.com/ubermag/ubermagutil","commit_stats":{"total_commits":405,"total_committers":13,"mean_commits":"31.153846153846153","dds":0.6666666666666667,"last_synced_commit":"63ca281782737ff65398e603082adc3a712331f1"},"previous_names":[],"tags_count":39,"template":false,"template_full_name":null,"purl":"pkg:github/ubermag/ubermagutil","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubermag%2Fubermagutil","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubermag%2Fubermagutil/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubermag%2Fubermagutil/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubermag%2Fubermagutil/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ubermag","download_url":"https://codeload.github.com/ubermag/ubermagutil/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubermag%2Fubermagutil/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280333501,"owners_count":26312845,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-21T02:00:06.614Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["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"],"created_at":"2025-10-21T20:57:19.339Z","updated_at":"2025-10-21T20:57:22.305Z","avatar_url":"https://github.com/ubermag.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ubermagutil\n\n[Marijan Beg](https://github.com/marijanbeg)\u003csup\u003e1,2\u003c/sup\u003e, [Martin Lang](https://github.com/lang-m)\u003csup\u003e2\u003c/sup\u003e, [Samuel Holt](https://github.com/samjrholt)\u003csup\u003e2,3\u003c/sup\u003e, [Swapneel Amit Pathak](https://github.com/swapneelap)\u003csup\u003e2,4\u003c/sup\u003e, and [Hans Fangohr](https://github.com/fangohr)\u003csup\u003e2,4,5\u003c/sup\u003e\n\n\u003csup\u003e1\u003c/sup\u003e *Department of Earth Science and Engineering, Imperial College London, London SW7 2AZ, UK*  \n\u003csup\u003e2\u003c/sup\u003e *Faculty of Engineering and Physical Sciences, University of Southampton, Southampton SO17 1BJ, UK*  \n\u003csup\u003e3\u003c/sup\u003e *Department of Physics, University of Warwick, Coventry CV4 7AL, UK*  \n\u003csup\u003e4\u003c/sup\u003e *Max Planck Institute for the Structure and Dynamics of Matter, Luruper Chaussee 149, 22761 Hamburg, Germany*  \n\u003csup\u003e5\u003c/sup\u003e *Center for Free-Electron Laser Science, Luruper Chaussee 149, 22761 Hamburg, Germany*  \n\n\n| Description | Badge |\n| --- | --- |\n| Tests | [![tests](https://github.com/ubermag/ubermagutil/actions/workflows/test.yml/badge.svg)](https://github.com/ubermag/ubermagutil/actions/workflows/test.yml) |\n| 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) |\n|         | [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) |\n| Releases | [![PyPI version](https://badge.fury.io/py/ubermagutil.svg)](https://badge.fury.io/py/ubermagutil) |\n|          | [![Anaconda-Server Badge](https://anaconda.org/conda-forge/ubermagutil/badges/version.svg)](https://anaconda.org/conda-forge/ubermagutil) |\n| Coverage | [![codecov](https://codecov.io/gh/ubermag/ubermagutil/branch/master/graph/badge.svg?token=hcK4fofmrL)](https://codecov.io/gh/ubermag/ubermagutil) |\n| Documentation | [![Documentation](https://img.shields.io/badge/Docs-ubermag.github.io-blue)](https://ubermag.github.io/documentation/ubermagutil.html) |\n| YouTube | [![YouTube](https://img.shields.io/badge/YouTube-ubermag-blue)](https://www.youtube.com/channel/UC7MSqVQSMFV42R1jAYmKGLg) |\n| Binder | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ubermag/ubermagutil/latest?urlpath=lab/tree/docs) |\n| Platforms | [![Platforms](https://anaconda.org/conda-forge/ubermagutil/badges/platforms.svg)](https://anaconda.org/conda-forge/ubermagutil) |\n| Downloads | [![Downloads](https://anaconda.org/conda-forge/ubermagutil/badges/downloads.svg)](https://anaconda.org/conda-forge/ubermagutil) |\n| License | [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) |\n| DOI | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3539489.svg)](https://doi.org/10.5281/zenodo.3539489) |\n\n## About\n\n`ubermagutil` is a Python package, integrated with Jupyter, providing:\n\n- definition of typesystem descriptors and decorators,\n\n- documentation inheritance decorators,\n\n- determining SI prefixes, and\n\n- various convenience functions.\n\n\nIt is available on Windows, MacOS, and Linux. It requires Python 3.8+.\n\n## Documentation\n\nAPIs and tutorials are available in the documentation. To access the documentation, use the badge in the table above.\n\n## Installation, testing, and upgrade\n\nWe recommend installation using `conda` package manager. Instructions can be found in the [documentation](https://ubermag.github.io/installation.html).\n\n## Binder\n\nThis package can be used in the cloud via Binder. To access Binder, use the badge in the table above.\n\n## YouTube\n\nYouTube video tutorials are available on the [Ubermag channel](https://www.youtube.com/channel/UC7MSqVQSMFV42R1jAYmKGLg).\n\n## Support\n\nIf 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.\n\n## Contributions\n\nAll 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.\n\n**Contributors**:\n\n- [Thomas Kluyver](https://github.com/takluyver)\n- [Natalie Downing](https://github.com/gamdow)\n\n## License\n\nLicensed under the BSD 3-Clause \"New\" or \"Revised\" License. For details, please refer to the [LICENSE](LICENSE) file.\n\n## How to cite\n\n1. 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).\n\n2. 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).\n\n3. 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).\n\n## Acknowledgements\n\n- [OpenDreamKit](http://opendreamkit.org/) – Horizon 2020 European Research Infrastructure project (676541)\n\n- EPSRC Programme Grant on [Skyrmionics](http://www.skyrmions.ac.uk) (EP/N032128/1)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fubermag%2Fubermagutil","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fubermag%2Fubermagutil","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fubermag%2Fubermagutil/lists"}