euphonic.plot.dos module

euphonic.plot.dos.output_grace(data, seedname='out', mirror=False, up=True, down=True)

Creates a .agr Grace file of the dos

Parameters:

• data (PhononData or BandsData object) – Data object for which calculate_dos has been called, containing dos and dos_bins attributes for plotting
• seedname (string, optional) – Determines the figure title and output file name, seedname.agr. Default: ‘out’
• mirror (boolean) – Whether to reflect the dos_down frequencies in the x-axis. Default: False
• up (boolean, optional) – Whether to plot spin up dos (if applicable). Default: True
• down (boolean, optional) – Whether to plot spin down dos (if applicable). Default: True

euphonic.plot.dos.plot_dos(data, title='', mirror=False, up=True, down=True, **line_kwargs)

Creates a Matplotlib figure of the density of states

Parameters:

• data (PhononData or BandsData object) – Data object for which calculate_dos has been called, containing dos and dos_bins attributes for plotting
• title (string) – The figure title. Default: ‘’
• mirror (boolean) – Whether to reflect the dos_down frequencies in the x-axis. Default: False
• up (boolean, optional) – Whether to plot spin up dos (if applicable). Default: True
• down (boolean, optional) – Whether to plot spin down dos (if applicable). Default: True
• **line_kwargs (matplotlib.line.Line2D properties, optional) – Used in the axes.plot command to specify properties like linewidth, linestyle

Returns:

fig – If matplotlib.pyplot can be imported, returns a Figure containing the subplot containing the plotted density of states, otherwise returns None

Return type:

Matplotlib Figure or None