Skip to main content

Python package for the analysis and visualisation of finite-difference fields.

Project description

discretisedfield

Marijan Beg1,2, Martin Lang2, Samuel Holt2,3, Swapneel Amit Pathak2,4, Ryan A. Pepper5, and Hans Fangohr2,4,6

1 Department of Earth Science and Engineering, Imperial College London, London SW7 2AZ, UK
2 Faculty of Engineering and Physical Sciences, University of Southampton, Southampton SO17 1BJ, UK
3 Department of Physics, University of Warwick, Coventry CV4 7AL, UK
4 Max Planck Institute for the Structure and Dynamics of Matter, Luruper Chaussee 149, 22761 Hamburg, Germany
5 Research Software Group, University of Birmingham, Birmingham B15 2TT, UK
6 Center for Free-Electron Laser Science, Luruper Chaussee 149, 22761 Hamburg, Germany

Description Badge
Tests tests
Linting pre-commit.ci status
Code style: black
Releases PyPI version
Anaconda-Server Badge
Coverage codecov
Documentation Documentation
YouTube YouTube
Binder Binder
Platforms Platforms
Downloads Downloads
License License
DOI DOI

About

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+.

Documentation

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.

Binder

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

YouTube

YouTube video tutorials are available on the Ubermag channel.

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.

Contributions

All contributions are welcome, however small they are. If you would like to contribute, please fork the repository and create a pull request. If you are not sure how to contribute, please contact us by raising an issue in ubermag/help repository, and we are going to help you get started and assist you on the way.

Contributors:

License

Licensed under the BSD 3-Clause "New" or "Revised" License. For details, please refer to the LICENSE file.

How to cite

  1. M. Beg, M. Lang, and H. Fangohr. Ubermag: Towards more effective micromagnetic workflows. IEEE Transactions on Magnetics 58, 7300205 (2022).

  2. 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).

  3. Marijan Beg, Martin Lang, Samuel Holt, Swapneel Amit Pathak, Ryan A. Pepper, and Hans Fangohr. discretisedfield: Python package for the analysis and visualisation of finite-difference fields. DOI: 10.5281/zenodo.3539461 (2025).

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.92.0.tar.gz (2.4 MB view details)

Uploaded Source

Built Distribution

discretisedfield-0.92.0-py3-none-any.whl (2.4 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: discretisedfield-0.92.0.tar.gz
  • Upload date:
  • Size: 2.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for discretisedfield-0.92.0.tar.gz
Algorithm Hash digest
SHA256 c540ff2c68bf24555fbaca64cadc1d383f447f6510740aac400c887cb7526588
MD5 484c3411e8e038eda29fe7c30e34ae22
BLAKE2b-256 ec2511569b80a1a93b3a395f0138e6c4c57212b1309525142fb7c0ea948cb849

See more details on using hashes here.

Provenance

The following attestation bundles were made for discretisedfield-0.92.0.tar.gz:

Publisher: publish.yml on ubermag/discretisedfield

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for discretisedfield-0.92.0-py3-none-any.whl
Algorithm Hash digest
SHA256 66fca774a77565e06cbc6074aba55adb49ebc6f854b65d99a54345b1f4576935
MD5 0105c842ae00300a840b5855cca967e7
BLAKE2b-256 10987675e6cadcb5debdfe7909af3947870761522da9bd189b7488a0880598e1

See more details on using hashes here.

Provenance

The following attestation bundles were made for discretisedfield-0.92.0-py3-none-any.whl:

Publisher: publish.yml on ubermag/discretisedfield

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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