Marijan Beg1,2, Martin Lang1, Ryan A. Pepper1, Thomas Kluyver1,2, and Hans Fangohr1,2,3

1 Faculty of Engineering and Physical Sciences, University of Southampton, Southampton SO17 1BJ, United Kingdom
2 European XFEL GmbH, Holzkoppel 4, 22869 Schenefeld, Germany
3 Max Planck Institute for the Structure and Dynamics of Matter, Luruper Chaussee 149, 22761 Hamburg, Germany


discretisedfield is a Python package, integrated with Jupyter, providing:

  • definition of finite-difference regions, meshes, lines, and fields,
  • analysis of finite-difference fields,
  • visualisation using matplotlib and k3d, and
  • manipulation of different file types (OVF, VTK, and HDF5).

It is available on Windows, MacOS, and Linux. It requires Python 3.8+.


APIs and tutorials are available in the documentation. To access the documentation, use the 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 badge in the table above.


YouTube video tutorials are available on the Ubermag channel.