Skip to main content

Testing package for computational magnetism tools.

Project description

micromagnetictests

Marijan Beg1,2, Martin Lang2, Samuel Holt2,3, Swapneel Amit Pathak2,4, and Hans Fangohr2,4,5

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 Center for Free-Electron Laser Science, Luruper Chaussee 149, 22761 Hamburg, Germany

Description Badge
Tests Build status
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

micromagnetictests is a Python package, integrated with Jupyter, providing:

  • A collection of computational magnetism tests for testing different calculators

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, and Hans Fangohr. micromagnetictests: Testing package for computational magnetism tools. DOI: 10.5281/zenodo.3707736 (2023).

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

micromagnetictests-0.63.2.tar.gz (24.4 kB view details)

Uploaded Source

Built Distribution

micromagnetictests-0.63.2-py3-none-any.whl (38.9 kB view details)

Uploaded Python 3

File details

Details for the file micromagnetictests-0.63.2.tar.gz.

File metadata

  • Download URL: micromagnetictests-0.63.2.tar.gz
  • Upload date:
  • Size: 24.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for micromagnetictests-0.63.2.tar.gz
Algorithm Hash digest
SHA256 c465e462c8b4fde0b902cc43b11168daf80b85081a15e648a5db45c1e7d10c8e
MD5 dd9af73bbc91723fb7d7c19e33710a52
BLAKE2b-256 0ecdfaf296849081e741fcc64ce05125be65caca92f21321cb5cb4eda7af84b9

See more details on using hashes here.

File details

Details for the file micromagnetictests-0.63.2-py3-none-any.whl.

File metadata

File hashes

Hashes for micromagnetictests-0.63.2-py3-none-any.whl
Algorithm Hash digest
SHA256 14d9132e8cad8d59b34862fc8e0f0a22f3dca2a83b9d1065c47b5efd5b00a13b
MD5 ca7461b7598dbaad6de55707c6ec0125
BLAKE2b-256 c60c7225e980622a1ba05018fefb6d187afa84e0051c0789ffdfda451c8d8499

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