Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ubermag/mag2exp


https://github.com/ubermag/mag2exp

Last synced: 4 months ago
JSON representation

Awesome Lists containing this project

README 

          
# mag2exp



[Samuel Holt](https://github.com/samjrholt)1,2, [Martin Lang](https://github.com/lang-m)1, James Loudon3, Thomas Hicken4, [Swapneel Amit Pathak](https://github.com/swapneelap)1,5, [David Cortés Ortuño](https://github.com/davidcortesortuno)6, [Marijan Beg](https://github.com/marijanbeg)7,1, and [Hans Fangohr](https://github.com/fangohr)1,5,8



1 *Faculty of Engineering and Physical Sciences, University of Southampton, Southampton SO17 1BJ, UK*  

2 *Department of Physics, University of Warwick, Coventry CV4 7AL, UK*  

3 *Department of Materials Science and Metallurgy, University of Cambridge, Cambridge, CB3 0FS, United Kingdom*  

4 *Department of Physics, Durham University, Durham, DH1 3LE, United Kingdom*  

5 *Max Planck Institute for the Structure and Dynamics of Matter, Luruper Chaussee 149, 22761 Hamburg, Germany*  

6 *Paleomagnetic Laboratory Fort Hoofddijk, Utrecht University, Utrecht, 3584 CD, Netherlands*  

7 *Department of Earth Science and Engineering, Imperial College London, London SW7 2AZ, UK*  

8 *Center for Free-Electron Laser Science, Luruper Chaussee 149, 22761 Hamburg, Germany*  



| Description | Badge |

| --- | --- |

| Tests | [![tests](https://github.com/ubermag/mag2exp/actions/workflows/test.yml/badge.svg)](https://github.com/ubermag/mag2exp/actions/workflows/test.yml) |

| Linting | [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ubermag/mag2exp/master.svg)](https://results.pre-commit.ci/latest/github/ubermag/mag2exp/master) |

|         | [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) |

| Releases | [![PyPI version](https://badge.fury.io/py/mag2exp.svg)](https://badge.fury.io/py/mag2exp) |

|          | [![Anaconda-Server Badge](https://anaconda.org/conda-forge/mag2exp/badges/version.svg)](https://anaconda.org/conda-forge/mag2exp) |

| Coverage | [![codecov](https://codecov.io/gh/ubermag/mag2exp/branch/master/graph/badge.svg?token=hcK4fofmrL)](https://codecov.io/gh/ubermag/mag2exp) |

| Documentation | [![Documentation](https://img.shields.io/badge/Docs-ubermag.github.io-blue)](https://ubermag.github.io/documentation/mag2exp.html) |

| YouTube | [![YouTube](https://img.shields.io/badge/YouTube-ubermag-blue)](https://www.youtube.com/channel/UC7MSqVQSMFV42R1jAYmKGLg) |

| Binder | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ubermag/mag2exp/latest?urlpath=lab/tree/docs) |

| Platforms | [![Platforms](https://anaconda.org/conda-forge/mag2exp/badges/platforms.svg)](https://anaconda.org/conda-forge/mag2exp) |

| Downloads | [![Downloads](https://anaconda.org/conda-forge/mag2exp/badges/downloads.svg)](https://anaconda.org/conda-forge/mag2exp) |

| License | [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) |

| DOI | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5564954.svg)](https://doi.org/10.5281/zenodo.5564954) |



## 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](https://ubermag.github.io/installation.html).



## 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](https://www.youtube.com/channel/UC7MSqVQSMFV42R1jAYmKGLg).



## 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](https://github.com/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](https://github.com/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](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](https://doi.org/10.1109/TMAG.2021.3078896) (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](http://aip.scitation.org/doi/10.1063/1.4977225) (2017).



3. Samuel Holt, Martin Lang, James Loudon, Thomas Hicken, Swapneel Amit Pathak, David Cortés Ortuño, Marijan Beg, and Hans Fangohr. mag2exp: Simulate experimental measurements for magnetic materials DOI: [10.5281/zenodo.5564954](http://doi.org/10.5281/zenodo.5564954) (2025).



## Acknowledgements



- [OpenDreamKit](http://opendreamkit.org/) – Horizon 2020 European Research Infrastructure project (676541)



- EPSRC Programme Grant on [Skyrmionics](http://www.skyrmions.ac.uk) (EP/N032128/1)