oommfc

Marijan Beg^1,2, Martin Lang², Ryan A. Pepper³, Thomas Kluyver⁴, Samuel Holt^2,5, Swapneel Amit Pathak^2,6, and Hans Fangohr^2,6,7

¹ 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
³ Research Software Group, University of Birmingham, Birmingham B15 2TT, UK
⁴ European XFEL GmbH, Holzkoppel 4, 22869 Schenefeld, Germany
⁵ 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

oommfc is a Python package, integrated with Jupyter, providing:

An Object Oriented MicroMagnetic Framework OOMMF calculator for computational magnetism models defined with micromagneticmodel.

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, Ryan A. Pepper, Thomas Kluyver, Samuel Holt, Swapneel Amit Pathak, and Hans Fangohr. oommfc: OOMMF calculator. DOI: 10.5281/zenodo.3539461 (2025).

Acknowledgements

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

Metadata

Release files for oommfc 0.66.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 oommfc 0.66.0
File	Size	Uploaded
oommfc-0.66.0.tar.gz	31.6 kB	Jun 1, 2025	Details

Built distribution (wheel)

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

Total release size: 71.2 kB

Release files / oommfc-0.66.0.tar.gz

Download URL	oommfc-0.66.0.tar.gz
Size	31.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`55772b9cb609bd54a2aeef3aa4620e64450a8546959c18755f764d8eb96ba644`
BLAKE2b-256 checksum How to use checksums	`bf85ac543f9d3ce3c038254ce09533adccb257dc171665315951e713548f3b09`
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/oommfc
Publishing commit: github.com/ubermag/oommfc/tree/29714ad03f470c5d80363f1ce2158d570443088d

Workflow

Publishing configuration: github.com/ubermag/oommfc/blob/29714ad03f470c5d80363f1ce2158d570443088d/.github/workflows/publish.yml
Publishing logs: github.com/ubermag/oommfc/actions/runs/15377374256/attempts/1

Artifact

Subject: oommfc-0.66.0.tar.gz
SHA-256 checksum: 55772b9cb609bd54a2aeef3aa4620e64450a8546959c18755f764d8eb96ba644 Verifying attestations

Release files / oommfc-0.66.0-py3-none-any.whl

Download URL	oommfc-0.66.0-py3-none-any.whl
Size	39.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`7b7f0d891a4695d1057c24ad3ca7f00b9f8dc87c4f807f799645567aec6935d0`
BLAKE2b-256 checksum How to use checksums	`4fc10ff85cf8882fa15af38f8d4ac8778562f1634be77c7bee336b9203c92927`
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/oommfc
Publishing commit: github.com/ubermag/oommfc/tree/29714ad03f470c5d80363f1ce2158d570443088d

Workflow

Publishing configuration: github.com/ubermag/oommfc/blob/29714ad03f470c5d80363f1ce2158d570443088d/.github/workflows/publish.yml
Publishing logs: github.com/ubermag/oommfc/actions/runs/15377374256/attempts/1

Artifact

Subject: oommfc-0.66.0-py3-none-any.whl
SHA-256 checksum: 7b7f0d891a4695d1057c24ad3ca7f00b9f8dc87c4f807f799645567aec6935d0 Verifying attestations