discretisedfield 0.8.1

Python package for creation, reading, analysis, and plotting of finite difference fields.

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
Latest release
Build
Coverage
Documentation
Dependecies
License

About

discretisedfield is a Python package that provides:

• Creation of finite difference meshes

• Creation, analysis, and plotting of finite difference fields

• Reading and writing of different file types, such as .ovf and .vtk

It is available on all major operating systems (Windows, MacOS, Linux) and requires Python 3.5 or higher.

Installation

We recommend installing discretisedfield by using either of the pip or conda package managers.

Python requirements

Before installing discretisedfield via pip, please make sure you have Python 3.5 or higher on your system. You can check that by running

python3 --version

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.

pip

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 discretisedfield version currently in the Python Package Index repository PyPI on all operating systems run:

python3 -m pip install discretisedfield

conda

discretisedfield is installed using conda by running

conda install --channel conda-forge discretisedfield

For further information on the conda package, dependency, and environment management, please have a look at its documentation.

Updating

If you used pip to install discretisedfield, you can update to the latest released version in PyPI by running

python3 -m pip install --upgrade discretisedfield

On the other hand, if you used conda for installation, update discretisedfield with

conda upgrade discretisedfield

Development version

The most recent development version of discretisedfield that is not yet released can be installed/updated with

git clone https://github.com/joommf/discretisedfield.git
python3 -m pip install --upgrade discretisedfield

Note: If you do not have git on your system, it can be installed by following the instructions here.

Documentation

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

Support

If you require support on installation or usage of discretisedfield or if you want to report a problem, you are welcome to raise an issue in our joommf/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 discretisedfield 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

Acknowledgements

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