Spirit - Spin Simulation Framework

• Introduction
• Qt desktop user interface
• ImGui desktop user interface
• Input file specification
• Definitions
• Additional features

Installation

• Build on Unix/OSX
  • Core library
  • Desktop GUI
  • Python package
  • OpenMP backend
  • CUDA backend
  • Web apps
  • Further build configuration options
  • Installation
• Build on Windows
  • Core library
  • Desktop GUI
  • Python package
  • OpenMP backend
  • CUDA backend
  • Web apps
  • Further build configuration options
  • Installation
• Using Docker

C API

• Usage
  • Energy minimisation
  • LLG method
  • GNEB method
  • HTST
  • MMF method
• Full Reference
  • Spirit/Chain.h
    • Chain_Get_NOI
    • Change the active image
    • Insert/replace/delete images
    • Calculate data
  • Spirit/Configurations.h
    • Clipboard
    • Nonlocalised
    • Perturbations
    • Localised
    • Pinning and atom types
  • Spirit/Constants.h
    • Constants_mu_B
    • Constants_mu_0
    • Constants_k_B
    • Constants_hbar
    • Constants_mRy
    • Constants_gamma
    • Constants_g_e
    • Constants_Pi
  • Spirit/Geometry.h
    • Definition of Bravais lattice types
    • Setters
    • Getters
  • Spirit/Hamiltonian.h
    • DMI chirality
    • Dipole-Dipole method
    • Setters
    • Getters
  • Spirit/HTST.h
    • HTST_Calculate
    • HTST_Get_Info
    • HTST_Get_Eigenvalues_Min
    • HTST_Get_Eigenvectors_Min
    • HTST_Get_Eigenvalues_SP
    • HTST_Get_Eigenvectors_SP
    • HTST_Get_Velocities
  • Spirit/IO.h
    • Definition of file formats for vectorfields
    • Other
    • Spin configurations
    • Chains
    • Neighbours
    • Energies
    • Eigenmodes
  • Spirit/Log.h
    • Definition of log levels and senders
    • Logging functions
    • Set Log parameters
    • Get Log parameters
  • Spirit/Parameters_MC.h
    • Set
    • Set Parameters
    • Get Output
    • Get Parameters
  • Spirit/Parameters_LLG.h
    • Set Output
    • Set Parameters
    • Get Output
    • Get Parameters
  • Spirit/Parameters_GNEB.h
    • GNEB_IMAGE_NORMAL
    • GNEB_IMAGE_CLIMBING
    • GNEB_IMAGE_FALLING
    • GNEB_IMAGE_STATIONARY
    • Set Output
    • Set Parameters
    • Get Output
    • Get Parameters
  • Spirit/Parameters_EMA.h
    • Set
    • Get
  • Spirit/Parameters_MMF.h
    • Set Output
    • Set Parameters
    • Get Output
    • Get Parameters
  • Spirit/Quantities.h
    • Quantity_Get_Magnetization
    • Quantity_Get_Topological_Charge
    • Quantity_Get_Grad_Force_MinimumMode
  • Spirit/Simulation.h
    • Definition of solvers
    • Start or stop a simulation
    • Get information
    • Whether a simulation is running
  • Spirit/State.h
    • State
    • State_Setup
    • State_Delete
    • State_Update
    • State_To_Config
    • State_DateTime
  • Spirit/System.h
    • System_Get_Index
    • System_Get_NOS
    • System_Get_Spin_Directions
    • System_Get_Effective_Field
    • System_Get_Eigenmode
    • System_Get_Rx
    • System_Get_Energy
    • System_Get_Energy_Array_Names
    • System_Get_Energy_Array
    • System_Get_Eigenvalues
    • System_Print_Energy_Array
    • System_Update_Data
    • System_Update_Eigenmodes
  • Spirit/Transitions.h
    • Transition_Homogeneous
    • Transition_Homogeneous_Insert_Interpolated
    • Transition_Add_Noise_Temperature

Python API

• Usage
  • Energy minimisation
  • LLG method
  • GNEB method
  • HTST
  • MMF method
• Full Reference
  • spirit.chain
  • spirit.configuration
  • spirit.constants
  • spirit.geometry
  • spirit.hamiltonian
  • spirit.htst
  • spirit.io
  • spirit.log
  • spirit.parameters
    • Monte Carlo (MC)
    • Landau-Lifshitz-Gilbert (LLG)
    • Geodesic nudged elastic band (GNEB)
    • Eigenmode analysis (EMA)
    • Minimum mode following (MMF)
  • spirit.quantities
  • spirit.simulation
  • spirit.state
  • spirit.system
  • spirit.transition

Further Information

• License
• Contributing
• Contributors
• Referencing this Code
• Included dependencies

Indices and tables

• Index
• Module Index
• Search Page