Skip to content

Forge magnetic structures from symmetry

SpinForge generates spin-symmetry-adapted and oriented magnetic crystal structures from crystallographic symmetry. Use this page to choose a route based on what you already know and what you need to do.

Choose a route Install SpinForge

Project scope

SpinForge generates symmetry-compatible candidates. It does not determine or refine a magnetic structure from experimental or first-principles data.

Choose your route

You do not need to read the documentation from beginning to end. Each route below states its prerequisite, reading order, and destination. Follow one route until it meets your goal, then stop or branch to another.

  • Understand the model

    Start here if: SpinForge's domain vocabulary or representation of a magnetic structure is new to you.

    Read: Domain model → Classification model

    You will be able to: explain what SpinForge represents, which stages it distinguishes, and why different equivalence relations produce different candidate sets.

    You can skip: installation, tutorials, and API details if you only need the conceptual model.

  • Learn SpinForge

    Start here if: you know the magnetic-crystallography concepts and are new to the package.

    Read: Installation → Your first structure → Examples

    You will be able to: install SpinForge, enumerate a first set of candidates, and inspect the result.

    You can skip: the conceptual route when its terminology is already familiar. Return to the classification model if a result count or grouping is unexpected.

  • Complete a task

    Start here if: SpinForge is installed and you can already run a basic enumeration.

    Go directly to: Control enumeration, Use propagation vectors, or Export files.

    You will be able to: change the search and equivalence settings or write the selected candidates for downstream use.

    You can skip: the tutorial and unrelated task guides.

  • Check exact behavior

    Start here if: you are implementing against SpinForge or verifying an exact contract.

    Go directly to: Enumeration and equivalence, File formats, or the relevant API reference. Consult the Classification model when the meaning of a returned object or equivalence relation matters.

    You will be able to: confirm signatures, return types, object relationships, and classification semantics.

    You can skip: tutorials and task guides when you already know which API surface you need.