Documentation of Phonon Lifetime Package

This is a Python package.

phonon_lifetime

• phonon_lifetime package
  • StrainSystem
    • StrainSystem.cell
    • StrainSystem.strain
    • StrainSystem.strain_repeats
  • Subpackages
    • phonon_lifetime.cell package
      • PrimitiveCell
      • SuperCell
      • UnitCell
      • as_ase_atoms()
      • from_ase_atoms()
      • get_atom_positions()
      • plot_xy()
      • plot_xyz()
      • Submodules
      • phonon_lifetime.cell.build module
    • phonon_lifetime.defect package
      • DefectCell
      • MassDefect
      • MassDefectCell
      • VacancyDefect
      • VacancyDefectCell
      • as_pristine_gamma_phonon()
      • as_pristine_gamma_phonons()
      • as_pristine_phonon()
      • as_pristine_phonons()
      • as_pristine_strain_system()
      • with_mass_defect()
      • with_vacancy_defect()
    • phonon_lifetime.phonon package
      • BodyCenteredCubicPoint
      • CubicPoint
      • DispersionPath
      • DispersionPathPhonons
      • DispersionPathPoint
      • DispersionSegment
      • DispersionSegmentPhonons
      • FaceCenteredCubicPoint
      • GammaPhonon
      • GammaPhonons
      • HexagonalPoint
      • MeshPhonon
      • MeshPhonons
      • Phonon
      • Phonons
      • animate_phonon_1d_x()
      • animate_phonon_xy()
      • animate_phonon_xyz()
      • as_gamma_phonon()
      • as_gamma_phonons()
      • as_supercell_phonon()
      • as_supercell_phonons()
      • get_dispersion_path()
      • get_dispersion_segment()
      • get_displacement()
      • get_gamma_phonon()
      • get_gamma_phonons()
      • get_mesh_phonon()
      • get_mesh_phonons()
      • get_phonon()
      • get_phonons()
      • plot_dispersion_path()
      • plot_dispersion_segment()
      • plot_phonon_1d_x()
      • plot_phonon_xy()
      • plot_phonon_xyz()
    • phonon_lifetime.system package
      • StrainSystem
      • as_supercell()
      • plot_xy()
      • plot_xyz()
      • with_ase_forces()
      • with_nearest_neighbor_forces()
      • with_zero_forces()
  • Submodules
  • phonon_lifetime.lifetimes module
    • calculate_finite_time_rates()
    • calculate_survival_probabilities()
    • calculate_survival_probability()
    • get_first_order_scatter()
    • get_state_overlap()
    • get_state_overlap_matrix()
    • plot_first_order_scatter()
    • plot_first_order_scatter_against_qx()
    • plot_overlap_weights()
    • plot_survival_probability()
  • phonon_lifetime.wannier module
    • plot_wannier_vector()