pycalphad.plot package¶

Subpackages¶

pycalphad.plot.binary package

Submodules¶

pycalphad.plot.eqplot module¶

The eqplot module contains functions for general plotting of the results of equilibrium calculations.

pycalphad.plot.eqplot.eqplot(eq, ax=None, x=None, y=None, z=None, tielines=True, tieline_color=(0, 1, 0, 1), tie_triangle_color=(1, 0, 0, 1), legend_generator=<function phase_legend>, **kwargs)[source]¶

Plot the result of an equilibrium calculation.

The type of plot is controlled by the degrees of freedom in the equilibrium calculation.

Parameters:

eq (xarray.Dataset) – Result of equilibrium calculation.
ax (matplotlib.Axes) – Default axes used if not specified.
x (StateVariable, optional)
y (StateVariable, optional)
z (StateVariable, optional)
tielines (bool) – If True, will plot tielines
tieline_color (color) – A valid matplotlib color, such as a named color string, hex RGB string, or a tuple of RGBA components to set the color of the two phase region tielines. The default is an RGBA tuple for green: (0, 1, 0, 1).
tie_triangle_color (color) – A valid matplotlib color, such as a named color string, hex RGB string, or a tuple of RGBA components to set the color of the two phase region tielines. The default is an RGBA tuple for red: (1, 0, 0, 1).
legend_generator (Callable) – A function that will be called with the list of phases and will return legend labels and colors for each phase. By default pycalphad.plot.utils.phase_legend is used
kwargs (kwargs) – Passed to matplotlib.pyplot.scatter.

Return type:

matplotlib AxesSubplot

pycalphad.plot.ternary module¶

The ternary module enables plotting of ternary isobaric phase diagrams.

pycalphad.plot.ternary.ternplot(dbf, comps, phases, conds, x=None, y=None, eq_kwargs=None, **plot_kwargs)[source]¶

Calculate the ternary isothermal, isobaric phase diagram. This function is a convenience wrapper around equilibrium() and eqplot().

Parameters:

dbf (Database) – Thermodynamic database containing the relevant parameters.
comps (list) – Names of components to consider in the calculation.
phases (list) – Names of phases to consider in the calculation.
conds (dict) – Maps StateVariables to values and/or iterables of values. For ternplot only one changing composition and one potential coordinate each is supported.
x (v.MoleFraction) – instance of a pycalphad.variables.composition to plot on the x-axis. Must correspond to an independent condition.
y (v.MoleFraction) – instance of a pycalphad.variables.composition to plot on the y-axis. Must correspond to an independent condition.
eq_kwargs (optional) – Keyword arguments to equilibrium().
plot_kwargs (optional) – Keyword arguments to eqplot().

Return type:

A phase diagram as a figure.

Examples

None yet.

pycalphad.plot.triangular module¶

Users should not have to instantiate the TriangularAxes class directly. Instead, the projection name can be passed as a keyword argument to matplotlib.

>>> import matplotlib.pyplot as plt
>>> import numpy as np
>>> plt.gca(projection='triangular')
>>> plt.scatter(np.random.random(10), np.random.random(10))

class pycalphad.plot.triangular.TriangularAxes(*args, **kwargs)[source]¶

Bases: Axes

A custom class for triangular projections.

can_zoom()[source]¶: Return True if this axes support the zoom box

clear()[source]¶

Hard-code axes limits to be on [0, 1] for both axes.

Warning: Limits not on [0, 1] may lead to clipping issues!

drag_pan(button, key, x, y)[source]¶

Called when the mouse moves during a pan operation.

Parameters:

button (.MouseButton) – The pressed mouse button.
key (str or None) – The pressed key, if any.
x (float) – The mouse coordinates in display coords.
y (float) – The mouse coordinates in display coords.

Notes

This is intended to be overridden by new projection types.

end_pan()[source]¶

Called when a pan operation completes (when the mouse button is up.)

Notes

This is intended to be overridden by new projection types.

get_xaxis_text1_transform(pad)[source]¶

Returns:

transform (Transform) – The transform used for drawing x-axis labels, which will add pad_points of padding (in points) between the axis and the label. The x-direction is in data coordinates and the y-direction is in axis coordinates
valign ({‘center’, ‘top’, ‘bottom’, ‘baseline’, ‘center_baseline’}) – The text vertical alignment.
halign ({‘center’, ‘left’, ‘right’}) – The text horizontal alignment.

Notes