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

Base class for all plots

BandsPlot

Plots band structure energies, with plentiful of customization options.

FatbandsPlot

Plots band structure energies showing the contribution of orbitals to each state.

GeometryPlot

Plots a geometry structure, with plentiful of customization options.

SitesPlot

Plots sites from an object that can be parsed into a geometry.

GridPlot

Plots a grid, with plentiful of customization options.

WavefunctionPlot

Plots a wavefunction in real space.

PdosPlot

Plot the projected density of states.

AtomicMatrixPlot

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

Base figure class that all backends should inherit from.