User Guide
The guide follows a researcher's workflow:
- run one magnetic structure;
- identify which symmetry description answers the question;
- interpret the physics-facing outputs and their limitations;
- test numerical reliability;
- request operations or files only when needed.
Recommended Path
| Step | Page | Outcome |
|---|---|---|
| 1 | Quickstart | Run the CLI or Python API and understand the first six result lines. |
| 2 | Interpret Your Result | Distinguish OSSG, MSG, moment geometry, phase, spin splitting, AHC, and spin texture. |
| 3 | Choose A Workflow | Select quick analysis, full analysis, or input-cell operation export. |
| 4 | Parameters And Reliability | Decide whether a tolerance change is justified and test sensitivity. |
| 5 | Input Formats | Verify magnetic moments, coordinate conventions, and POSCAR/INCAR behavior. |
| 6 | Examples | Adapt complete workflows to a research task. |
Use Troubleshooting when a run fails or produces an unexpected result.
Where Detailed Information Lives
- Exact commands and exports: CLI Reference
- Function signatures and returns: Python API
- Complete dictionary and nested field shapes: Result Schemas
- Terminology and settings glossary: Concepts
- SCIF modes and setting contracts: SCIF Export
The complete field inventory is intentionally kept out of the learning path so that diagnostic and legacy details do not obscure the main scientific result.