Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lemurpwned/cmtj
Simulate multilayer magnetic structures in Python and C++
https://github.com/lemurpwned/cmtj
condensed-phase-simulations electronics llg llgs macrospin magnetics mtj python spintronics stochastic-differential-equations
Last synced: 5 days ago
JSON representation
Simulate multilayer magnetic structures in Python and C++
- Host: GitHub
- URL: https://github.com/lemurpwned/cmtj
- Owner: LemurPwned
- License: gpl-2.0
- Created: 2019-07-28T09:57:45.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-11T14:19:42.000Z (8 days ago)
- Last Synced: 2024-11-11T14:29:13.219Z (8 days ago)
- Topics: condensed-phase-simulations, electronics, llg, llgs, macrospin, magnetics, mtj, python, spintronics, stochastic-differential-equations
- Language: Python
- Homepage: https://lemurpwned.github.io/cmtj/
- Size: 38.3 MB
- Stars: 34
- Watchers: 4
- Forks: 5
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# CMTJ
[](https://github.com/LemurPwned/cmtj/actions/workflows/main.yml)
[](https://github.com/LemurPwned/cmtj/actions/workflows/pages/pages-build-deployment)
[](https://pypi.org/project/cmtj/)
[](https://github.com/LemurPwned/cmtj/blob/master/LICENSE)
[](https://cmtj-app.streamlit.app/spectrum)
## Table of contents
- [CMTJ](#cmtj)
- [Table of contents](#table-of-contents)
- [Short description](#short-description)
- [Web GUI](#web-gui)
- [Quickstart](#quickstart)
- [Installation :rocket:](#installation-rocket)
- [Extra dependencies](#extra-dependencies)
- [Documentation and examples](#documentation-and-examples)
- [Extensions](#extensions)
- [Citing](#citing)
- [Development](#development)
- [Acknowledgements](#acknowledgements)
- [Contributions](#contributions)
- [Docker](#docker)
- [Precommit](#precommit)
- [Documentation builds](#documentation-builds)
## Short description
The `cmtj` name may be misleading -- the MTJ (Magnetic Tunnel Junctions) are not the only structures that may be simulated.
The library allows for macromagnetic simulation of various multilayer spintronic structures. The package uses C++ implementation of (s)LLGS (stochastic Landau-Lifschitz-Gilbert-Slonczewski) equation with various field contributions included for instance: anisotropy, interlayer exchange coupling, demagnetisation, dipole fields etc.
It is also possible to connect devices in parallel or in series to have electrically coupled arrays.
## Web GUI
Check out the [streamlit hosted demo here](https://cmtj-app.streamlit.app/spectrum).
You can simulate:
* PIMM spectra and Spin-Diode spectra
* Try some optimization fitting
* Fit multi-domain or multi-level M(H) or R(H) loops in [Domain mode](https://cmtj-app.streamlit.app)
Let us know if you have any issues with the demo.
## Quickstart
#### Installation :rocket:
The recommended way is to use the `pip` package manager and virtualenv (or conda).
Installation is as easy as doing:
1. With `virtualenv` (recommended):
```bash
$(bash) python -m venv .my-venv
$(bash) source .my-venv/bin/activate
$(.my-venv) python -m pip install cmtj
```
2. Straight from `pip`:
```bash
python3 -m pip install cmtj
```
3. Straight from source:
```bash
python3 -m pip install git+https://github.com/LemurPwned/cmtj.git
```
4. Clone the repository:
```bash
git clone https://github.com/LemurPwned/cmtj.git
python3 -m pip install .
```
#### Extra dependencies
The package requires (if `utils` subpackage is used):
```
- numpy
- scipy
- matplotlib
```
## Documentation and examples
Documentation: [https://lemurpwned.github.io/cmtj](https://lemurpwned.github.io/cmtj).
There are many examples available, check out the [examples section in the docs](https://lemurpwned.github.io/cmtj/experimental-methods/introduction/)
## Extensions
There's a GUI version available! If you wish to conduct a subset of simulations, mainly for experimental modelling, please see the _PyMag_ project. It uses CMTJ as a backend for fast computation.
## Citing
We would appreciate citing either of the listed work if you decide to use the project or using the cite button on the right hand side panel of the repository:
[**cmtj: Simulation package for analysis of multilayer spintronic devices**](https://www.nature.com/articles/s41524-023-01002-x)
```bibtex
@article{mojsiejuk_cmtj_2023,
title = {cmtj: Simulation package for analysis of multilayer spintronic devices},
volume = {9},
issn = {2057-3960},
url = {https://www.nature.com/articles/s41524-023-01002-x},
doi = {10.1038/s41524-023-01002-x},
pages = {54},
number = {1},
journaltitle = {npj Comput Mater},
author = {Mojsiejuk, Jakub and Ziętek, Sławomir and Grochot, Krzysztof and Skowroński, Witold and Stobiecki, Tomasz},
date = {2023-04-06},
}
```
# Development
## Acknowledgements
Many thanks to professor Jack Sankey for his help with the development of thermal contributions, with inspiration from the [macrospinmob project](https://github.com/Spinmob/macrospinmob).
## Contributions
All contributions are welcome, please leave an issue if you've encountered any trouble with setup or running the library.
## Docker
In the `docker` directory there's a `Dockerfile` that can be used to build a docker image with the library installed.
`Dockerfile.app` is used for streamlit development.
## Precommit
There's a `.pre-commit-config.yaml` that does some basic python and cpp lints and checks. More static analysis to come in the future.
This may be run with:
```
pre-commit run -v
```
or
```
pre-commit run -a (or --files core/* cmtj/*)
```
## Documentation builds
There are couple of stages to building the documentation
1. Build Doxygen documentation
```
doxygen Doxyfile
```
This is mostly for the C++ documentation. Furture changes may couple C++ and Python docs.
2. Build stubs
The stubgen is `pybind11-stubgen` or `mypy stubgen` with the latter being preferred now.
Before running the stubgen, make sure to install the package with:
```
python3 -m pip install .
```
avoid using `-e` flag as it may cause issues with the stubgen.
Then to generate, for instance, `Stack` module stubs we can do:
```
stubgen -m cmtj.stack -o target-stub-dir/
```
or
```
python3 -c "import mypy.stubgen; mypy.stubgen.main(['-p', 'cmtj.stack', '-o', 'target-stub-dir/'])"
```
More info here: https://mypy.readthedocs.io/en/stable/stubgen.html.
3. Parse stubs to Markdown.
This stage is done by running:
`python3 docs/docgen.py `
The deployment of the documentation is done via:
```bash
mkdocs gh-deploy
```
But first, worth a check:
```bash
mkdocs serve
```