perturbopy.postproc.utils.spectra_plots.animate_pump_pulse

perturbopy.postproc.utils.spectra_plots.animate_pump_pulse(time_step, elec_delta_occs_array, elec_kpoint_array, elec_energy_array, hole_delta_occs_array, hole_kpoint_array, hole_energy_array, pump_energy, plot_scale=1000.0)

Animate the pump pulse excitation for electrons and holes. Defines fig and ax, initializes scatter objects for electron and hole occupations, and calls update_scatter.

Parameters:
  • time_step (float) – Time step for the simulation. Only used for the title.

  • elec_delta_occs_array (numpy.ndarray) – Array of electron occupation changes.

  • elec_kpoint_array (numpy.ndarray) – Array of electron k-points.

  • elec_energy_array (numpy.ndarray) – Array of electron energies.

  • hole_delta_occs_array (numpy.ndarray) – Array of hole occupation changes.

  • hole_kpoint_array (numpy.ndarray) – Array of hole k-points.

  • hole_energy_array (numpy.ndarray) – Array of hole energies.

  • pump_energy (float) – Pump energy in eV, used only in title.

  • plot_scale (float) – Scale factor for the scatter object sizes.