radtools.plot_dos

radtools.plot_dos(input_folder='.', seedname=None, output_name='', energy_window=None, dos_window=None, efermi=0.0, separate=False, relative=False, normalize=False, verbose=False, interactive=False, save_pickle=False, save_txt=False, background_total=False, custom=None, colours=None, labels=None, legend_fontsize=12, axes_labels_fontsize=14, title_fontsize=18)

rad-plot-dos script.

Full documentation on the behaviour is available in the User Guide. Parameters of the function directly correspond to the arguments of the script.

Parameters:

input_folderstr, default "."

Relative or absolute path to the folder with PDOS files.

Console argument: -if / --input-folder

Metavar: "path"

Changed in version 0.8.0: Renamed from input_path

seednamestr, optional

Prefix for input files with PDOS(E).

In the case of Quantum Espresso-produced seedname is the same as specified in the QE projwfc.x input file (filpdos).

If it is not provided the script tries to detect it automatically in the rad-plot-dos_input-folder folder.

Console argument: -s / --seedname

Metavar: "name"

Changed in version 0.5.21: from "filpdos" to "seedname".

output_namestr, optional

Relative or absolute path to the folder for saving outputs.

Console argument: -on / --output-name

Metavar: "path"

energy_windowtuple of 2 float, optional

Energy window for the plots.

By default the whole energy range present in the files is plotted.

Console argument: -ew / --energy-window

Metavar: ("min", "max")

Changed in version 0.5.21: Renamed from "window" to "energy-window".

dos_windowtuple of 2 float, optional

DOS window for the plots.

By default the whole states/eV range is plotted.

Console argument: -dw / --dos-window

Metavar: ("min", "max")

Added in version 0.5.21.

efermifloat, default 0.0

Fermi energy.

Zero is shifted to Fermi energy.

Console argument: -ef / --efermi

Metavar: "energy"

separatebool, default False

Whether to plot projected DOS for each atom of the same type separately.

Console argument: -sep / --separate

relativebool, default False

Whether to use relative style.

Console argument: -r / --relative

normalizebool, default False

Whether to normalized PDOS values to 1.

Console argument: -n / --normalize

(with respect to LDOS of each plot or to total PDOS if -bt, --background-total is used).

verbosebool, default False

Verbose output, propagates to the called methods.

Console argument: -v / --verbose

interactivebool, default False

Interactive plotting.

Console argument: -i / --interactive

save_picklebool, default False

Whether to save figures as .pickle files.

Console argument: -sp / --save-pickle

Added in version 0.5.21.

save_txtbool, default False

Whether to save some data as txt files.

It does not affect "pdos-vs-dos.png", because these data are accessible directly from PDOS input files.

Console argument: -st / --save-txt

Added in version 0.5.21.

background_totalbool, default False

Whether to use total PDOS as the background for all plots.

Console argument: -bt / --background-total

Added in version 0.5.21.

customlist of str, optional

Custom PDOS plot. See Custom plots for info.

Console argument: --custom

Metavar: "description"

Added in version 0.7.5.

colourslist of str, optional

Colours for the relative and custom plots.

Values are passed directly to the matplotlib as strings, therefore any valid value is allowed. Examples: "red" or "#FF0000". When custom is used the order of colours is the same as for the values of the custom.

Console argument: -cls / --colours

Added in version 0.7.5.

labelslist of str, optional

Labels for the custom plots.

Amount of labels have to be the same as the amount of custom strings, or one more. If one more, then first one is interpreted as the label for the background (Use "None" to switch it off). If the amount of argument is one more and the first one is None, then the label for the total PDOS is switched off and the total PDOS itself is not plotted.

Console argument: -lbs / --labels

Added in version 0.7.6.

legend_fontsizeint, default 12

Fontsize of the legend.

Console argument: -lfs / --legend-fontsize

Metavar: "fontsize"

Added in version 0.7.8.

axes_labels_fontsizeint, default 14

Fontsize of the labes of the axes.

Console argument: -alfs / --axes-labels-fontsize

Metavar: "fontsize"

Added in version 0.7.8.

title_fontsizeint, default 18

Fontsize of the title.

Console argument: -tfs / --title-fontsize

Metavar: "fontsize"

Added in version 0.7.8.