discretisedfield

Marijan Beg^1,2, Ryan A. Pepper², Thomas Kluyver¹, and Hans Fangohr^1,2

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

Description	Badge
Release
Build
Coverage
Documentation
Binder
Platforms
Downloads
License
DOI

About

This Python package provides:

• Definition of finite difference meshes and fields
• Reading and writing of different file types, such as .ovf and .vtk
• Visualisation of finite difference meshes and fields using matplotlib and k3d

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.

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. M. Beg, R. A. Pepper, T. Kluyver, and H. Fangohr. ubermag/discretisedfield: Python package for definition, reading, and visualisation of finite difference fields. Zenodo. http://doi.org/10.5281/zenodo.3539461 (2019).

Acknowledgements

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