Skip to main content

Python utilities package used across all JOOMMF packages.

Project description


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

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

Description Badge
Release PyPI version
Anaconda-Server Badge
Build Build Status
Build status
Coverage codecov
Documentation Documentation Status
Binder Binder
Platforms Platforms
Dependecies Requirements Status
Downloads Downloads
License License


joommfutil is a Python package that provides:

  • Definitions of descriptors and the typesystem decorator used in JOOMMF packages

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 and pip package managers. Instructions can be found here.


joommfutil 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 use joommfutil in the cloud, use this link.


Documentation for joommfutil is available here, where APIs and tutorials (in the form of Jupyter notebooks) are available.


If you require support on installation or usage of joommfutil or if you want to report a problem, you are welcome to raise an issue in our joommf/help repository.


Licensed under the BSD 3-Clause "New" or "Revised" License. For details, please refer to the LICENSE file.

How to cite

If you use joommfutil 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


joommfutil was 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.

Files for joommfutil, version 0.8.4
Filename, size File type Python version Upload date Hashes
Filename, size joommfutil-0.8.4-py3-none-any.whl (9.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size joommfutil-0.8.4.tar.gz (10.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page