Python package for definition, reading, and visualisation of finite difference fields.
Project description
discretisedfield
Marijan Beg1,2, Ryan A. Pepper1, Thomas Kluyver2, and Hans Fangohr2,1
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 |
|---|---|
| Release |  |
 |
|
| Build |  |
 |
|
| Coverage |  |
| Documentation |  |
| Binder |  |
| Platforms |  |
| Downloads |  |
| License |  |
| 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
matplotlibandk3d.
It is available on all major operating systems (Windows, MacOS, and Linux) and requires Python 3.6 or higher.
Documentation
APIs and tutorials as Jupyter notebooks are available as a part of documentation.
Installation, testing, and upgrade
We support installation using conda and pip package managers. Instructions can be found in the documentation.
Binder
This package can be used in the cloud via Binder. This does not require to have anything installed and no files will be created on your machine. 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:
-
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 the analysis and visualisation of finite difference fields. Zenodo. DOI: 10.5281/zenodo.3539461 (2020).
Acknowledgements
Developed as a part of:
-
OpenDreamKit – Horizon 2020 European Research Infrastructure project (676541)
-
EPSRC Programme grant on Skyrmionics (EP/N032128/1).
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.9.tar.gz.
File metadata
- Download URL: discretisedfield-0.8.9.tar.gz
- Upload date:
- Size: 64.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0.post20200210 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c13767a1093779d4550c0ba2ccabb52d027a9fef937c538435a729c3c13c9c6e |
|
| MD5 | 033ac18eee8e607e7949d0845406b2d1 |
|
| BLAKE2b-256 | 801953e6f45c813a23d57600c8a0933e11962cd3327498a81f430d05dde4ab74 |
File details
Details for the file discretisedfield-0.8.9-py3-none-any.whl.
File metadata
- Download URL: discretisedfield-0.8.9-py3-none-any.whl
- Upload date:
- Size: 71.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0.post20200210 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e1e7d3c753bea7ef4aeb71e19ab2866293950256ce355bc18425ebe0d2fa6105 |
|
| MD5 | a5f6c5aee24129f9944023e5455b76a2 |
|
| BLAKE2b-256 | 12afef33e4b2f027ffa2a727cf5f4e892f87e77bfd926f5ce0f84146f64bf3a7 |
