API

QDYN’s public “application programming interface” (API) is exposed through a single qdyn module. Additionally, the qdyn_global_mod module defines several constants (one, half, czero, Pi etc.) that can be used throughout QDYN.

• QDYN Module
• Data Structures

Internally, the public routines exposed by the qdyn module are organized in sub-modules. For advanced use cases, it may be necessary to access these sub-modules directly.

Note

To find the documentation of a particular routine, if you don’t know which module to look in, use the Sphinx search field at the top of the navigational menu.

• Structure of the QDYN library
• QDYN Sub-Modules
  • Module qdyn_blas_mod
  • Module qdyn_channel_coupling_mod
  • Module qdyn_cheby_mod
  • Module qdyn_debug_mod
  • Module qdyn_diag_mod
  • Module qdyn_eigensystem_mod
  • Module qdyn_error_mod
  • Module qdyn_exp_mod
  • Module qdyn_global_mod
  • Module qdyn_grid_mod
  • Module qdyn_ham_mod
  • Module qdyn_inhom_cheby_mod
  • Module qdyn_inhom_newton_mod
  • Module qdyn_inhom_prop_mod
  • Module qdyn_inhom_rk45_mod
  • Module qdyn_inout_mod
  • Module qdyn_kin_mod
  • Module qdyn_krotov_mod
  • Module qdyn_krotov2_bwr_mod
  • Module qdyn_lbfgs_mod
  • Module qdyn_local_invariants_mod
  • Module qdyn_map_mod
  • Module qdyn_markov_mod
  • Module qdyn_math_mod
  • Module qdyn_mctdhf_mod
  • Module qdyn_mcwf_mod
  • Module qdyn_mpi_utils_mod
  • Module qdyn_newton_mod
  • Module qdyn_nito_mod
  • Module qdyn_nlevel_spin_mod
  • Module qdyn_numerov_mod
  • Module qdyn_observables_mod
  • Module qdyn_oct_mod
  • Module qdyn_oct_funcs_mod
  • Module qdyn_oct_lv_targets_mod
  • Module qdyn_oct_targets_mod
  • Module qdyn_octutils_mod
  • Module qdyn_op_mod
  • Module qdyn_op_matrices_mod
  • Module qdyn_para_mod
  • Module qdyn_parser_mod
  • Module qdyn_praxis_mod
  • Module qdyn_prop_mod
  • Module qdyn_prop_exact_mod
  • Module qdyn_prop_seg_storage_mod
  • Module qdyn_psi_mod
  • Module qdyn_pulse_mod
  • Module qdyn_pulse_coupling_mod
  • Module qdyn_random_mod
  • Module qdyn_rho_mod
  • Module qdyn_rk45_mod
  • Module qdyn_rotation_mod
  • Module qdyn_scattering_mod
  • Module qdyn_sceint_mod
  • Module qdyn_schirmer_mod
  • Module qdyn_spa_mod
  • Module qdyn_sparse_mod
  • Module qdyn_specrad_mod
  • Module qdyn_spectra_mod
  • Module qdyn_spin_chain_mod
  • Module qdyn_spline_mod
  • Module qdyn_state_mod
  • Module qdyn_units_mod
  • Module qdyn_vmi_mod
  • Module qdyn_window_mod