MagLogic: Nanomagnetic Logic Simulation Suite

Python tools for simulating nanomagnetic logic devices. Supports OOMMF and MuMax3 backends.

Features: - Micromagnetic simulations via OOMMF and MuMax3 - Reconfigurable logic gate analysis - Magnetization pattern analysis - Cross-platform Docker support

Author: Meshal Alawein (meshal@berkeley.edu) Institution: University of California, Berkeley License: MIT © 2025 Meshal Alawein — All rights reserved

Project Overview

Implements nanomagnetic logic simulations from Alawein et al. (IEEE Mag. Letters, 2019). Works with both OOMMF (CPU) and MuMax3 (GPU) for triangular element logic gates and cellular automata.

Quick Start

Docker Installation (Recommended)

bash git clone https://github.com/alaweimm90/MagLogic.git cd MagLogic docker-compose up --build

Local Installation

```bash

Install dependencies

conda env create -f environment.yml conda activate maglogic pip install -e .

Run demonstration

python examples/runbasictriangle.py ```

Example Usage

```python from maglogic.demos import demonandnor

NAND mode (clock = +60°)

resultnand = demonandnor.runsimulation(clockangle=60, inputA=1, inputB=1) print(f"NAND(1,1) = {resultnand['logic_output']}") # Expected: 0

Generate complete truth table

truthtable = demonandnor.generatetruth_table() ```

Scientific Modules

Simulation backends

• OOMMF integration with .mif scripting
• MuMax3 GPU acceleration

Logic gates

• Type-I: NAND/NOR with clock control
• Type-II: Three-input majority gates
• Automated truth table verification

Analysis tools

• Domain structure analysis
• Energy landscape calculation
• Topological feature detection

Performance Benchmarks

| Platform | OOMMF | MuMax3 | Speedup | |----------|-------|--------|---------| | CPU (16 cores) | 45 min | 15 min | 3.0× | | GPU (RTX 3080) | N/A | 3 min | 15.0× | | Cluster (64 cores) | 8 min | 2 min | 22.5× |

Scales to 1000×1000 element arrays with 10⁶+ timesteps

Testing

Run the full test suite: bash pytest --cov=maglogic --cov-report=html

Includes unit tests, OOMMF/MuMax3 cross-validation, and CI across Python 3.8-3.12.

```bash

Run test suite

pytest --cov=maglogic --cov-report=html ```

Documentation

Build docs locally: bash cd docs && sphinx-build -b html . _build/html

Online docs: https://alaweimm90.github.io/MagLogic/

Examples

See examples/ for Jupyter notebooks and demo scripts. Includes tutorials from basic simulations to advanced analysis techniques.

Development

Contributing

```bash

Development setup

git clone https://github.com/alaweimm90/MagLogic.git cd MagLogic conda env create -f environment_dev.yml conda activate maglogic-dev pip install -e ".[dev,all]" pre-commit install

Run full test suite

pytest --cov=maglogic --cov-report=html ```

Use Black formatting, add tests for new code, update docs as needed.

Citation

If you use MagLogic in your research, please cite:

```bibtex @article{alawein2019multistate, title={Multistate nanomagnetic logic using equilateral permalloy triangles}, author={Alawein, Meshal and others}, journal={IEEE Magnetics Letters}, volume={10}, pages={1--5}, year={2019}, doi={10.1109/LMAG.2019.2912398} }

@software{alawein2025maglogic, title={MagLogic: Nanomagnetic Logic Simulation Suite}, author={Alawein, Meshal}, year={2025}, version={1.0.0}, url={https://github.com/alaweimm90/MagLogic}, doi={10.5281/zenodo.XXXXXXX} } ```

License

This project is licensed under the MIT License - see the LICENSE file for details.

Copyright © 2025 Meshal Alawein — All rights reserved.

Connect & Collaborate

Contact

Meshal Alawein
University of California, Berkeley
meshal@berkeley.edu