Skip to main content

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

Project description

discretisedfield

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

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

About

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

  • visualisation using matplotlib and k3d.

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

Documentation

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.

Binder

This package can be used in the cloud via Binder. To access Binder, use the Binder badge in the table above.

Support

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.

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, 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 the analysis and visualisation of finite difference fields. Zenodo. DOI: 10.5281/zenodo.3539461 (2020).

Acknowledgements

  • OpenDreamKit – Horizon 2020 European Research Infrastructure project (676541)

  • EPSRC Programme grant on Skyrmionics (EP/N032128/1).

Project details


Download files

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

Source Distribution

discretisedfield-0.8.12.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

discretisedfield-0.8.12-py3-none-any.whl (1.9 MB view details)

Uploaded Python 3

File details

Details for the file discretisedfield-0.8.12.tar.gz.

File metadata

  • Download URL: discretisedfield-0.8.12.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0.post20200518 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3

File hashes

Hashes for discretisedfield-0.8.12.tar.gz
Algorithm Hash digest
SHA256 6a5a56297b0121e28a28400e30877c3232178ef3810d859564077ccbb85b80dc
MD5 7afe79c63b424b6f4091a9f6e3003535
BLAKE2b-256 d5ab10ea8eb3629286beb3afa55ea7a6bc2d8523ef43bec511b37a5d223895f6

See more details on using hashes here.

File details

Details for the file discretisedfield-0.8.12-py3-none-any.whl.

File metadata

  • Download URL: discretisedfield-0.8.12-py3-none-any.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0.post20200518 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3

File hashes

Hashes for discretisedfield-0.8.12-py3-none-any.whl
Algorithm Hash digest
SHA256 3ab86cfa76f0279adb1c446a1f0f082ff35839e5056083896805e3e2f773af7f
MD5 a81e2eeed3ea4650ebc7387399e163d2
BLAKE2b-256 204f18f159e08c4929c0cefc3b4ccf621be4991d08100ca0af11532f2387188e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page