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.11.tar.gz (30.4 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: oommfc-0.8.11.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.11.tar.gz
Algorithm Hash digest
SHA256 ae4941bf358f2e029bc8415ad7a1a13c806058b23428accc780282a9e7eb550c
MD5 99ae1a550339f539aa197ed3ca85a442
BLAKE2b-256 534b895486aa09eae946efed009a8de9c3d65449f3764cb70c9a312ce23ab01c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oommfc-0.8.11-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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 3091914920904ecfd8fc6060ef49ba574e9f3541a56a6a08bb3f6d8b67d9ab1f
MD5 a9924e487fbe6b943d2f0e06f020fcdd
BLAKE2b-256 fbfb8abdfe83bebcd994822eee673e5cf816ca10c8f8b7e06e59ee2214d5bcbb

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