Difference between revisions of "Yambo Post Processing (ypp)"

From The Yambo Project
Jump to navigation Jump to search
 
(3 intermediate revisions by one other user not shown)
Line 13: Line 13:


* Convertions:
* Convertions:
  '''-y'''  →    Remove symmetries not consistent with an external perturbation, see [https://www.yambo-code.org/wiki/index.php?title=Prerequisites_for_Real_Time_propagation_with_Yambo Real Time propagation with Yambo] and [https://www.attaccalite.com/lumen/linear_response.html Linear response in real-time]
  '''-y'''  →    Remove symmetries not consistent with an external perturbation, see [https://www.yambo-code.eu/wiki/index.php?title=Prerequisites_for_Real_Time_propagation_with_Yambo Real Time propagation with Yambo] and [https://www.attaccalite.com/lumen/linear_response.html Linear response in real-time]
  '''-qpdb g''' →  generate-modify quasi-particle(QP) database
  '''-qpdb g''' →  generate-modify quasi-particle(QP) database
  '''-qpdb m''' →  merge quasi-particle(QP) databases
  '''-qpdb m''' →  merge quasi-particle(QP) databases
Line 24: Line 24:
  '''-s s'''  → Plot electron density of states
  '''-s s'''  → Plot electron density of states
  '''-s m'''  → Plot electron magnetization
  '''-s m'''  → Plot electron magnetization
  '''-s b'''  → Interpolate electronic bands using the approach of Ref.<ref>Warren E. Pickett, Henry Krakauer, and Philip B. Allen  [https://journals.aps.org/prb/abstract/10.1103/PhysRevB.38.2721 PRB 38 p2721 (1988)]</ref>, adding  '''-V qp''' includes the quasi-particle correction
  '''-s b'''  → Interpolate electronic bands using the approach of Ref.<ref name='interp'>Warren E. Pickett, Henry Krakauer, and Philip B. Allen  [https://journals.aps.org/prb/abstract/10.1103/PhysRevB.38.2721 PRB 38 p2721 (1988)]</ref>, adding  '''-V qp''' includes the quasi-particle correction
  '''-s c'''  → Plot the current density
  '''-s c'''  → Plot the current density


   '''-e s'''  → Sort exciton according to their energy and dipole, see [https://www.yambo-code.org/wiki/index.php?title=How_to_analyse_excitons How to analyze excitons]
   '''-e s'''  → Sort exciton according to their energy and dipole, see [https://www.yambo-code.eu/wiki/index.php?title=How_to_analyse_excitons How to analyze excitons]
   '''-e sp''' → Plot exciton spin
   '''-e sp''' → Plot exciton spin
   '''-e a'''  → Write exciton coefficients amplitudes  
   '''-e a'''  → Write exciton coefficients amplitudes  
   '''-e w'''  → Plot excitonic wave-function for fixed hole position, see [https://www.yambo-code.org/wiki/index.php?title=How_to_analyse_excitons How to analyze excitons]
   '''-e w'''  → Plot excitonic wave-function for fixed hole position, see [https://www.yambo-code.eu/wiki/index.php?title=How_to_analyse_excitons How to analyze excitons]
   '''-e i'''  → Interpolate excitonic dispersion, requires BSE for all q-points, see [https://www.yambo-code.org/wiki/index.php?title=How_to_analyse_excitons How to analyze excitons]
   '''-e i'''  → Interpolate excitonic dispersion<ref name='interp'></ref>, requires BSE for all q-points, see [https://www.yambo-code.eu/wiki/index.php?title=How_to_analyse_excitons How to analyze excitons]
   '''-dipoles exc'''  →  Print excitonic dipoles, see [https://www.yambo-code.org/wiki/index.php?title=How_to_analyse_excitons#Sort_the_excitonic_eigenvalues How to analyze excitons]
   '''-dipoles exc'''  →  Print excitonic dipoles, see [https://www.yambo-code.eu/wiki/index.php?title=How_to_analyse_excitons#Sort_the_excitonic_eigenvalues How to analyze excitons]
   '''-dipoles ip'''  →  Print Kohn-Sham dipole matrix elements
   '''-dipoles ip'''  →  Print Kohn-Sham dipole matrix elements
   '''-freehole'''  →  Plot excitonic wave-function with free hole position
   '''-freehole'''  →  Plot excitonic wave-function with free hole position
   '''-avehole'''  → Plot excitonic wave-function with average hole/electron wavefunction, see  [https://www.yambo-code.org/wiki/index.php?title=How_to_analyse_excitons How to analyze excitons]
   '''-avehole'''  → Plot excitonic wave-function with average hole/electron wavefunction, see  [https://www.yambo-code.eu/wiki/index.php?title=How_to_analyse_excitons How to analyze excitons]


* SOC:
* SOC:
Line 42: Line 42:
Special features in '''ypp_ph''':  
Special features in '''ypp_ph''':  


  '''-g g''' → Read GKKP databases from QuantumEspresso, see [https://www.yambo-code.org/wiki/index.php?title=Electron_Phonon_Coupling Electron phonon coupling]
  '''-g g''' → Read GKKP databases from QuantumEspresso, see [https://www.yambo-code.eu/wiki/index.php?title=Electron_Phonon_Coupling Electron phonon coupling]
  '''-g d''' → Read double-grid for phonons, see [https://www.yambo-code.org/wiki/index.php?title=Electron_Phonon_Coupling Electron phonon coupling]
  '''-g d''' → Read double-grid for phonons, see [https://www.yambo-code.eu/wiki/index.php?title=Electron_Phonon_Coupling Electron phonon coupling]
  '''-g p''' → Plot the module of the gkkp matrix elements
  '''-g p''' → Plot the module of the gkkp matrix elements


  '''-p d''' → Phonon density of states
  '''-p d''' → Phonon density of states
  '''-p e''' → Electronic Eliashberg functions, see [https://www.yambo-code.org/wiki/index.php?title=Electron_Phonon_Coupling Electron phonon coupling]
  '''-p e''' → Electronic Eliashberg functions, see [https://www.yambo-code.eu/wiki/index.php?title=Electron_Phonon_Coupling Electron phonon coupling]


  '''-e e''' → Excitonic Eliashberg functions, see  [https://www.yambo-code.org/wiki/index.php?title=Optical_properties_at_finite_temperature Optical properties at finite temperature]
  '''-e e''' → Excitonic Eliashberg functions, see  [https://www.yambo-code.eu/wiki/index.php?title=Optical_properties_at_finite_temperature Optical properties at finite temperature]
  '''-e g''' → Exciton-phonon matrix elements (only diagonal part)
  '''-e g''' → Exciton-phonon matrix elements (only diagonal part)
  '''-e p''' → Phonon-assisted excitonic density of state,  [https://www.yambo-code.org/wiki/index.php?title=Optical_properties_at_finite_temperature Optical properties at finite temperature]
  '''-e p''' → Phonon-assisted excitonic density of state,  [https://www.yambo-code.eu/wiki/index.php?title=Optical_properties_at_finite_temperature Optical properties at finite temperature]


Special features in '''ypp_nl''':
'''-u''' → Analise the non-linear response, see [https://www.yambo-code.eu/wiki/index.php?title=Real_time_approach_to_non-linear_response#Analysis_of_the_results Non-linear spectroscopy]


== References ==
== References ==

Latest revision as of 09:34, 23 February 2024

YPP is a post-processing tool included in the Yambo distribution.
In this tutorial we present a non-exhaustive list of the things that can be calculated with this tool.


  • Brillouin Zone:
-k p → write the k-point list in different format
-k q → write the q-point list in different format
-k s → generate shifted k-points grid
-k h → write the highest symmetry points in the BZ
-k r → generate random k-points in the BZ
-k e → generate regular k-points grids 
-map → map a fine grid of k-points on the coarse one, see Double-grid in Yambo
  • Convertions:
-y  →     Remove symmetries not consistent with an external perturbation, see Real Time propagation with Yambo and Linear response in real-time
-qpdb g →  generate-modify quasi-particle(QP) database
-qpdb m →  merge quasi-particle(QP) databases
-qpdb e →  expand quasi-particle(QP) database in the full Brillouin zone(BZ)
  • Plots:
-b → Select the momentum of the exciton you want to analize (default = 1)
-s w  → Plot electron wave-functions
-s d  → Plot electron density
-s s  → Plot electron density of states
-s m  → Plot electron magnetization
-s b  → Interpolate electronic bands using the approach of Ref.[1], adding  -V qp includes the quasi-particle correction
-s c  → Plot the current density
 -e s  → Sort exciton according to their energy and dipole, see How to analyze excitons
 -e sp → Plot exciton spin
 -e a  → Write exciton coefficients amplitudes 
 -e w  → Plot excitonic wave-function for fixed hole position, see How to analyze excitons
 -e i  → Interpolate excitonic dispersion[1], requires BSE for all q-points, see How to analyze excitons
 -dipoles exc  →   Print excitonic dipoles, see How to analyze excitons
 -dipoles ip  →   Print Kohn-Sham dipole matrix elements
 -freehole   →  Plot excitonic wave-function with free hole position
 -avehole  → Plot excitonic wave-function with average hole/electron wavefunction, see  How to analyze excitons
  • SOC:
  -soc   →  Perturbative SOC mapping

Special features in ypp_ph:

-g g → Read GKKP databases from QuantumEspresso, see Electron phonon coupling
-g d → Read double-grid for phonons, see Electron phonon coupling
-g p → Plot the module of the gkkp matrix elements
-p d → Phonon density of states
-p e → Electronic Eliashberg functions, see Electron phonon coupling
-e e → Excitonic Eliashberg functions, see  Optical properties at finite temperature
-e g → Exciton-phonon matrix elements (only diagonal part)
-e p → Phonon-assisted excitonic density of state,  Optical properties at finite temperature

Special features in ypp_nl:

-u → Analise the non-linear response, see Non-linear spectroscopy

References

  1. 1.0 1.1 Warren E. Pickett, Henry Krakauer, and Philip B. Allen PRB 38 p2721 (1988)