Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Python package for definition, reading, and visualisation of finite difference fields.

Project description

discretisedfield

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

Description Badge
Release PyPI version
Anaconda-Server Badge
Build Build Status
Build status
Coverage codecov
Documentation Documentation Status
Binder Binder
Platforms Platforms
Downloads Downloads
License License

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. DOI will be available soon

Acknowledgements

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for discretisedfield, version 0.8.6
Filename, size File type Python version Upload date Hashes
Filename, size discretisedfield-0.8.6-py3-none-any.whl (37.8 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size discretisedfield-0.8.6.tar.gz (34.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page