surfinpy.plotting

class surfinpy.plotting.ChemicalPotentialPlot(x, y, z, labels, ticks, colors, xlabel, ylabel)

Bases: object

Class that plots a phase diagram as a function of chemical potential.

Parameters

• x (array_like) – x axis, chemical potential of species x

• y (array_like) – y axis, chemical potential of species y

• z (array_like) – two dimensional grid, phase info

• labels (list) – list): of phase labels

• ticks (list) – list): of phases

• colors (list) – list): of phases

• xlabel (str) – species name for x axis label

• ylabel (str) – species name for y axis label

plot_mu_p(temperature, colourmap=None, set_style=None, cbar_title=None, figsize=(6, 6))

Plots a phase diagram with two sets of axis, one as a function of chemical potential and the second is as a function of pressure.

Parameters

• temperature (int) – temperature

• colourmap (str) – colourmap for the plot

• set_style (str) – Plot style

• cbar_label (str) – Label for colorbar

plot_phase(temperature=None, colourmap=None, set_style=None, figsize=None, cbar_title=None)

Plots a simple phase diagram as a function of chemical potential.

Parameters

• temperature (int) – Temperature.

• colourmap (str) – Colourmap for the plot.

• set_style (str) – Plot style

• figsize (tuple) – Set a custom figure size.

plot_pressure(temperature, colourmap=None, set_style=None, figsize=(6, 6), cbar_title=None)

Plots a phase diagram as a function of pressure.

Parameters

• temperature (int) – temperature

• colourmap (str) – colourmap for the plot

• set_style (str) – Plot style

class surfinpy.plotting.MuTPlot(x, y, z, labels, ticks, colors, xlabel, ylabel)

Bases: object

Class that plots a phase diagram as a function of chemical potential and temperature.

Parameters

• x (array_like) – x axis, chemical potential of species x

• y (array_like) – y axis, chemical potential of species y

• z (array_like) – two dimensional grid, phase info

• labels (list) – list): of phase labels

• ticks (list) – list): of phases

• colors (list) – list): of phases

• xlabel (str) – species name for x axis label

• ylabel (str) – species name for y axis label

plot_mu_vs_t(colourmap=None, set_style=None, figsize=(6, 6), cbar_title=None)

Plots a simple phase diagram as a function of chemical potential.

Parameters

• colourmap (str) – Colourmap for the plot. Default=’viridis’

• set_style (str) – Plot style

• figsize (tuple) – Set a custom figure size.

plot_mu_vs_t_vs_p(temperature, colourmap=None, set_style=None, figsize=(6, 6), cbar_title=None)

Plots a simple phase diagram as a function of chemical potential.

Parameters

• temperature (int) – Temperature.

• colourmap (str) – Colourmap for the plot. Default=’viridis’

• set_style (str) – Plot style

• figsize (tuple) – Set a custom figure size.

plot_p_vs_t(temperature, colourmap=None, set_style=None, figsize=(6, 6), cbar_title=None)

Plots a simple phase diagram as a function of chemical potential.

Parameters

• temperature (int) – Temperature.

• colourmap (str) – Colourmap for the plot. Default=’viridis’

• set_style (str) – Plot style

• figsize (tuple) – Set a custom figure size.

class surfinpy.plotting.PTPlot(x, y, z)

Bases: object

Class for plotting of temperature vs pressure phase diagrams.

Parameters

• x (array_like) – x axis

• y (array_like) – y axis

• z (array_like) – two dimensional array of phases

plot(colourmap='viridis', set_style=None, figsize=(6, 6), ylabel='log P (bar)', xlabel='Temperature (K)')

plots phase diagram

Parameters

• colourmap (str) – colourmap for phase diagram

• set_style (str) – Plot style