Spirit - Spin Simulation Framework

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

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
  • Chain
  • 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()
  • Configuration
  • add_noise()
  • domain()
  • dw_skyrmion()
  • hopfion()
  • minus_z()
  • plus_z()
  • random()
  • set_atom_type()
  • set_pinned()
  • skyrmion()
  • spin_spiral()
  • Constants
  • g_e
  • gamma
  • hbar
  • k_B
  • mRy
  • mu_0
  • mu_B
  • pi
  • Geometry
  • 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_bounds()
  • get_bravais_lattice_type()
  • get_bravais_vectors()
  • get_center()
  • get_dimensionality()
  • get_n_cell_atoms()
  • get_n_cells()
  • get_positions()
  • set_bravais_lattice_type()
  • set_bravais_vectors()
  • set_cell_atom_types()
  • set_lattice_constant()
  • set_mu_s()
  • set_n_cells()
  • Hamiltonian
  • BiaxialAnisotropyData
    • BiaxialAnisotropyData.__annotations__
    • BiaxialAnisotropyData.__getnewargs__()
    • BiaxialAnisotropyData.__match_args__
    • BiaxialAnisotropyData.__module__
    • BiaxialAnisotropyData.__new__()
    • BiaxialAnisotropyData.__orig_bases__
    • BiaxialAnisotropyData.__repr__()
    • BiaxialAnisotropyData.__slots__
    • BiaxialAnisotropyData._asdict()
    • BiaxialAnisotropyData._field_defaults
    • BiaxialAnisotropyData._fields
    • BiaxialAnisotropyData._make()
    • BiaxialAnisotropyData._replace()
    • 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()
  • HTST
  • calculate()
  • get_eigenvalues_min()
  • get_eigenvalues_sp()
  • get_eigenvectors_min()
  • get_eigenvectors_sp()
  • get_info()
  • get_info_dict()
  • get_velocities()
  • I/O
  • FILEFORMAT_OVF_BIN
  • FILEFORMAT_OVF_BIN4
  • FILEFORMAT_OVF_BIN8
  • FILEFORMAT_OVF_CSV
  • FILEFORMAT_OVF_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()
  • Log
  • 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
    • Monte Carlo (MC)
    • get_iterations()
    • get_metropolis_cone()
    • get_temperature()
    • set_iterations()
    • set_metropolis_cone()
    • set_output_configuration()
    • set_output_energy()
    • set_output_folder()
    • set_output_general()
    • set_output_tag()
    • set_temperature()
    • Landau-Lifshitz-Gilbert (LLG)
    • get_convergence()
    • get_damping()
    • get_direct_minimization()
    • get_iterations()
    • get_non_adiabatic_damping()
    • get_stt()
    • get_temperature()
    • get_timestep()
    • set_convergence()
    • set_damping()
    • set_direct_minimization()
    • set_iterations()
    • set_non_adiabatic_damping()
    • set_output_configuration()
    • set_output_energy()
    • set_output_folder()
    • set_output_general()
    • set_output_tag()
    • set_stt()
    • set_temperature()
    • set_timestep()
    • Geodesic nudged elastic band (GNEB)
    • IMAGE_CLIMBING
    • IMAGE_FALLING
    • IMAGE_NORMAL
    • IMAGE_STATIONARY
    • get_climbing_falling()
    • get_convergence()
    • get_equilibrium_delta_Rx()
    • get_iterations()
    • get_moving_endpoints()
    • get_n_energy_interpolations()
    • get_path_shortening_constant()
    • get_spring_force()
    • get_translating_endpoints()
    • set_climbing_falling()
    • set_convergence()
    • set_equilibrium_delta_Rx()
    • set_image_type_automatically()
    • set_iterations()
    • set_moving_endpoints()
    • set_output_chain()
    • set_output_energies()
    • set_output_folder()
    • set_output_general()
    • set_output_tag()
    • set_path_shortening_constant()
    • set_spring_force()
    • set_translating_endpoints()
    • Eigenmode analysis (EMA)
    • clear_modes()
    • get_n_mode_follow()
    • get_n_modes()
    • get_sparse()
    • set_n_mode_follow()
    • set_n_modes()
    • set_sparse()
    • Minimum mode following (MMF)
    • get_iterations()
    • get_n_mode_follow()
    • get_n_modes()
    • set_iterations()
    • set_n_mode_follow()
    • set_n_modes()
    • set_output_configuration()
    • set_output_energy()
    • set_output_folder()
    • set_output_general()
    • set_output_tag()
  • Quantities
  • get_magnetization()
  • get_mmf_info()
  • get_topological_charge()
  • get_topological_charge_density()
  • Simulation
  • 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.__del__()
    • simulation_run_info.__dict__
    • simulation_run_info.__module__
    • simulation_run_info.__weakref__
    • simulation_run_info._fields_
    • simulation_run_info._history_energy
    • simulation_run_info._history_iteration
    • simulation_run_info._history_max_torque
    • simulation_run_info._n_history_energy
    • simulation_run_info._n_history_iteration
    • simulation_run_info._n_history_max_torque
    • 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()
  • State
  • State
    • State.__dict__
    • State.__enter__()
    • State.__exit__()
    • State.__init__()
    • State.__module__
    • State.__weakref__
  • date_time()
  • delete()
  • setup()
  • to_config()
  • System
  • 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_eigenmodes()
  • Transition
  • add_noise()
  • homogeneous()
  • homogeneous_insert_interpolated()

Further Information

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

Indices and tables

• Index

• Module Index

• Search Page