Visualization

The visualization module contains tools to plot common visualizations, as well as to create custom visualizations that support multiple plotting backends automatically.

Plot classes

Plot classes are workflow classes that implement some specific plotting.

Plot(*args, **kwargs)	Base class for all plots
BandsPlot(bands_data[, Erange, E0, E_axis, ...])	Plots band structure energies, with plentiful of customization options.
FatbandsPlot(bands_data[, Erange, E0, ...])	Plots band structure energies showing the contribution of orbitals to each state.
GeometryPlot(geometry[, axes, atoms, ...])	Plots a geometry structure, with plentiful of customization options.
SitesPlot(sites_obj[, axes, sites, ...])	Plots sites from an object that can be parsed into a geometry.
GridPlot([grid, axes, represent, ...])	Plots a grid, with plentiful of customization options.
WavefunctionPlot(eigenstate[, i, geometry, ...])	Plots a wavefunction in real space.
PdosPlot(pdos_data[, groups, Erange, ...])	Plot the projected density of states.
AtomicMatrixPlot(matrix[, dim, isc, ...])	Plots a (possibly sparse) matrix where rows and columns are either orbitals or atoms.

Utilities

Utilities to build custom plots

get_figure(backend, plot_actions, *args, ...)	Get a figure object.
merge_plots(*figures[, composite_method, ...])	Combines multiple plots into a single figure.
subplots(*figures[, rows, cols, arrange, ...])	Combines multiple plots into a single figure using subplots.
animation(*figures[, frame_duration, ...])	Combines multiple plots into a single figure using an animation.
Figure(plot_actions, *args, **kwargs)	Base figure class that all backends should inherit from.