Welcome to teacups’ documentation!

• Introduction
  • What is teacups?
  • What are its features?
  • Requirements
  • Literature
• Getting started
  • Download teacups
  • Installation
  • Test your installation
• Tutorial
  • The main simulation function
  • Input classes provided by teacups
  • A first simulation
    • Define necessary inputs
    • Getting the outputs
    • Example Skripts
      • Doublet (transient nutations)
      • Doublet (with hyperfines)
      • Triplet (2D)
      • Triplet (asymmetric relaxation)
      • Radical pair (quantum beats)
      • Radical pair (early dynamics)
      • Triplet-doublet pair (2D)
      • Triplet-doublet pair (reverse quartet mechanism)
  • Workflow using Teacups
    • Determine the spin system
    • Analyze the eigenvalues
    • Calculate the time evolution
• Spin System (Sys)
  • Polarisation
    • Sys.spin_system
    • Sys.precursor
    • Sys.population
  • g-tensors
    • Sys.g
    • Sys.g_tri
    • Sys.g1
    • Sys.g2
    • Sys.g_frame
    • Sys.g_tri_frame
    • Sys.g1_frame
    • Sys.g2_frame
  • Spin-spin interactions
    • Sys.J_ex
    • Sys.D & Sys.E
    • Sys.D_frame
    • Sys.D_tri & Sys.E_tri
    • Sys.D_tri_frame
  • Relaxation
    • Sys.decay
    • Sys.T_relax_1
    • Sys.T_relax_2
    • Sys.dynamics
  • Line width
    • Sys.width_gauss
    • Sys.sigma_time
  • Hyperfine interaction
    • Sys.Ai
    • Sys.Ai_frame
    • Sys.Ii
    • Sys.ni
• Experimental (Exp)
  • Magnetic fields
    • Exp.B_z
    • Exp.B_mw
    • Exp.freq_mw
  • Time
    • Exp.t_scale
    • Exp.t_points
• Simulation Options (SimOpt)
  • Grid
    • SimOpt.grid
    • SimOpt.grid_points
    • SimOpt.theta / SimOpt.phi
    • SimOpt.sym
  • Simulation modes
    • SimOpt.space
    • SimOpt.pop_evolution
    • SimOpt.eigval_mode
    • SimOpt.extend_t
  • Calculation settings
    • SimOpt.cpu_cores
    • SimOpt.CUPY
• Limitations and known issiues
  • Limitations
    • Appropriate relaxation times and time traces
    • Relaxation models
    • Secular approximation
  • Known issiues
    • RuntimeError on Windows system
    • Bends in the spectrum for long times
    • Hyperfine coupling in coupled systems
• Developer
  • Specific simulation modules
    • creators.py
    • density_matrices.py
    • hamiltonians.py
    • hyperfine.py
    • input_handler.py
    • relaxation.py
    • signals_and_processing.py
    • simulations.py
  • General modules
    • convolution.py
    • grid.py
    • orientation_dependent_ham.py
  • Structuring modules
    • matrix_tools.py
    • multioperator_tools.py

Indices and tables

• Index

• Module Index

• Search Page