Spirit
  • Introduction
    • Contents
    • Introduction
      • A modern framework for magnetism science on clusters, desktops & laptops and even your Phone
      • Physics Features
      • Highlights of the Framework
      • Documentation
    • Getting started with the Desktop Interface
    • Getting started with the Python Package
  • Qt desktop user interface
    • Physics features
    • Real-time visualisation
    • Additional features
    • How to perform an energy minimisation
    • How to perform an LLG dynamics calculation
    • How to perform a GNEB calculation
    • Key bindings
      • UI Controls
      • Camera Controls
      • Control Simulations
      • Manipulate the current image
      • Manipulate the chain of images
  • ImGui desktop user interface
    • Physics features
    • Real-time visualisation
    • Additional features
    • How to perform an LLG dynamics calculation
    • How to perform an energy minimisation
    • How to perform a GNEB calculation
    • Key bindings
      • UI Controls
      • Camera Controls
      • Control Simulations
      • Manipulate the current image
      • Visualisation
      • Manipulate the chain of images
  • Input file specification
    • Introduction
      • Sections
      • Tables
    • General Settings (Defaults)
    • Logging
    • Geometry
      • Pinning
      • Disorder and Defects
    • Hamiltonian
    • Method Configuration
      • Method Output
      • Method Parameters
  • Hamiltonian
    • Zeeman
      • Hamiltonian_Set_Field()
      • Hamiltonian_Get_Field()
    • Anisotropy
      • Uniaxial Anisotropy
      • Cubic Anisotropy
        • Hamiltonian_Set_Anisotropy()
        • Hamiltonian_Get_Anisotropy()
    • Biaxial Anisotropy
      • Hamiltonian_Set_Biaxial_Anisotropy()
      • Hamiltonian_Get_Biaxial_Anisotropy()
    • Pair interactions
      • Heisenberg exchange
      • Dzyaloshinskii–Moriya Interaction (DMI)
        • SPIRIT_CHIRALITY_BLOCH
        • SPIRIT_CHIRALITY_NEEL
        • SPIRIT_CHIRALITY_BLOCH_INVERSE
        • SPIRIT_CHIRALITY_NEEL_INVERSE
        • Hamiltonian_Set_DMI()
        • Hamiltonian_Get_DMI_Shells()
        • Hamiltonian_Get_DMI_N_Pairs()
        • Hamiltonian_Set_Exchange()
        • Hamiltonian_Get_Exchange_Shells()
        • Hamiltonian_Get_Exchange_N_Pairs()
        • Hamiltonian_Get_Exchange_Pairs()
    • Two-Site Anisotropy
    • Dipole-Dipole Interaction
      • SPIRIT_DDI_METHOD_NONE
      • SPIRIT_DDI_METHOD_FFT
      • SPIRIT_DDI_METHOD_CUTOFF
      • Hamiltonian_Set_DDI()
      • Hamiltonian_Get_DDI()
    • Quadruplet Interaction
    • Custom Interaction
  • Custom Interaction
    • Setup
    • Local Interaction
      • Local Functors
      • Local Datatypes
    • Non-local Interaction
      • Non-local Functors
      • Non-local Datatypes
    • Configparser
      • Tableparser
  • Definitions
    • Heisenberg Hamiltonian
    • LLG dynamics
    • Geodesic nudged elastic band method
    • Minimum mode following method
    • Harmonic transition state theory
    • Topological charge
    • Gaussian (test-) Hamiltonian
  • Additional features
    • Command line options
    • Running quietly
    • Stopping a running process by interrupting
    • Stopping a running process without interrupting

Installation

  • Build on Unix/OSX
    • Core library
    • Desktop GUI
      • Additional requirements
    • Python package
    • OpenMP backend
    • STDPAR backend
    • CUDA backend
    • Web apps
    • Further build configuration options
    • Installation
  • Build on Windows
    • Core library
    • Desktop GUI
    • Python package
    • OpenMP backend
    • STDPAR 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
        • Chain_next_Image()
        • Chain_prev_Image()
        • Chain_Jump_To_Image()
      • Insert/replace/delete images
        • Chain_Set_Length()
        • Chain_Image_to_Clipboard()
        • Chain_Replace_Image()
        • Chain_Insert_Image_Before()
        • Chain_Insert_Image_After()
        • Chain_Push_Back()
        • Chain_Delete_Image()
        • Chain_Pop_Back()
      • Calculate data
        • Chain_Get_Rx()
        • Chain_Get_Rx_Interpolated()
        • Chain_Get_Energy()
        • Chain_Get_Energy_Interpolated()
        • Chain_Update_Data()
        • Chain_Setup_Data()
    • Spirit/Configurations.h
      • Clipboard
        • Configuration_To_Clipboard()
        • Configuration_From_Clipboard()
        • Configuration_From_Clipboard_Shift()
      • Nonlocalised
        • Configuration_Domain()
        • Configuration_PlusZ()
        • Configuration_MinusZ()
        • Configuration_Random()
        • Configuration_SpinSpiral()
        • Configuration_SpinSpiral_2q()
      • Perturbations
        • Configuration_Add_Noise_Temperature()
        • Configuration_Displace_Eigenmode()
      • Localised
        • Configuration_Skyrmion()
        • Configuration_DW_Skyrmion()
        • Configuration_Hopfion()
      • Pinning and atom types
        • Configuration_Set_Pinned()
        • Configuration_Set_Atom_Type()
      • Default Values
        • defaultPos
        • defaultRect
        • defaultNormal
    • 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
        • Bravais_Lattice_Type
      • Setters
        • Geometry_Set_Boundary_Conditions()
        • Geometry_Set_Bravais_Lattice_Type()
        • Geometry_Set_N_Cells()
        • Geometry_Set_Cell_Atoms()
        • Geometry_Set_mu_s()
        • Geometry_Set_spin_qn()
        • Geometry_Set_Cell_Atom_Types()
        • Geometry_Set_Bravais_Vectors()
        • Geometry_Set_Lattice_Constant()
      • Getters
        • Geometry_Get_Boundary_Conditions()
        • Geometry_Get_NOS()
        • Geometry_Get_Center()
        • Geometry_Get_Bravais_Vectors()
        • Geometry_Get_Dimensionality()
        • Geometry_Get_mu_s()
        • Geometry_Get_spin_qn()
        • Geometry_Get_N_Cells()
        • Geometry_Get_N_Cell_Atoms()
      • Getters: Basis Cell
        • Geometry_Get_Cell_Bounds()
        • Geometry_Get_Cell_Atoms()
      • Getters: Triangulation and Tetrahedra
        • Geometry_Get_Triangulation()
        • Geometry_Get_Triangulation_Ranged()
        • Geometry_Get_Tetrahedra()
        • Geometry_Get_Tetrahedra_Ranged()
    • Spirit/Hamiltonian.h
      • DMI chirality
        • SPIRIT_CHIRALITY_BLOCH
        • SPIRIT_CHIRALITY_NEEL
        • SPIRIT_CHIRALITY_BLOCH_INVERSE
        • SPIRIT_CHIRALITY_NEEL_INVERSE
      • Dipole-Dipole method
        • SPIRIT_DDI_METHOD_NONE
        • SPIRIT_DDI_METHOD_FFT
        • SPIRIT_DDI_METHOD_FMM
        • SPIRIT_DDI_METHOD_CUTOFF
      • Hamiltonian classification id (legacy support)
        • SPIRIT_HAMILTONIAN_CLASS_GENERIC
        • SPIRIT_HAMILTONIAN_CLASS_GAUSSIAN
        • SPIRIT_HAMILTONIAN_CLASS_HEISENBERG
      • Setters
        • Hamiltonian_Set_Boundary_Conditions()
        • Hamiltonian_Set_Field()
        • Hamiltonian_Set_Anisotropy()
        • Hamiltonian_Set_Biaxial_Anisotropy()
        • Hamiltonian_Set_Exchange()
        • Hamiltonian_Set_DMI()
        • Hamiltonian_Set_DDI()
      • Getters
        • Hamiltonian_Get_Boundary_Conditions()
        • Hamiltonian_Get_Field()
        • Hamiltonian_Get_Anisotropy()
        • Hamiltonian_Get_Biaxial_Anisotropy_N_Atoms()
        • Hamiltonian_Get_Biaxial_Anisotropy_N_Terms()
        • Hamiltonian_Get_Biaxial_Anisotropy()
        • Hamiltonian_Get_Exchange_Shells()
        • Hamiltonian_Get_Exchange_N_Pairs()
        • Hamiltonian_Get_Exchange_Pairs()
        • Hamiltonian_Get_DMI_Shells()
        • Hamiltonian_Get_DMI_N_Pairs()
        • Hamiltonian_Get_DDI()
        • Hamiltonian_Write_Hessian()
    • 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
        • IO_Fileformat_OVF_bin
        • IO_Fileformat_OVF_bin4
        • IO_Fileformat_OVF_bin8
        • IO_Fileformat_OVF_text
        • IO_Fileformat_OVF_csv
        • IO_Fileformat_VTK_hdf
        • IO_Fileformat_VTK_XML_bin
        • IO_Fileformat_VTK_XML_text
      • Other
        • IO_System_From_Config()
        • IO_Positions_Write()
      • Spin configurations
        • IO_N_Images_In_File()
        • IO_Image_Read()
        • IO_Image_Write()
        • IO_Image_Append()
      • Chains
        • IO_Chain_Read()
        • IO_Chain_Write()
        • IO_Chain_Append()
      • Neighbours
        • IO_Image_Write_Neighbours_Exchange()
        • IO_Image_Write_Neighbours_DMI()
      • Energies
        • IO_Image_Write_Energy_per_Spin()
        • IO_Image_Write_Energy()
        • IO_Chain_Write_Energies()
        • IO_Chain_Write_Energies_Interpolated()
      • Eigenmodes
        • IO_Eigenmodes_Read()
        • IO_Eigenmodes_Write()
    • Spirit/Log.h
      • Definition of log levels and senders
        • Spirit_Log_Level
        • Spirit_Log_Sender
      • Logging functions
        • Log_Send()
        • Log_Append()
        • Log_Get_N_Entries()
        • Log_Get_N_Errors()
        • Log_Get_N_Warnings()
      • Get Log parameters
        • Log_Get_Output_File_Tag()
        • Log_Get_Output_Folder()
        • Log_Get_Output_To_Console()
        • Log_Get_Output_To_File()
      • Set Log parameters
        • Log_Set_Output_File_Tag()
        • Log_Set_Output_Folder()
        • Log_Set_Output_To_Console()
        • Log_Set_Output_To_File()
    • Spirit/Parameters_MC.h
      • MC_Metropolis_Step_Spin_Sphere
      • MC_Metropolis_Step_Spin_Cone
      • MC_Metropolis_Step_Spin_Semi_Classical
      • Parameters_MC_Metropolis_Parameters
        • step
        • use_adaptive_cone
        • target_acceptance_ratio
        • cone_angle
      • Set Output
        • Parameters_MC_Set_Output_Tag()
        • Parameters_MC_Set_Output_Folder()
        • Parameters_MC_Set_Output_General()
        • Parameters_MC_Set_Output_Energy()
        • Parameters_MC_Set_Output_Configuration()
      • Set Parameters
        • Parameters_MC_Set_N_Iterations()
        • Parameters_MC_Set_Temperature()
        • Parameters_MC_Set_Metropolis_Parameters()
        • Parameters_MC_Set_Metropolis_Cone()
        • Parameters_MC_Set_Random_Sample()
      • Get Output
        • Parameters_MC_Get_Output_Tag()
        • Parameters_MC_Get_Output_Folder()
        • Parameters_MC_Get_Output_General()
        • Parameters_MC_Get_Output_Energy()
        • Parameters_MC_Get_Output_Configuration()
      • Get Parameters
        • Parameters_MC_Get_N_Iterations()
        • Parameters_MC_Get_Temperature()
        • Parameters_MC_Get_Metropolis_Cone()
        • Parameters_MC_Get_Metropolis_Parameters()
        • Parameters_MC_Get_Random_Sample()
    • Spirit/Parameters_LLG.h
      • Set Output
        • Parameters_LLG_Set_Output_Tag()
        • Parameters_LLG_Set_Output_Folder()
        • Parameters_LLG_Set_Output_General()
        • Parameters_LLG_Set_Output_Energy()
        • Parameters_LLG_Set_Output_Configuration()
      • Set Parameters
        • Parameters_LLG_Set_N_Iterations()
        • Parameters_LLG_Set_Direct_Minimization()
        • Parameters_LLG_Set_Convergence()
        • Parameters_LLG_Set_Time_Step()
        • Parameters_LLG_Set_Damping()
        • Parameters_LLG_Set_Non_Adiabatic_Damping()
        • Parameters_LLG_Set_STT()
        • Parameters_LLG_Set_Temperature()
        • Parameters_LLG_Set_Temperature_Gradient()
      • Get Output
        • Parameters_LLG_Get_Output_Tag()
        • Parameters_LLG_Get_Output_Folder()
        • Parameters_LLG_Get_Output_General()
        • Parameters_LLG_Get_Output_Energy()
        • Parameters_LLG_Get_Output_Configuration()
      • Get Parameters
        • Parameters_LLG_Get_N_Iterations()
        • Parameters_LLG_Get_Direct_Minimization()
        • Parameters_LLG_Get_Convergence()
        • Parameters_LLG_Get_Time_Step()
        • Parameters_LLG_Get_Damping()
        • Parameters_LLG_Get_Non_Adiabatic_Damping()
        • Parameters_LLG_Get_Temperature()
        • Parameters_LLG_Get_Temperature_Gradient()
        • Parameters_LLG_Get_STT()
    • Spirit/Parameters_GNEB.h
      • Image Type
        • GNEB_IMAGE_NORMAL
        • GNEB_IMAGE_CLIMBING
        • GNEB_IMAGE_FALLING
        • GNEB_IMAGE_STATIONARY
      • Set Output
        • Parameters_GNEB_Set_Output_Tag()
        • Parameters_GNEB_Set_Output_Folder()
        • Parameters_GNEB_Set_Output_General()
        • Parameters_GNEB_Set_Output_Energies()
        • Parameters_GNEB_Set_Output_Chain()
      • Set Parameters
        • Parameters_GNEB_Set_N_Iterations()
        • Parameters_GNEB_Set_Convergence()
        • Parameters_GNEB_Set_Spring_Constant()
        • Parameters_GNEB_Set_Spring_Force_Ratio()
        • Parameters_GNEB_Set_Path_Shortening_Constant()
        • Parameters_GNEB_Set_Moving_Endpoints()
        • Parameters_GNEB_Set_Translating_Endpoints()
        • Parameters_GNEB_Set_Equilibrium_Delta_Rx()
        • Parameters_GNEB_Set_Climbing_Falling()
        • Parameters_GNEB_Set_Image_Type_Automatically()
        • Parameters_GNEB_Set_N_Energy_Interpolations()
      • Get Output
        • Parameters_GNEB_Get_Output_Tag()
        • Parameters_GNEB_Get_Output_Folder()
        • Parameters_GNEB_Get_Output_General()
        • Parameters_GNEB_Get_Output_Energies()
        • Parameters_GNEB_Get_Output_Chain()
        • Parameters_GNEB_Get_N_Iterations()
      • Set Parameters
        • Parameters_GNEB_Get_Convergence()
        • Parameters_GNEB_Get_Spring_Constant()
        • Parameters_GNEB_Get_Spring_Force_Ratio()
        • Parameters_GNEB_Get_Path_Shortening_Constant()
        • Parameters_GNEB_Get_Moving_Endpoints()
        • Parameters_GNEB_Get_Translating_Endpoints()
        • Parameters_GNEB_Get_Equilibrium_Delta_Rx()
        • Parameters_GNEB_Get_Climbing_Falling()
        • Parameters_GNEB_Get_N_Energy_Interpolations()
    • Spirit/Parameters_EMA.h
      • Parameters_EMA_Clear_Modes()
      • Set Parameters
        • Parameters_EMA_Set_N_Modes()
        • Parameters_EMA_Set_N_Mode_Follow()
        • Parameters_EMA_Set_Frequency()
        • Parameters_EMA_Set_Amplitude()
        • Parameters_EMA_Set_Snapshot()
        • Parameters_EMA_Set_Sparse()
      • Get Parameters
        • Parameters_EMA_Get_N_Modes()
        • Parameters_EMA_Get_N_Mode_Follow()
        • Parameters_EMA_Get_Frequency()
        • Parameters_EMA_Get_Amplitude()
        • Parameters_EMA_Get_Snapshot()
        • Parameters_EMA_Get_Sparse()
    • Spirit/Parameters_MMF.h
      • Set Output
        • Parameters_MMF_Set_Output_Tag()
        • Parameters_MMF_Set_Output_Folder()
        • Parameters_MMF_Set_Output_General()
        • Parameters_MMF_Set_Output_Energy()
        • Parameters_MMF_Set_Output_Configuration()
      • Set Parameters
        • Parameters_MMF_Set_N_Iterations()
        • Parameters_MMF_Set_N_Modes()
        • Parameters_MMF_Set_N_Mode_Follow()
      • Get Output
        • Parameters_MMF_Get_Output_Tag()
        • Parameters_MMF_Get_Output_Folder()
        • Parameters_MMF_Get_Output_General()
        • Parameters_MMF_Get_Output_Energy()
        • Parameters_MMF_Get_Output_Configuration()
      • Get Parameters
        • Parameters_MMF_Get_N_Iterations()
        • Parameters_MMF_Get_N_Modes()
        • Parameters_MMF_Get_N_Mode_Follow()
    • Spirit/Quantities.h
      • Quantity_Get_Average_Spin()
      • Quantity_Get_Magnetization()
      • Quantity_Get_Topological_Charge()
      • Quantity_Get_Topological_Charge_Density()
      • Quantity_Get_Grad_Force_MinimumMode()
    • Spirit/Simulation.h
      • Definition of solvers
        • Solver_VP
        • Solver_SIB
        • Solver_Depondt
        • Solver_Heun
        • Solver_RungeKutta4
        • Solver_LBFGS_OSO
        • Solver_LBFGS_Atlas
        • Solver_VP_OSO
      • Definition of Monte Carlo Algorithms
        • MC_Algorithm_Metropolis
        • MC_Algorithm_Metropolis_MDC
      • Run info
        • Simulation_Run_Info
        • free_run_info()
      • Start or stop a simulation
        • Simulation_MC_Start()
        • Simulation_LLG_Start()
        • Simulation_GNEB_Start()
        • Simulation_MMF_Start()
        • Simulation_EMA_Start()
        • Simulation_SingleShot()
        • Simulation_N_Shot()
        • Simulation_Stop()
        • Simulation_Stop_All()
      • Get information
        • Simulation_Get_MaxTorqueNorm()
        • Simulation_Get_Chain_MaxTorqueNorms()
        • Simulation_Get_IterationsPerSecond()
        • Simulation_Get_Iteration()
        • Simulation_Get_Time()
        • Simulation_Get_Wall_Time()
      • Whether a simulation is running
        • Simulation_Running_On_Image()
        • Simulation_Running_On_Chain()
        • Simulation_Running_Anywhere_On_Chain()
    • 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_Energy()
      • System_Update_Magnetization()
      • System_Update_Effective_Field()
      • System_Update_Data()
      • System_Update_Eigenmodes()
    • Spirit/Transitions.h
      • Transition_Homogeneous()
      • Transition_Homogeneous_Insert_Interpolated()
      • Transition_Add_Noise_Temperature()
    • Spirit/Legacy.h
      • Legacy_Convert_Config_to_TOML()

Python API

  • Usage
    • Energy minimisation
    • LLG method
    • GNEB method
    • HTST
    • MMF method
  • Full Reference
    • spirit.chain module
      • delete_image()
      • get_energy()
      • get_energy_interpolated()
      • get_noi()
      • get_reaction_coordinate()
      • get_reaction_coordinate_interpolated()
      • image_to_clipboard()
      • insert_image_after()
      • insert_image_before()
      • jump_to_image()
      • next_image()
      • pop_back()
      • prev_image()
      • push_back()
      • replace_image()
      • set_length()
      • setup_data()
      • update_data()
    • spirit.configuration module
      • add_noise()
      • domain()
      • dw_skyrmion()
      • hopfion()
      • minus_z()
      • plus_z()
      • random()
      • set_atom_type()
      • set_pinned()
      • skyrmion()
      • spin_spiral()
    • spirit.constants module
      • g_e
      • gamma
      • hbar
      • k_B
      • mRy
      • mu_0
      • mu_B
      • pi
    • spirit.geometry module
      • BRAVAIS_LATTICE_BCC
      • BRAVAIS_LATTICE_FCC
      • BRAVAIS_LATTICE_HCP
      • BRAVAIS_LATTICE_HEX2D
      • BRAVAIS_LATTICE_HEX2D_120
      • BRAVAIS_LATTICE_HEX2D_60
      • BRAVAIS_LATTICE_IRREGULAR
      • BRAVAIS_LATTICE_RECTILINEAR
      • BRAVAIS_LATTICE_SC
      • get_atom_types()
      • get_boundary_conditions()
      • get_bounds()
      • get_bravais_lattice_type()
      • get_bravais_vectors()
      • get_center()
      • get_dimensionality()
      • get_n_cell_atoms()
      • get_n_cells()
      • get_positions()
      • set_boundary_conditions()
      • set_bravais_lattice_type()
      • set_bravais_vectors()
      • set_cell_atom_types()
      • set_lattice_constant()
      • set_mu_s()
      • set_n_cells()
    • spirit.hamiltonian module
      • BiaxialAnisotropyData
        • BiaxialAnisotropyData.exponents
        • BiaxialAnisotropyData.indices
        • BiaxialAnisotropyData.magnitude
        • BiaxialAnisotropyData.primary
        • BiaxialAnisotropyData.secondary
        • BiaxialAnisotropyData.site_p
      • CHIRALITY_BLOCH
      • CHIRALITY_BLOCH_INVERSE
      • CHIRALITY_NEEL
      • CHIRALITY_NEEL_INVERSE
      • DDI_METHOD_CUTOFF
      • DDI_METHOD_FFT
      • DDI_METHOD_FMM
      • DDI_METHOD_NONE
      • get_anisotropy()
      • get_biaxial_anisotropy()
      • get_biaxial_anisotropy_n_atoms()
      • get_biaxial_anisotropy_n_terms()
      • get_boundary_conditions()
      • get_cubic_anisotropy()
      • get_ddi()
      • get_field()
      • get_name()
      • set_anisotropy()
      • set_biaxial_anisotropy()
      • set_boundary_conditions()
      • set_cubic_anisotropy()
      • set_ddi()
      • set_dmi()
      • set_exchange()
      • set_field()
      • write_hessian()
    • spirit.htst module
      • calculate()
      • get_eigenvalues_min()
      • get_eigenvalues_sp()
      • get_eigenvectors_min()
      • get_eigenvectors_sp()
      • get_info()
      • get_info_dict()
      • get_velocities()
    • spirit.io module
      • FILEFORMAT_OVF_BIN
      • FILEFORMAT_OVF_BIN4
      • FILEFORMAT_OVF_BIN8
      • FILEFORMAT_OVF_CSV
      • FILEFORMAT_OVF_TEXT
      • FILEFORMAT_VTK_HDF
      • FILEFORMAT_VTK_XML_BIN
      • FILEFORMAT_VTK_XML_TEXT
      • chain_append()
      • chain_read()
      • chain_write()
      • eigenmodes_read()
      • eigenmodes_write()
      • image_append()
      • image_read()
      • image_write()
      • image_write_energy_per_spin()
      • n_images_in_file()
    • spirit.log module
      • LEVEL_ALL
      • LEVEL_DEBUG
      • LEVEL_ERROR
      • LEVEL_INFO
      • LEVEL_PARAMETER
      • LEVEL_SEVERE
      • LEVEL_WARNING
      • SENDER_ALL
      • SENDER_API
      • SENDER_GNEB
      • SENDER_IO
      • SENDER_LLG
      • SENDER_MC
      • SENDER_MMF
      • SENDER_UI
      • append()
      • get_n_entries()
      • get_n_errors()
      • get_n_warnings()
      • get_output_console_level()
      • get_output_file_level()
      • get_output_to_console()
      • get_output_to_file()
      • send()
      • set_output_file_tag()
      • set_output_folder()
      • set_output_to_console()
      • set_output_to_file()
    • spirit.parameters package
      • Submodules
        • spirit.parameters.ema module
        • spirit.parameters.gneb module
        • spirit.parameters.llg module
        • spirit.parameters.mc module
        • spirit.parameters.mmf module
    • spirit.quantities module
      • get_magnetization()
      • get_mmf_info()
      • get_topological_charge()
      • get_topological_charge_density()
    • spirit.simulation module
      • MC_ALGORITHM_METROPOLIS
      • MC_ALGORITHM_METROPOLIS_MDC
      • METHOD_EMA
      • METHOD_GNEB
      • METHOD_LLG
      • METHOD_MC
      • METHOD_MMF
      • SOLVER_DEPONDT
      • SOLVER_HEUN
      • SOLVER_LBFGS_Atlas
      • SOLVER_LBFGS_OSO
      • SOLVER_RK4
      • SOLVER_SIB
      • SOLVER_VP
      • SOLVER_VP_OSO
      • get_iterations_per_second()
      • get_max_torque_norm()
      • get_time()
      • get_wall_time()
      • n_shot()
      • running_anywhere_on_chain()
      • running_on_chain()
      • running_on_image()
      • simulation_run_info
        • simulation_run_info.history_energy()
        • simulation_run_info.history_iteration()
        • simulation_run_info.history_max_torque()
        • simulation_run_info.max_torque
        • simulation_run_info.total_ips
        • simulation_run_info.total_iterations
        • simulation_run_info.total_walltime
      • single_shot()
      • start()
      • stop()
      • stop_all()
    • spirit.state module
      • State
      • date_time()
      • delete()
      • setup()
      • to_config()
    • spirit.system module
      • get_effective_field()
      • get_eigenmode()
      • get_eigenvalues()
      • get_energy()
      • get_energy_contributions()
      • get_index()
      • get_nos()
      • get_spin_directions()
      • print_energy_array()
      • update_data()
      • update_effective_field()
      • update_eigenmodes()
      • update_energy()
      • update_magnetization()
    • spirit.transition module
      • add_noise()
      • homogeneous()
      • homogeneous_insert_interpolated()
    • spirit.legacy module
      • Legacy
      • convert_config_to_toml()
      • deprecated

Further Information

  • License
  • Contributing
    • Branches
    • Testing
    • Documentation
  • Contributors
    • Moritz Sallermann
    • Gideon P. Müller
    • Markus Hoffmann
    • Nikolai S. Kiselev
    • Florian Rhiem
    • Pavel F. Bessarab
    • Aleksei V. Ivanov
    • Daniel Schürhoff
    • Stefanos Mavros
    • Constantin Disselkamp
    • Filipp N. R. Rybakov
    • Ingo Heimbach
    • Mathias Redies, Maximilian Merte, Rene Suckert
    • Dmitrii Tolmachev
    • David Bauer
    • Graph
  • Referencing this Code
    • Framework
    • Source Code
    • Specific Methods
  • Included dependencies
    • VFRendering
      • Getting Started
        • 1. Include <VFRendering/View.hxx>
        • 2. Create a VFRendering::Geometry
        • 3. Read or calculate the vector directions
        • 4. Create a VFRendering::VectorField
        • 5. Create a VFRendering::View and a Renderer
        • 5. Draw the view in an existing OpenGL context
      • Python Package
        • 1. import
        • 2. Create a pyVFRendering.Geometry
        • 3. Read or calculate the vector directions
        • 4. Pass geometry and directions to a pyVFRendering.View
        • 5. Draw the view in an existing OpenGL context
      • Renderers
      • Options
      • ToDo
    • OVF
      • How to use
        • C/C++
        • Python
        • Fortran
      • How to embed it into your project
      • Build
        • On Unix systems
        • On Windows
        • CMake Options
        • Create and install the Python package
        • Build without CMake
      • File format v2.0 specification
        • General
        • Header
        • Segments
        • Extensions made by this library
        • Current limitations of this library
        • Example
        • Comparison to OVF 1.0
    • Spectra
      • Relation to ARPACK
      • Common Usage
      • Examples
      • Shift-and-invert Mode
      • Documentation
      • Installation
      • License
Spirit
  • Python Module Index

Python Module Index

s
 
s
- spirit
    spirit.chain
    spirit.configuration
    spirit.constants
    spirit.geometry
    spirit.hamiltonian
    spirit.htst
    spirit.io
    spirit.legacy
    spirit.log
    spirit.parameters
    spirit.parameters.ema
    spirit.parameters.gneb
    spirit.parameters.llg
    spirit.parameters.mc
    spirit.parameters.mmf
    spirit.quantities
    spirit.simulation
    spirit.spiritlib
    spirit.state
    spirit.system
    spirit.transition

© Copyright 2024, Gideon Mueller and contributors.

Built with Sphinx using a theme provided by Read the Docs.