Spirit - Spin Simulation Framework

Introduction

• General
• Desktop User Interface
• Input File Specification

Building

• The Core Library
• Framework Components
• Using Docker

C API Reference

• Chain
  • Chain_Get_NOI
  • Change the active image
  • Insert/replace/delete images
  • Calculate data
• Configurations
  • Clipboard
  • Nonlocalised
  • Perturbations
  • Localised
  • Pinning and atom types
• Constants
  • Constants_mu_B
  • Constants_mu_0
  • Constants_k_B
  • Constants_hbar
  • Constants_mRy
  • Constants_gamma
  • Constants_g_e
  • Constants_Pi
• Geometry
  • Definition of Bravais lattice types
  • Setters
  • Getters
• Hamiltonian
  • DMI chirality
  • Dipole-Dipole method
  • Setters
  • Getters
• IO
  • Definition of file formats for vectorfields
  • Other
  • Spin configurations
  • Chains
  • Neighbours
  • Energies
  • Eigenmodes
• Log
  • Definition of log levels and senders
  • Logging functions
  • Set Log parameters
  • Get Log parameters
• MC Parameters
  • Set
  • Set Parameters
  • Get Output
  • Get Parameters
• LLG Parameters
  • Set Output
  • Set Parameters
  • Get Output
  • Get Parameters
• GNEB Parameters
  • GNEB_IMAGE_NORMAL
  • GNEB_IMAGE_CLIMBING
  • GNEB_IMAGE_FALLING
  • GNEB_IMAGE_STATIONARY
  • Set Output
  • Set Parameters
  • Get Output
  • Get Parameters
• EMA Parameters
  • Set
  • Get
• MMF Parameters
  • Set Output
  • Set Parameters
  • Get Output
  • Get Parameters
• Quantities
  • Quantity_Get_Magnetization
  • Quantity_Get_Topological_Charge
  • Quantity_Get_Grad_Force_MinimumMode
  • Quantity_Get_HTST_Prefactor
• Simulation
  • Definition of solvers
  • Start or stop a simulation
  • Get information
  • Whether a simulation is running
• State
  • State
  • State_Setup
  • State_Delete
  • State_Update
  • State_To_Config
  • State_DateTime
• System
  • 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
  • System_Get_Eigenvalues
  • System_Print_Energy_Array
  • System_Update_Data
  • System_Update_Eigenmodes

Python API Reference

• spirit.chain
• spirit.configuration
• spirit.constants
• spirit.geometry
• spirit.hamiltonian
• 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