Marijan Beg1,2, Ryan A. Pepper1, Thomas Kluyver2, and Hans Fangohr1,2
1 Faculty of Engineering and Physical Sciences, University of Southampton, Southampton SO17 1BJ, United Kingdom
2 European XFEL GmbH, Holzkoppel 4, 22869 Schenefeld, Germany
discretisedfield is a Python package that provides:
definition of finite difference regions, meshes, and fields,
analysis of finite difference fields,
reading and writing of different file types (OVF, VTK, and HDF5), and
It is available on Windows, MacOS, and Linux. It requires Python 3.6+.
APIs and tutorials are available in documentation. To access them, use the documentation badge in the table above.
Installation, testing, and upgrade
We recommend installation using
conda package manager. Instructions can be found in the documentation.
This package can be used in the cloud via Binder. To access Binder, use the Binder badge in the table above.
If you require support, have questions, want to report a bug, or want to suggest an improvement, please raise an issue in ubermag/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 this package, 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).
M. Beg, R. A. Pepper, T. Kluyver, and H. Fangohr. ubermag/discretisedfield: Python package for the analysis and visualisation of finite difference fields. Zenodo. DOI: 10.5281/zenodo.3539461 (2020).