Meta package for JOOMMF project.
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
joommf is a Python package that is a meta package for Jupyter-OOMMF (JOOMMF) project intended for simple installation of all packages required to run JOOMMF.
It is available on all major operating systems (Windows, MacOS, Linux) and requires Python 3.5 or higher.
We recommend installing
joommf by using either of the
conda package managers.
pip, please make sure you have Python 3.5 or higher on your system. You can check that by running
If you are on Linux, it is likely that you already have Python installed. However, on MacOS and Windows, this is usually not the case. If you do not have Python 3.5 or higher on your machine, we strongly recommend installing the Anaconda Python distribution. Download Anaconda for your operating system and follow instructions on the download page. Further information about installing Anaconda can be found here.
joommf is a Python package used to drive OOMMF. Therefore, OOMMF is a requirement (dependency) of
joommf. If you decide to install
conda, then OOMMF will be automatically installed. However, if you decide to use
joommf installation, we strongly recommend using conda to install OOMMF. You can install OOMMF by running:
conda install --channel conda-forge oommf
Note: Details on how to install Anaconda Python distribution can be found in the
After installing Anaconda on MacOS or Windows,
pip will also be installed. However, on Linux, if you do not already have
pip, you can install it with
sudo apt install python3-pip
To install the
joommf version currently in the Python Package Index repository PyPI on all operating systems run:
python3 -m pip install joommf
joommf is installed using
conda by running
conda install --channel conda-forge joommf
For further information on the
conda package, dependency, and environment management, please have a look at its documentation.
If you used pip to install
joommf, you can update to the latest released version in PyPI by running
python3 -m pip install --upgrade joommf
On the other hand, if you used
conda for installation, update
conda upgrade joommf
The most recent development version of
joommf that is not yet released can be installed/updated with
git clone https://github.com/joommf/joommf python3 -m pip install --upgrade joommf
Note: If you do not have
git on your system, it can be installed by following the instructions here.
joommf 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
joommf in the cloud, follow this link.
joommf is available here, where APIs and tutorials (in the form of Jupyter notebooks) are available.
If you require support on installation or usage of
joommf 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
joommf in your research, please cite it as:
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).
DOI will be available soon
joommf was developed as a part of OpenDreamKit – Horizon 2020 European Research Infrastructure project (676541).
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size & hash SHA256 hash help||File type||Python version||Upload date|
|joommf-0.8.4-py3-none-any.whl (4.9 kB) Copy SHA256 hash SHA256||Wheel||py3|
|joommf-0.8.4.tar.gz (5.7 kB) Copy SHA256 hash SHA256||Source||None|