How amchecker/amcheck works
amcheck is a Python library and interactive command-line tool for classifying compensated magnetic crystal structures as altermagnetic or antiferromagnetic, with an additional Anomalous Hall coefficient analysis mode. The main workflow reads a structure, identifies symmetry-related atom orbits, gathers magnetic assignments, and checks the symmetry relation between opposite-spin sublattices. The library also exposes the classification and tensor helpers. The README documents the Hall-analysis stages; the single implementation file is only partially excerpted, so some internal call relationships are not shown.
Main entry points: amcheck.py Altermagnet checker · __init__.py Public API
Components 15
Command-line workflow
- CLI entry
amcheck/amcheck.py - Structure reading
amcheck/amcheck.py - Space-group symmetry
amcheck/amcheck.py - Orbit spin input
amcheck/amcheck.py
Altermagnet classification
- Altermagnet checker
amcheck/amcheck.py - Classification result
amcheck/amcheck.py
Hall analysis
- Moment input
amcheck/amcheck.py - Magnetic space group
amcheck/amcheck.py - Conductivity tensor
amcheck/amcheck.py - Hall vector
amcheck/amcheck.py
Library API
- Public API
amcheck/__init__.py - Tensor helpers
amcheck/amcheck.py
Other components
- User
- Crystal structure
- Library caller
Connections 16
- User → CLI entry: runs
README.md - Crystal structure → Structure reading: provides input
README.md - CLI entry → Structure reading: reads files
amcheck/amcheck.py - Structure reading → Space-group symmetry: analyzes symmetry
amcheck/amcheck.py - Space-group symmetry → Orbit spin input: groups atoms
README.md - User → Orbit spin input: assigns spins
README.md - Orbit spin input → Altermagnet checker: supplies pattern
README.md - Space-group symmetry → Altermagnet checker: supplies operations
amcheck/amcheck.py - Altermagnet checker → Classification result: returns classification
README.md - User → Moment input: provides moments
README.md - Moment input → Magnetic space group: determines group
README.md - Magnetic space group → Conductivity tensor: constrains tensor
README.md - Conductivity tensor → Hall vector: yields Hall vector
README.md - Library caller → Public API: imports
README.md - Public API → Altermagnet checker: exposes checker
amcheck/__init__.py - Public API → Tensor helpers: exposes helpers
amcheck/__init__.py