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 |  |
 |
|
| Build |  |
 |
|
| Coverage |  |
| Documentation |  |
| Binder |  |
| Platforms |  |
| Downloads |  |
| License |  |
| DOI |  |
About
This Python package provides:
- Definition of finite difference meshes and fields
- Reading and writing of different file types, such as
.ovf,.vtk, and.hdf5 - Visualisation of finite difference meshes and fields using
matplotlibandk3d
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:
-
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).
-
M. Beg, R. A. Pepper, T. Kluyver, and H. Fangohr. ubermag/discretisedfield: Python package for definition, reading, and visualisation of finite difference fields. Zenodo. http://doi.org/10.5281/zenodo.3539461 (2019).
Acknowledgements
Developed as a part of OpenDreamKit – Horizon 2020 European Research Infrastructure project (676541).
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file discretisedfield-0.8.8.tar.gz.
File metadata
- Download URL: discretisedfield-0.8.8.tar.gz
- Upload date:
- Size: 63.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.7.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a2061539ef48b294e9d73abdbbab6ef21db2d9ea79456d5ac59571417477ea88 |
|
| MD5 | a91cd5f7d975c2a464ca4c8e21851a19 |
|
| BLAKE2b-256 | db96307d16ca7ca53dd8d3d82bd66c24f150f06054b2ad8eedaeb8b27354b640 |
File details
Details for the file discretisedfield-0.8.8-py3-none-any.whl.
File metadata
- Download URL: discretisedfield-0.8.8-py3-none-any.whl
- Upload date:
- Size: 69.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.7.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9bff808befe9a9ac740880d2bc03e5ef9f25ab2646973c17466bc4ffb1ddfd44 |
|
| MD5 | 4967755d46a82fa682b11450cd733eb7 |
|
| BLAKE2b-256 | d09402eaaacb0ea5f23f603c3d9a1f74106361788195eee4b3d7fe3b5e591061 |
