Skip to content

Repository files navigation

mag2exp

Samuel Holt1, James Loudon2, Thomas Hicken3, David Cortés Ortuño4, Martin Lang4, Marijan Beg5,4, Hans Fangohr4,6,7

1Department of Physics, University of Warwick, Coventry CV4 7AL, UK
2Department of Materials Science and Metallurgy, University of Cambridge, Cambridge, CB3 0FS, United Kingdom
3Department of Physics, Durham University, Durham, DH1 3LE, United Kingdom
4Faculty of Engineering and Physical Sciences, University of Southampton, Southampton SO17 1BJ, UK
5Department of Earth Science and Engineering, Imperial College London, London SW7 2AZ, UK
6Max Planck Institute for the Structure and Dynamics of Matter, Luruper Chaussee 149, 22761 Hamburg, Germany
7Center for Free-Electron Laser Science, Luruper Chaussee 149, 22761 Hamburg, Germany

DescriptionBadge
TestsBuild status
conda
ReleasesPyPI version
Anaconda-Server Badge
Coveragecodecov
DocumentationDocumentation
YouTubeYouTube
BinderBinder
PlatformsPlatforms
DownloadsDownloads
LicenseLicense
DOIDOI

About

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

  • simulations of experimental techniques perfomed on magnetisation textures,
  • the ability to perform "virtual" experiments,
  • the functionality to compare of real experimental results agaist simulated experiments.

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 (2021).

  2. M. Beg, R. A. Pepper, and H. Fangohr. User interfaces for computational science: A domain specific language for OOMMF embedded in Python. AIP Advances7, 56025 (2017).

  3. Samuel Holt, James Loudon, Thomas Hicken, David Cortés Ortuño, Martin Lang, Marijan Beg, Hans Fangohr. mag2exp: Simulate experimental measurements for magnetic materials DOI: 10.5281/zenodo.3539461 (2021).

Acknowledgements

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

  • EPSRC Programme Grant on Skyrmionics (EP/N032128/1)

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages