pyprocar.plotter.DOSPlot#

class pyprocar.plotter.DOSPlot(dos: DensityOfStates | None = None, structure: Structure | None = None, ax: Axes | None = None, **kwargs)[source]#

Class to plot an electronic band structure.

Parameters:

  • dos (DensityOfStates) – An density of states pyprocar.core.DensityOfStates.

  • structure (Structure) – An density of states pyprocar.core.Structure.

  • ax (mpl.axes.Axes, optional) – A matplotlib Axes object. If provided the plot will be located at that ax. The default is None.

Return type:

None.

Methods

DOSPlot.__init__([dos, structure, ax])

DOSPlot.draw_fermi(value[, orientation])

A method to draw the fermi surface

DOSPlot.grid()

A method to include a grid on the plot.

DOSPlot.legend([labels])

A method to include the legend

DOSPlot.plot_dos([spins, orientation])

Plot the plain density of states.

DOSPlot.plot_parametric([atoms, orbitals, ...])

The method will plot the parametric density of states

DOSPlot.plot_parametric_line([atoms, spins, ...])

A method to plot the parametric line plot

DOSPlot.plot_stack([items, spins, ...])

A method to plot dos contributions stacked.

DOSPlot.plot_stack_orbitals([atoms, spins, ...])

A method to plot dos orbitals contribution stacked.

DOSPlot.plot_stack_species([...])

A method to plot the dos with the species contribution stacked on eachother

DOSPlot.save([filename])

A method to save the plot

DOSPlot.set_xlabel(label)

A method to set the x label

DOSPlot.set_xlim([interval])

A method to set the xlim of the plot

DOSPlot.set_xticks([tick_positions, tick_names])

A method to set the xticks of the plot

DOSPlot.set_ylabel(label)

A method to set the y label

DOSPlot.set_ylim([interval])

A method to set the ylim of the plot

DOSPlot.set_yticks([tick_positions, tick_names])

A method to set the yticks of the plot

DOSPlot.show()

A method to show the plot

DOSPlot.update_config(config_dict)