Skip to main content

Python interface to OOMMF integrated into Jupyter notebook.

Project description

oommfc

Marijan Beg1,2, Ryan A. Pepper2, Thomas Kluyver1, and Hans Fangohr1,2

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

Description Badge
Latest release PyPI version
Anaconda-Server Badge
Build Build Status
Build status
Coverage codecov
Documentation Documentation Status
Binder Binder
Platforms Platforms
Downloads Downloads
License License

About

oommfc is a Python package that provides:

  • An interface to the Object Oriented MicroMagnetic Framework OOMMF

  • Integration of OOMMF simulations into the Jupyter notebook

It is available on all major operating systems (Windows, MacOS, Linux) and requires Python 3.6 or higher.

Installation, testing, and upgrade

We support installation using conda package manager. Instructions can be found here.

Binder

This package can be used in the cloud via Binder. This does not require you to have anything installed and no files will be created on your machine. To access Binder, use this link.

Documentation

Documentation is available here, where APIs and tutorials as Jupyter notebooks are available.

Support

If you require support or have any questions, you are welcome to raise an issue in our 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 in your research, 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. DOI will be available soon

Acknowledgements

Developed as a part of OpenDreamKit – Horizon 2020 European Research Infrastructure project (676541).

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

oommfc-0.8.12.tar.gz (30.4 kB view details)

Uploaded Source

Built Distribution

oommfc-0.8.12-py3-none-any.whl (73.5 kB view details)

Uploaded Python 3

File details

Details for the file oommfc-0.8.12.tar.gz.

File metadata

  • Download URL: oommfc-0.8.12.tar.gz
  • Upload date:
  • Size: 30.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.7.4

File hashes

Hashes for oommfc-0.8.12.tar.gz
Algorithm Hash digest
SHA256 365f43bd20459759e240d31eb6c68e7a3fa177fe0a5861b393ef8f97bc76df62
MD5 36c97bf084f0eb41fffd4f74a23187b6
BLAKE2b-256 046c1878bd46152a9911acb8083334abb218496aa5d1d81cabd4fb7b463a0191

See more details on using hashes here.

File details

Details for the file oommfc-0.8.12-py3-none-any.whl.

File metadata

  • Download URL: oommfc-0.8.12-py3-none-any.whl
  • Upload date:
  • Size: 73.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.7.4

File hashes

Hashes for oommfc-0.8.12-py3-none-any.whl
Algorithm Hash digest
SHA256 459851d70de2f7682674de87c5149ef3dff9df6038147a9ca0d16056362f130a
MD5 853dd9f9bbfd066ae741a81d51fae0d0
BLAKE2b-256 f2ced8b3ee2e3a2891264e4e82640c95bc9dfe165845a48fea51ed1d3de7c3ad

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