Plotters and formatoptions for the psy-simple plugin.

Classes:

AlternativeXCoord(key[, plotter, ...])	Use an alternative variable as x-coordinate
AlternativeXCoordPost(key[, plotter, ...])	Use an alternative variable as x-coordinate
ArrowSize(key[, plotter, index_in_list, ...])	Change the size of the arrows
ArrowStyle(key[, plotter, index_in_list, ...])	Change the style of the arrows
AxisColor(key[, plotter, index_in_list, ...])	Color the x- and y-axes
BarAlpha(key[, plotter, index_in_list, ...])	Specify the transparency (alpha)
BarPlot(*args, **kwargs)	Choose how to make the bar plot
BarPlotter([data, ax, auto_update, project, ...])	Plotter for making bar plots
BarWidths(key[, plotter, index_in_list, ...])	Specify the widths of the bars
BarXTickLabels(*args, **kwargs)	Modify the x-axis ticklabels
BarXTicks(*args, **kwargs)	Modify the x-axis ticks
BarXlabel(key[, plotter, index_in_list, ...])	Set the x-axis label
BarXlim(*args, **kwargs)	Set the x-axis limits
BarYTickLabels(*args, **kwargs)	Modify the y-axis ticklabels
BarYTicks(*args, **kwargs)	Modify the y-axis ticks
BarYlabel(key[, plotter, index_in_list, ...])	Set the y-axis label
BarYlim(*args, **kwargs)	Set the y-axis limits
Base2D([data, ax, auto_update, project, ...])	Base plotter for 2-dimensional plots
BaseVectorPlotter([data, ax, auto_update, ...])	Base plotter for vector plots
Bounds(*args, **kwargs)	Specify the boundaries of the colorbar
CLabel(key[, plotter, index_in_list, ...])	Show the colorbar label
CMap(key[, plotter, index_in_list, ...])	Specify the color map
CTickLabels(*args, **kwargs)	Specify the colorbar ticklabels
CTickProps(key[, plotter, index_in_list, ...])	Specify the font properties of the colorbar ticklabels
CTickSize(key[, plotter, index_in_list, ...])	Specify the font size of the colorbar ticklabels
CTickWeight(key[, plotter, index_in_list, ...])	Specify the fontweight of the colorbar ticklabels
CTicks(*args, **kwargs)	Specify the tick locations of the colorbar
CategoricalBars(key[, plotter, ...])	The location of each bar
Cbar(*args, **kwargs)	Specify the position of the colorbars
CbarOptions(key[, plotter, index_in_list, ...])	Base class for colorbar formatoptions
CbarSpacing(key[, plotter, index_in_list, ...])	Specify the spacing of the bounds in the colorbar
CombinedBase([data, ax, auto_update, ...])	Base plotter for combined 2-dimensional scalar and vector plot
CombinedSimplePlotter([data, ax, ...])	Combined 2D plotter and vector plotter
CombinedVectorPlot(*args, **kwargs)	Choose the vector plot type
ContourLevels(*args, **kwargs)	The levels for the contour plot
DataGrid(*args, **kwargs)	Show the grid of the data
DataPrecision(key[, plotter, index_in_list, ...])	Set the precision of the data
DataTicksCalculator(*args, **kwargs)	Abstract base formatoption to calculate ticks and bounds from the data
Density(*args, **kwargs)	Change the density of the arrows
DensityPlotter([data, ax, auto_update, ...])	A plotter to visualize the density of points in a 2-dimensional grid
DtTicksBase(*args, **kwargs)	Abstract base class for x- and y-tick formatoptions
ErrorAlpha(key[, plotter, index_in_list, ...])	Set the alpha value for the error range
ErrorCalculator(key[, plotter, ...])	Calculation of the error
ErrorPlot(*args, **kwargs)	Visualize the error range
Extend(key[, plotter, index_in_list, ...])	Draw arrows at the side of the colorbar
FldmeanPlotter([data, ax, auto_update, ...])
Grid(key[, plotter, index_in_list, ...])	Display the grid
Hist2DXRange(*args, **kwargs)	Specify the range of the histogram for the x-dimension
Hist2DYRange(*args, **kwargs)	Specify the range of the histogram for the x-dimension
HistBins(key[, plotter, index_in_list, ...])	Specify the bins of the 2D-Histogramm
InterpolateBounds(key[, plotter, ...])	Interpolate grid cell boundaries for 2D plots
LabelOptions(key[, plotter, index_in_list, ...])	Base formatoption class for label sizes
LabelProps(key[, plotter, index_in_list, ...])	Set the font properties of both, x- and y-label
LabelSize(key[, plotter, index_in_list, ...])	Set the size of both, x- and y-label
LabelWeight(key[, plotter, index_in_list, ...])	Set the font size of both, x- and y-label
Legend(key[, plotter, index_in_list, ...])	Draw a legend
LegendLabels(key[, plotter, index_in_list, ...])	Set the labels of the arrays in the legend
LimitBase(*args, **kwargs)	Base class for x- and y-limits
LineColors(*args, **kwargs)	Set the color coding
LinePlot(*args, **kwargs)	Choose the line style of the plot
LinePlotter([data, ax, auto_update, ...])	Plotter for simple one-dimensional line plots
LineWidth(key[, plotter, index_in_list, ...])	Choose the width of the lines
Marker(key[, plotter, index_in_list, ...])	Choose the marker for points
MarkerSize(key[, plotter, index_in_list, ...])	Choose the size of the markers for points
MaskDataGrid(key[, plotter, index_in_list, ...])	Mask the datagrid where the array is NaN
MeanCalculator(key[, plotter, ...])	Determine how the error is visualized
MissColor(key[, plotter, index_in_list, ...])	Set the color for missing values
NormedHist2D(key[, plotter, index_in_list, ...])	Specify the normalization of the histogram
Plot2D(*args, **kwargs)	Choose how to visualize a 2-dimensional scalar data field
PointDensity(key[, plotter, index_in_list, ...])	Specify the method to calculate the density
ScalarCombinedBase([data, ax, auto_update, ...])	Base plotter for combined 2-dimensional scalar field with any other plotter
Simple2DBase([data, ax, auto_update, ...])	Base class for Simple2DPlotter and psyplot.plotter.maps.FieldPlotter that defines the data management
Simple2DPlotter([data, ax, auto_update, ...])	Plotter for visualizing 2-dimensional data.
SimplePlot2D(*args, **kwargs)	Specify the plotting method
SimplePlotterBase([data, ax, auto_update, ...])	Base class for all simple plotters
SimpleVectorPlot(*args, **kwargs)	Choose the vector plot type
SimpleVectorPlotter([data, ax, auto_update, ...])	Plotter for visualizing 2-dimensional vector data
SymmetricLimits(key[, plotter, ...])	Make x- and y-axis symmetric
TickLabels(*args, **kwargs)
TickLabelsBase(*args, **kwargs)	Abstract base class for ticklabels
TickPropsBase(key[, plotter, index_in_list, ...])	Abstract base class for tick parameters
TickSize(key[, plotter, index_in_list, ...])	Change the ticksize of the ticklabels
TickSizeBase(key[, plotter, index_in_list, ...])	Abstract base class for modifying tick sizes
TickWeight(key[, plotter, index_in_list, ...])	Change the fontweight of the ticks
TickWeightBase(key[, plotter, ...])	Abstract base class for modifying font weight of ticks
TicksBase(*args, **kwargs)	Abstract base class for calculating ticks
TicksManager(key[, plotter, index_in_list, ...])	Abstract base class for ticks formatoptions controlling major and minor ticks
TicksManagerBase(key[, plotter, ...])	Abstract base class for formatoptions handling ticks
TicksOptions(key[, plotter, index_in_list, ...])	Base class for ticklabels options that apply for x- and y-axis
Transpose(*args, **kwargs)	Switch x- and y-axes
VCLabel(key[, plotter, index_in_list, ...])	Show the colorbar label of the vector plot
VectorBounds(*args, **kwargs)	Specify the boundaries of the vector colorbar
VectorCTicks(*args, **kwargs)	Specify the tick locations of the vector colorbar
VectorCalculator(*args, **kwargs)	Abstract formatoption that provides calculation functions for speed, etc.
VectorCbar(*args, **kwargs)	Specify the position of the vector plot colorbars
VectorColor(*args, **kwargs)	Set the color for the arrows
VectorDataGrid(*args, **kwargs)
VectorLineWidth(*args, **kwargs)	Change the linewidth of the arrows
VectorPlot(*args, **kwargs)	Choose the vector plot type
ViolinPlot(*args, **kwargs)	Choose how to make the violin plot
ViolinPlotter([data, ax, auto_update, ...])	Plotter for making violin plots
ViolinXTickLabels(*args, **kwargs)	Modify the x-axis ticklabels
ViolinXTicks(*args, **kwargs)	Modify the x-axis ticks
ViolinXlim(*args, **kwargs)	Set the x-axis limits
ViolinYTickLabels(*args, **kwargs)	Modify the x-axis ticklabels
ViolinYTicks(*args, **kwargs)	Modify the y-axis ticks
ViolinYlim(*args, **kwargs)	Set the y-axis limits
XRotation(key[, plotter, index_in_list, ...])	Rotate the x-axis ticks
XTickLabels(*args, **kwargs)	Modify the x-axis ticklabels
XTickProps(key[, plotter, index_in_list, ...])	Specify the x-axis tick parameters
XTicks(*args, **kwargs)	Modify the x-axis ticks
XTicks2D(*args, **kwargs)	Modify the x-axis ticks
XYTickPlotter([data, ax, auto_update, ...])	Plotter class for x- and y-ticks and x- and y- ticklabels
Xlabel(key[, plotter, index_in_list, ...])	Set the x-axis label
Xlim(*args, **kwargs)	Set the x-axis limits
Xlim2D(*args, **kwargs)	Set the x-axis limits
YRotation(key[, plotter, index_in_list, ...])	Rotate the y-axis ticks
YTickLabels(*args, **kwargs)	Modify the y-axis ticklabels
YTickProps(key[, plotter, index_in_list, ...])	Specify the y-axis tick parameters
YTicks(*args, **kwargs)	Modify the y-axis ticks
YTicks2D(*args, **kwargs)	Modify the y-axis ticks
Ylabel(key[, plotter, index_in_list, ...])	Set the y-axis label
Ylim(*args, **kwargs)	Set the y-axis limits
Ylim2D(*args, **kwargs)	Set the y-axis limits

Functions:

convert_radian(coord, *variables)	Convert the given coordinate from radian to degree
format_coord_func(ax, ref)	Create a function that can replace the matplotlib.axes.Axes.format_coord()
round_to_05(n[, exp, mode])	Round to the next 0.5-value.

class psy_simple.plotters.AlternativeXCoord(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Use an alternative variable as x-coordinate

This formatoption let’s you specify another variable in the base dataset of the data array in case you want to use this as the x-coordinate instead of the raw data

Possible types

None

Use the default

str

The name of the variable to use in the base dataset

xarray.DataArray

An alternative variable with the same shape as the displayed array

Examples

To see the difference, we create a simple test dataset:

>>> import xarray as xr

>>> import numpy as np

>>> import psyplot.project as psy

>>> ds = xr.Dataset({
...     'temp': xr.Variable(('time', ), np.arange(5)),
...     'std': xr.Variable(('time', ), np.arange(5, 10))})
>>> ds
<xarray.Dataset>
Dimensions:  (time: 5)
Coordinates:
  * time     (time) int64 0 1 2 3 4
Data variables:
    temp     (time) int64 0 1 2 3 4
    std      (time) int64 5 6 7 8 9

If we create a plot with it, we get the 'time' dimension on the x-axis:

>>> plotter = psy.plot.lineplot(ds, name=['temp']).plotters[0]

>>> plotter.plot_data[0].dims
('time',)

If we however set the 'coord' keyword, we get:

>>> plotter = psy.plot.lineplot(
...     ds, name=['temp'], coord='std').plotters[0]

>>> plotter.plot_data[0].dims
('std',)

and 'std' is plotted on the x-axis.

Attributes:

data_dependent	bool or a callable.
data_iterator
group	str.
name	str.
priority	int.
use_raw_data	Bool.

Methods:

diff(value)	Checks whether the given value differs from what is currently set
get_alternative_coord(da, i)
replace_coord(i)	Replace the coordinate for the data array at the given position
update(value)	Method that is call to update the formatoption on the axes

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

property data_iterator

diff(value)

Checks whether the given value differs from what is currently set

Parameters:

value – A possible value to set (make sure that it has been validate via the validate attribute before)

Returns:

True if the value differs from what is currently set

Return type:

bool

get_alternative_coord(da, i)

group = 'data'

str. Key of the group name in groups of this formatoption keyword

name = 'Alternative X-Variable'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 30

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

replace_coord(i)

Replace the coordinate for the data array at the given position

Parameters:

• i (int) – The number of the data array in the raw data (if the raw data is not an interactive list, use 0)

• Returns –

• xarray.DataArray – The data array with the replaced coordinate

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

use_raw_data = True

Bool. If True, this Formatoption directly uses the raw_data, otherwise use the normal data

class psy_simple.plotters.AlternativeXCoordPost(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: AlternativeXCoord

Use an alternative variable as x-coordinate

This formatoption let’s you specify another variable in the base dataset of the data array in case you want to use this as the x-coordinate instead of the raw data

Possible types

None

Use the default

str

The name of the variable to use in the base dataset

xarray.DataArray

An alternative variable with the same shape as the displayed array

Examples

To see the difference, we create a simple test dataset:

>>> import xarray as xr

>>> import numpy as np

>>> import psyplot.project as psy

>>> ds = xr.Dataset({
...     'temp': xr.Variable(('time', ), np.arange(5)),
...     'std': xr.Variable(('time', ), np.arange(5, 10))})
>>> ds
<xarray.Dataset>
Dimensions:  (time: 5)
Coordinates:
  * time     (time) int64 0 1 2 3 4
Data variables:
    temp     (time) int64 0 1 2 3 4
    std      (time) int64 5 6 7 8 9

If we create a plot with it, we get the 'time' dimension on the x-axis:

>>> plotter = psy.plot.lineplot(ds, name=['temp']).plotters[0]

>>> plotter.plot_data[0].dims
('time',)

If we however set the 'coord' keyword, we get:

>>> plotter = psy.plot.lineplot(
...     ds, name=['temp'], coord='std').plotters[0]

>>> plotter.plot_data[0].dims
('std',)

and 'std' is plotted on the x-axis.

Attributes:

use_raw_data

Bool.

use_raw_data = False

Bool. If True, this Formatoption directly uses the raw_data, otherwise use the normal data

class psy_simple.plotters.ArrowSize(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Change the size of the arrows

Possible types

None

make no scaling

float

Factor scaling the size of the arrows

See also

arrowstyle, linewidth, density, color

Attributes:

dependencies	list of str.
group	str.
name	str.
plot	plot Formatoption instance in the plotter
priority	int.

Methods:

update(value)

Method that is call to update the formatoption on the axes

dependencies = ['plot']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

group = 'vector'

str. Key of the group name in groups of this formatoption keyword

name = 'Size of the arrows'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.ArrowStyle(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Change the style of the arrows

Possible types

str

Any arrow style string (see FancyArrowPatch)

Notes

This formatoption only has an effect for stream plots

See also

arrowsize, linewidth, density, color

Attributes:

dependencies	list of str.
group	str.
name	str.
plot	plot Formatoption instance in the plotter
priority	int.

Methods:

update(value)

Method that is call to update the formatoption on the axes

dependencies = ['plot']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

group = 'vector'

str. Key of the group name in groups of this formatoption keyword

name = 'Style of the arrows'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.AxisColor(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: DictFormatoption

Color the x- and y-axes

This formatoption colors the left, right, bottom and top axis bar.

Possible types

dict

Keys may be one of {‘right’, ‘left’, ‘bottom’, ‘top’}, the values can be any valid color or None.

Notes

The following color abbreviations are supported:

character	color
‘b’	blue
‘g’	green
‘r’	red
‘c’	cyan
‘m’	magenta
‘y’	yellow
‘k’	black
‘w’	white

In addition, you can specify colors in many weird and wonderful ways, including full names ('green'), hex strings ('#008000'), RGB or RGBA tuples ((0,1,0,1)) or grayscale intensities as a string ('0.8').

Attributes:

group	str.
name	str.
value2pickle	Return the current axis colors

Methods:

initialize_plot(value)	Method that is called when the plot is made the first time
update(value)	Method that is call to update the formatoption on the axes

group = 'axes'

str. Key of the group name in groups of this formatoption keyword

initialize_plot(value)

Method that is called when the plot is made the first time

Parameters:

value – The value to use for the initialization

name = 'Color of x- and y-axes'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

property value2pickle

Return the current axis colors

class psy_simple.plotters.BarAlpha(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Specify the transparency (alpha)

Possible types

float

A value between 0 (opaque) and 1 invisible

Attributes:

name	str.
priority	int.

Methods:

update(value)

Method that is call to update the formatoption on the axes

name = 'Transparency of the bars'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.BarPlot(*args, **kwargs)

Bases: Formatoption

Choose how to make the bar plot

Possible types

None

Don’t make any plotting

‘bar’

Create a usual bar plot with the bars side-by-side

‘stacked’

Create stacked plot

Attributes:

alpha	alpha Formatoption instance in the plotter
categorical	categorical Formatoption instance in the plotter
children	list of str.
color	color Formatoption instance in the plotter
data_dependent	bool or a callable.
dependencies	list of str.
group	str.
name	str.
plot_fmt	bool.
plotted_data	The data that is shown to the user
priority	int.
transpose	transpose Formatoption instance in the plotter
widths	widths Formatoption instance in the plotter

Methods:

get_xys(arr)
make_plot()
remove()	Method to remove the effects of this formatoption
update(value)	Method that is call to update the formatoption on the axes

property alpha

alpha Formatoption instance in the plotter

property categorical

categorical Formatoption instance in the plotter

children = ['color', 'transpose', 'alpha']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

property color

color Formatoption instance in the plotter

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

dependencies = ['widths', 'categorical']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

get_xys(arr)

group = 'plotting'

str. Key of the group name in groups of this formatoption keyword

make_plot()

name = 'Bar plot type'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

plot_fmt = True

bool. Has to be True if the formatoption has a make_plot method to make the plot.

property plotted_data

The data that is shown to the user

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

remove()

Method to remove the effects of this formatoption

This method is called when the axes is cleared due to a formatoption with requires_clearing set to True. You don’t necessarily have to implement this formatoption if your plot results are removed by the usual matplotlib.axes.Axes.clear() method.

property transpose

transpose Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

property widths

widths Formatoption instance in the plotter

class psy_simple.plotters.BarPlotter(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: SimplePlotterBase

Plotter for making bar plots

Attributes:

alpha	Specify the transparency (alpha)
categorical	The location of each bar
coord	Use an alternative variable as x-coordinate
plot	Choose how to make the bar plot
widths	Specify the widths of the bars
xlabel	Set the x-axis label
xlim	Set the x-axis limits
xticklabels	Modify the x-axis ticklabels
xticks	Modify the x-axis ticks
ylabel	Set the y-axis label
ylim	Set the y-axis limits
yticklabels	Modify the y-axis ticklabels
yticks	Modify the y-axis ticks

alpha

Specify the transparency (alpha)

Possible types

float

A value between 0 (opaque) and 1 invisible

categorical

The location of each bar

Possible types

None

If None, use a categorical plotting if the widths are 'equal', otherwise, not

bool

If True, use a categorical plotting

See also

widths

coord

Use an alternative variable as x-coordinate

This formatoption let’s you specify another variable in the base dataset of the data array in case you want to use this as the x-coordinate instead of the raw data

Possible types

None

Use the default

str

The name of the variable to use in the base dataset

xarray.DataArray

An alternative variable with the same shape as the displayed array

Examples

To see the difference, we create a simple test dataset:

>>> import xarray as xr

>>> import numpy as np

>>> import psyplot.project as psy

>>> ds = xr.Dataset({
...     'temp': xr.Variable(('time', ), np.arange(5)),
...     'std': xr.Variable(('time', ), np.arange(5, 10))})
>>> ds
<xarray.Dataset>
Dimensions:  (time: 5)
Coordinates:
  * time     (time) int64 0 1 2 3 4
Data variables:
    temp     (time) int64 0 1 2 3 4
    std      (time) int64 5 6 7 8 9

If we create a plot with it, we get the 'time' dimension on the x-axis:

>>> plotter = psy.plot.lineplot(ds, name=['temp']).plotters[0]

>>> plotter.plot_data[0].dims
('time',)

If we however set the 'coord' keyword, we get:

>>> plotter = psy.plot.lineplot(
...     ds, name=['temp'], coord='std').plotters[0]

>>> plotter.plot_data[0].dims
('std',)

and 'std' is plotted on the x-axis.

plot

Choose how to make the bar plot

Possible types

None

Don’t make any plotting

‘bar’

Create a usual bar plot with the bars side-by-side

‘stacked’

Create stacked plot

widths

Specify the widths of the bars

Possible types

‘equal’

Each bar will have the same width (the default)

‘data’

Each bar will have the width as specified by the boundaries

float

The width for each bar

See also

categorical

xlabel

Set the x-axis label

Set the label for the x-axis. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str

The text for the xlabel() function.

See also

xlabelsize, xlabelweight, xlabelprops

xlim

Set the x-axis limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

ylim

xticklabels

Modify the x-axis ticklabels

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

str

A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

array

An array of strings to use for the ticklabels

See also

xticks, ticksize, tickweight, xtickprops, yticklabels

xticks

Modify the x-axis ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

Examples

Plot 11 ticks over the whole data range:

>>> plotter.update(xticks='rounded')

Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

>>> plotter.update(xticks=['minmax', 7])

Plot ticks every year and minor ticks every month:

>>> plotter.update(xticks={'major': 'year', 'minor': 'month'})

See also

xticklabels, ticksize, tickweight, xtickprops, yticks

ylabel

Set the y-axis label

Set the label for the y-axis. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str

The text for the ylabel() function.

See also

ylabelsize, ylabelweight, ylabelprops

ylim

Set the y-axis limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

xlim

yticklabels

Modify the y-axis ticklabels

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

str

A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

array

An array of strings to use for the ticklabels

See also

yticks, ticksize, tickweight, ytickprops, xticklabels

yticks

Modify the y-axis ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

See also

yticklabels, ticksize, tickweight, ytickprops

xticks

for possible examples

class psy_simple.plotters.BarWidths(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Specify the widths of the bars

Possible types

‘equal’

Each bar will have the same width (the default)

‘data’

Each bar will have the width as specified by the boundaries

float

The width for each bar

See also

categorical

Attributes:

name	str.
priority	int.

Methods:

update(value)

Method that is call to update the formatoption on the axes

name = 'Width of the bars'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.BarXTickLabels(*args, **kwargs)

Bases: XTickLabels

Modify the x-axis ticklabels

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

str

A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

array

An array of strings to use for the ticklabels

See also

xticks, ticksize, tickweight, xtickprops, yticklabels

Attributes:

categorical	categorical Formatoption instance in the plotter
dependencies	list of str.
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
xticks	xticks Formatoption instance in the plotter
yticklabels	yticklabels Formatoption instance in the plotter

Methods:

set_stringformatter(s)

property categorical

categorical Formatoption instance in the plotter

dependencies = ['transpose', 'xticks', 'yticklabels', 'plot', 'categorical']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property plot

plot Formatoption instance in the plotter

set_stringformatter(s)

property transpose

transpose Formatoption instance in the plotter

property xticks

xticks Formatoption instance in the plotter

property yticklabels

yticklabels Formatoption instance in the plotter

class psy_simple.plotters.BarXTicks(*args, **kwargs)

Bases: XTicks

Modify the x-axis ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

Examples

Plot 11 ticks over the whole data range:

>>> plotter.update(xticks='rounded')

Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

>>> plotter.update(xticks=['minmax', 7])

Plot ticks every year and minor ticks every month:

>>> plotter.update(xticks={'major': 'year', 'minor': 'month'})

See also

xticklabels, ticksize, tickweight, xtickprops, yticks

Attributes:

array	The numpy array of the data
categorical	categorical Formatoption instance in the plotter
connections	list of str.
dependencies	list of str.
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
xlim	xlim Formatoption instance in the plotter
yticks	yticks Formatoption instance in the plotter

Methods:

set_default_locators()	Sets the default locator that is used for updating to None or int
update(value)	Method that is call to update the formatoption on the axes

property array

The numpy array of the data

property categorical

categorical Formatoption instance in the plotter

connections = ['xlim']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

dependencies = ['transpose', 'plot', 'plot', 'categorical']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property plot

plot Formatoption instance in the plotter

set_default_locators()

Sets the default locator that is used for updating to None or int

Parameters:

which ({None, 'minor', 'major'}) – Specify which locator shall be set

property transpose

transpose Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

property xlim

xlim Formatoption instance in the plotter

property yticks

yticks Formatoption instance in the plotter

class psy_simple.plotters.BarXlabel(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Xlabel

Set the x-axis label

Set the label for the x-axis. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str

The text for the xlabel() function.

See also

xlabelsize, xlabelweight, xlabelprops

Attributes:

transpose	transpose Formatoption instance in the plotter
update_after_plot	Xlabel is modified by the pandas plot routine, therefore we update it after each plot
ylabel	ylabel Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

update_after_plot = True

Xlabel is modified by the pandas plot routine, therefore we update it after each plot

property ylabel

ylabel Formatoption instance in the plotter

class psy_simple.plotters.BarXlim(*args, **kwargs)

Bases: ViolinXlim

Set the x-axis limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

ylim

Attributes:

array	The numpy array of the data
categorical	categorical Formatoption instance in the plotter
dependencies	list of str.
plot	plot Formatoption instance in the plotter
sym_lims	sym_lims Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
xticks	xticks Formatoption instance in the plotter
ylim	ylim Formatoption instance in the plotter

property array

The numpy array of the data

property categorical

categorical Formatoption instance in the plotter

dependencies = ['xticks', 'categorical']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property plot

plot Formatoption instance in the plotter

property sym_lims

sym_lims Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

property xticks

xticks Formatoption instance in the plotter

property ylim

ylim Formatoption instance in the plotter

class psy_simple.plotters.BarYTickLabels(*args, **kwargs)

Bases: YTickLabels

Modify the y-axis ticklabels

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

str

A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

array

An array of strings to use for the ticklabels

See also

yticks, ticksize, tickweight, ytickprops, xticklabels

Attributes:

categorical	categorical Formatoption instance in the plotter
dependencies	list of str.
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
yticks	yticks Formatoption instance in the plotter

Methods:

set_stringformatter(s)

property categorical

categorical Formatoption instance in the plotter

dependencies = ['transpose', 'yticks', 'plot', 'categorical']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property plot

plot Formatoption instance in the plotter

set_stringformatter(s)

property transpose

transpose Formatoption instance in the plotter

property yticks

yticks Formatoption instance in the plotter

class psy_simple.plotters.BarYTicks(*args, **kwargs)

Bases: YTicks

Modify the y-axis ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

See also

yticklabels, ticksize, tickweight, ytickprops

xticks

for possible examples

Attributes:

array	The numpy array of the data
categorical	categorical Formatoption instance in the plotter
connections	list of str.
dependencies	list of str.
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
ylim	ylim Formatoption instance in the plotter

Methods:

set_default_locators()	Sets the default locator that is used for updating to None or int
update(value)	Method that is call to update the formatoption on the axes

property array

The numpy array of the data

property categorical

categorical Formatoption instance in the plotter

connections = ['ylim']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

dependencies = ['transpose', 'plot', 'plot', 'categorical']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property plot

plot Formatoption instance in the plotter

set_default_locators()

Sets the default locator that is used for updating to None or int

Parameters:

which ({None, 'minor', 'major'}) – Specify which locator shall be set

property transpose

transpose Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

property ylim

ylim Formatoption instance in the plotter

class psy_simple.plotters.BarYlabel(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Ylabel

Set the y-axis label

Set the label for the y-axis. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str

The text for the ylabel() function.

See also

ylabelsize, ylabelweight, ylabelprops

Attributes:

transpose	transpose Formatoption instance in the plotter
update_after_plot	Ylabel is modified by the pandas plot routine, therefore we update it after each plot

property transpose

transpose Formatoption instance in the plotter

update_after_plot = True

Ylabel is modified by the pandas plot routine, therefore we update it after each plot

class psy_simple.plotters.BarYlim(*args, **kwargs)

Bases: ViolinYlim

Set the y-axis limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

xlim

Attributes:

array	The numpy array of the data
categorical	categorical Formatoption instance in the plotter
dependencies	list of str.
plot	plot Formatoption instance in the plotter
sym_lims	sym_lims Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
xlim	xlim Formatoption instance in the plotter
yticks	yticks Formatoption instance in the plotter

property array

The numpy array of the data

property categorical

categorical Formatoption instance in the plotter

dependencies = ['yticks', 'categorical']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property plot

plot Formatoption instance in the plotter

property sym_lims

sym_lims Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

property xlim

xlim Formatoption instance in the plotter

property yticks

yticks Formatoption instance in the plotter

class psy_simple.plotters.Base2D(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: Plotter

Base plotter for 2-dimensional plots

Attributes:

bounds	Specify the boundaries of the colorbar
cbar	Specify the position of the colorbars
cbarspacing	Specify the spacing of the bounds in the colorbar
clabel	Show the colorbar label
clabelprops	Properties of the Colorbar label
clabelsize	Set the size of the Colorbar label
clabelweight	Set the fontweight of the Colorbar label
cmap	Specify the color map
cticklabels	Specify the colorbar ticklabels
ctickprops	Specify the font properties of the colorbar ticklabels
cticks	Specify the tick locations of the colorbar
cticksize	Specify the font size of the colorbar ticklabels
ctickweight	Specify the fontweight of the colorbar ticklabels
datagrid	Show the grid of the data
extend	Draw arrows at the side of the colorbar
mask_datagrid	Mask the datagrid where the array is NaN
plot

bounds

Specify the boundaries of the colorbar

Possible types

None

make no normalization

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

int

Specifies how many ticks to use with the 'rounded' option. I.e. if integer i, then this is the same as ['rounded', i].

matplotlib.colors.Normalize

A matplotlib normalization instance

Examples

• Plot 11 bounds over the whole data range:

  >>> plotter.update(bounds='rounded')
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded'})
  

• Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

  >>> plotter.update(bounds=['minmax', 7])
  

  which is equivaluent to:

  >>> plotter.update(bounds={'method': 'minmax', 'N': 7})
  

• chop the first and last five percentiles:

  >>> plotter.update(bounds=['rounded', None, 5, 95])
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded', 'percmin': 5,
  ...                        'percmax': 95})
  

• Plot 3 bounds per power of ten:

  >>> plotter.update(bounds=['log', 3])
  

• Plot continuous logarithmic bounds:

  >>> from matplotlib.colors import LogNorm
  >>> plotter.update(bounds=LogNorm())
  

See also

cmap

Specifies the colormap

cbar

Specify the position of the colorbars

Possible types

bool

True: defaults to ‘b’ False: Don’t draw any colorbar

str

The string can be a combination of one of the following strings: {‘fr’, ‘fb’, ‘fl’, ‘ft’, ‘b’, ‘r’, ‘sv’, ‘sh’}

• ‘b’, ‘r’ stand for bottom and right of the axes

• ‘fr’, ‘fb’, ‘fl’, ‘ft’ stand for bottom, right, left and top of the figure

• ‘sv’ and ‘sh’ stand for a vertical or horizontal colorbar in a separate figure

list

A containing one of the above positions

Examples

Draw a colorbar at the bottom and left of the axes:

>>> plotter.update(cbar='bl')

cbarspacing

Specify the spacing of the bounds in the colorbar

Possible types

str {‘uniform’, ‘proportional’}

if 'uniform', every color has exactly the same width in the colorbar, if 'proportional', the size is chosen according to the data

clabel

Show the colorbar label

Set the label of the colorbar. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str

The title for the set_label() method.

See also

clabelsize, clabelweight, clabelprops

clabelprops

Properties of the Colorbar label

Specify the font properties of the figure title manually.

Possible types

dict

Items may be any valid text property

See also

clabel, clabelsize, clabelweight

clabelsize

Set the size of the Colorbar label

Possible types

float

The absolute font size in points (e.g., 12)

string

Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

clabel, clabelweight, clabelprops

clabelweight

Set the fontweight of the Colorbar label

Possible types

float

a float between 0 and 1000

string

Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

clabel, clabelsize, clabelprops

cmap

Specify the color map

This formatoption specifies the color coding of the data via a matplotlib.colors.Colormap

Possible types

str

Strings may be any valid colormap name suitable for the matplotlib.cm.get_cmap() function or one of the color lists defined in the ‘colors.cmaps’ key of the psyplot.rcParams dictionary (including their reversed color maps given via the ‘_r’ extension).

matplotlib.colors.Colormap

The colormap instance to use

See also

bounds

specifies the boundaries of the colormap

cticklabels

Specify the colorbar ticklabels

Possible types

str

A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

array

An array of strings to use for the ticklabels

See also

cticks, cticksize, ctickweight, ctickprops, vcticks, vcticksize, vctickweight, vctickprops

ctickprops

Specify the font properties of the colorbar ticklabels

Possible types

dict

Items may be anything of the matplotlib.pyplot.tick_params() function

See also

cticksize, ctickweight, cticklabels, cticks, vcticksize, vctickweight, vcticklabels, vcticks

cticks

Specify the tick locations of the colorbar

Possible types

None

use the default ticks

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

bounds

let the bounds keyword determine the ticks. An additional integer i may be specified to only use every i-th bound as a tick (see also int below)

midbounds

Same as bounds but in the middle between two bounds

int

Specifies how many ticks to use with the 'bounds' option. I.e. if integer i, then this is the same as ['bounds', i].

See also

cticklabels

cticksize

Specify the font size of the colorbar ticklabels

Possible types

float

The absolute font size in points (e.g., 12)

string

Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

ctickweight, ctickprops, cticklabels, cticks, vctickweight, vctickprops, vcticklabels, vcticks

ctickweight

Specify the fontweight of the colorbar ticklabels

Possible types

float

a float between 0 and 1000

string

Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

cticksize, ctickprops, cticklabels, cticks, vcticksize, vctickprops, vcticklabels, vcticks

datagrid

Show the grid of the data

This formatoption shows the grid of the data (without labels)

Possible types

None

Don’t show the data grid

str

A linestyle in the form 'k-', where 'k' is the color and '-' the linestyle.

dict

any keyword arguments that are passed to the plotting function ( matplotlib.pyplot.triplot() for unstructured grids and matplotlib.pyplot.hlines() for rectilinear grids)

See also

mask_datagrid

To display cells with NaN

extend

Draw arrows at the side of the colorbar

Possible types

str {‘neither’, ‘both’, ‘min’ or ‘max’}

If not ‘neither’, make pointed end(s) for out-of-range values

mask_datagrid

Mask the datagrid where the array is NaN

This boolean formatoption enables to mask the grid of the datagrid formatoption where the data is NaN

Possible types

bool

Either True, to not display the data grid for cells with NaN, or False

See also

datagrid

plot = None

class psy_simple.plotters.BaseVectorPlotter(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: Base2D

Base plotter for vector plots

Attributes:

allowed_dims
arrowsize	Change the size of the arrows
arrowstyle	Change the style of the arrows
bounds	Specify the boundaries of the vector colorbar
cbar	Specify the position of the vector plot colorbars
color	Set the color for the arrows
cticks	Specify the tick locations of the vector colorbar
datagrid
density	Change the density of the arrows
linewidth	Change the linewidth of the arrows

Methods:

check_data(name, dims, is_unstructured)

A validation method for the data shape

allowed_dims = 3

arrowsize

Change the size of the arrows

Possible types

None

make no scaling

float

Factor scaling the size of the arrows

See also

arrowstyle, linewidth, density, color

arrowstyle

Change the style of the arrows

Possible types

str

Any arrow style string (see FancyArrowPatch)

Notes

This formatoption only has an effect for stream plots

See also

arrowsize, linewidth, density, color

bounds

Specify the boundaries of the vector colorbar

Possible types

None

make no normalization

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

int

Specifies how many ticks to use with the 'rounded' option. I.e. if integer i, then this is the same as ['rounded', i].

matplotlib.colors.Normalize

A matplotlib normalization instance

Examples

• Plot 11 bounds over the whole data range:

  >>> plotter.update(bounds='rounded')
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded'})
  

• Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

  >>> plotter.update(bounds=['minmax', 7])
  

  which is equivaluent to:

  >>> plotter.update(bounds={'method': 'minmax', 'N': 7})
  

• chop the first and last five percentiles:

  >>> plotter.update(bounds=['rounded', None, 5, 95])
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded', 'percmin': 5,
  ...                        'percmax': 95})
  

• Plot 3 bounds per power of ten:

  >>> plotter.update(bounds=['log', 3])
  

• Plot continuous logarithmic bounds:

  >>> from matplotlib.colors import LogNorm
  >>> plotter.update(bounds=LogNorm())
  

See also

cmap

Specifies the colormap

cbar

Specify the position of the vector plot colorbars

Possible types

bool

True: defaults to ‘b’ False: Don’t draw any colorbar

str

The string can be a combination of one of the following strings: {‘fr’, ‘fb’, ‘fl’, ‘ft’, ‘b’, ‘r’, ‘sv’, ‘sh’}

• ‘b’, ‘r’ stand for bottom and right of the axes

• ‘fr’, ‘fb’, ‘fl’, ‘ft’ stand for bottom, right, left and top of the figure

• ‘sv’ and ‘sh’ stand for a vertical or horizontal colorbar in a separate figure

list

A containing one of the above positions

classmethod check_data(name, dims, is_unstructured)

A validation method for the data shape

Parameters:

• name (str or list of str) – The variable names (two variables for the array or one if the dims are one greater)

• dims (list with length 1 or list of lists with length 1) – The dimension of the arrays. Only 2D-Arrays are allowed (or 1-D if the array is unstructured)

• is_unstructured (bool or list of bool) – True if the corresponding array is unstructured.

Returns:

• list of bool or None – True, if everything is okay, False in case of a serious error, None if it is intermediate. Each object in this list corresponds to one in the given name

• list of str – The message giving more information on the reason. Each object in this list corresponds to one in the given name

color

Set the color for the arrows

This formatoption can be used to set a single color for the vectors or define the color coding

Possible types

float

Determines the greyness

color

Defines the same color for all arrows. The string can be either a html hex string (e.g. ‘#eeefff’), a single letter (e.g. ‘b’: blue, ‘g’: green, ‘r’: red, ‘c’: cyan, ‘m’: magenta, ‘y’: yellow, ‘k’: black, ‘w’: white) or any other color

string {‘absolute’, ‘u’, ‘v’}

Strings may define how the formatoption is calculated. Possible strings are

• absolute: for the absolute wind speed

• u: for the u component

• v: for the v component

2D-array

The values determine the color for each plotted arrow. Note that the shape has to match the one of u and v.

See also

arrowsize, arrowstyle, density, linewidth

cticks

Specify the tick locations of the vector colorbar

Possible types

None

use the default ticks

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

bounds

let the bounds keyword determine the ticks. An additional integer i may be specified to only use every i-th bound as a tick (see also int below)

midbounds

Same as bounds but in the middle between two bounds

int

Specifies how many ticks to use with the 'bounds' option. I.e. if integer i, then this is the same as ['bounds', i].

See also

cticklabels, vcticklabels

datagrid

density

Change the density of the arrows

Possible types

float

Scales the density of the arrows in x- and y-direction (1.0 means no scaling)

tuple (x, y)

Defines the scaling in x- and y-direction manually

Notes

quiver plots do not support density scaling

linewidth

Change the linewidth of the arrows

Possible types

float

give the linewidth explicitly

string {‘absolute’, ‘u’, ‘v’}

Strings may define how the formatoption is calculated. Possible strings are

• absolute: for the absolute wind speed

• u: for the u component

• v: for the v component

tuple (string, float)

string may be one of the above strings, float may be a scaling factor

2D-array

The values determine the linewidth for each plotted arrow. Note that the shape has to match the one of u and v.

See also

arrowsize, arrowstyle, density, color

class psy_simple.plotters.Bounds(*args, **kwargs)

Bases: DataTicksCalculator

Specify the boundaries of the colorbar

Possible types

None

make no normalization

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

int

Specifies how many ticks to use with the 'rounded' option. I.e. if integer i, then this is the same as ['rounded', i].

matplotlib.colors.Normalize

A matplotlib normalization instance

Examples

• Plot 11 bounds over the whole data range:

  >>> plotter.update(bounds='rounded')
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded'})
  

• Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

  >>> plotter.update(bounds=['minmax', 7])
  

  which is equivaluent to:

  >>> plotter.update(bounds={'method': 'minmax', 'N': 7})
  

• chop the first and last five percentiles:

  >>> plotter.update(bounds=['rounded', None, 5, 95])
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded', 'percmin': 5,
  ...                        'percmax': 95})
  

• Plot 3 bounds per power of ten:

  >>> plotter.update(bounds=['log', 3])
  

• Plot continuous logarithmic bounds:

  >>> from matplotlib.colors import LogNorm
  >>> plotter.update(bounds=LogNorm())
  

See also

cmap

Specifies the colormap

Attributes:

cbar	cbar Formatoption instance in the plotter
cmap	cmap Formatoption instance in the plotter
connections	list of str.
group	str.
name	str.
priority	int.
value2share	The normalization instance

Methods:

get_fmt_widget(parent, project)	Open a psy_simple.widget.CMapFmtWidget
update(value)	Method that is call to update the formatoption on the axes

property cbar

cbar Formatoption instance in the plotter

property cmap

cmap Formatoption instance in the plotter

connections = ['cmap', 'cbar']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

get_fmt_widget(parent, project)

Open a psy_simple.widget.CMapFmtWidget

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

name = 'Boundaries of the color map'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

property value2share

The normalization instance

class psy_simple.plotters.CLabel(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: TextBase, Formatoption

Show the colorbar label

Set the label of the colorbar. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str

The title for the set_label() method.

See also

clabelsize, clabelweight, clabelprops

Attributes:

axis_locations
cbar	cbar Formatoption instance in the plotter
children	list of str.
data_dependent	bool or a callable.
dependencies	list of str.
group	str.
name	str.
plot	plot Formatoption instance in the plotter

Methods:

update(value)

Method that is call to update the formatoption on the axes

axis_locations = {'b': 'x', 'fb': 'x', 'fl': 'y', 'fr': 'y', 'ft': 'x', 'l': 'y', 'r': 'y', 'sh': 'x', 'sv': 'y', 't': 'x'}

property cbar

cbar Formatoption instance in the plotter

children = ['plot']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

dependencies = ['cbar']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

group = 'labels'

str. Key of the group name in groups of this formatoption keyword

name = 'Colorbar label'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.CMap(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Specify the color map

This formatoption specifies the color coding of the data via a matplotlib.colors.Colormap

Possible types

str

Strings may be any valid colormap name suitable for the matplotlib.cm.get_cmap() function or one of the color lists defined in the ‘colors.cmaps’ key of the psyplot.rcParams dictionary (including their reversed color maps given via the ‘_r’ extension).

matplotlib.colors.Colormap

The colormap instance to use

See also

bounds

specifies the boundaries of the colormap

Attributes:

bounds	bounds Formatoption instance in the plotter
cbar	cbar Formatoption instance in the plotter
connections	list of str.
group	str.
name	str.
priority	int.

Methods:

get_cmap([arr, cmap, N])	Get the matplotlib.colors.Colormap for plotting
get_fmt_widget(parent, project)	Open a psy_simple.widget.CMapFmtWidget
update(value)	Method that is call to update the formatoption on the axes

property bounds

bounds Formatoption instance in the plotter

property cbar

cbar Formatoption instance in the plotter

connections = ['bounds', 'cbar']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

get_cmap(arr=None, cmap=None, N=None)

Get the matplotlib.colors.Colormap for plotting

Parameters:

• arr (np.ndarray) – The array to plot

• cmap (str or matplotlib.colors.Colormap) – The colormap to use. If None, the value of this formatoption is used

• N (int) – The number of colors in the colormap. If None, the norm of the bounds formatoption is used and, if necessary, the given array arr

Returns:

The colormap returned by psy_simple.colors.get_cmap()

Return type:

matplotlib.colors.Colormap

get_fmt_widget(parent, project)

Open a psy_simple.widget.CMapFmtWidget

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

name = 'Colormap'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.CTickLabels(*args, **kwargs)

Bases: CbarOptions, TickLabelsBase

Specify the colorbar ticklabels

Possible types

str

A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

array

An array of strings to use for the ticklabels

See also

cticks, cticksize, ctickweight, ctickprops, vcticks, vcticksize, vctickweight, vctickprops

Attributes:

cbar	cbar Formatoption instance in the plotter
default_formatters	Default locator of the axis of the colorbars
name	str.
plot	plot Formatoption instance in the plotter

Methods:

set_default_formatters()	Sets the default formatters that is used for updating to None
set_formatter(formatter)	Sets a given formatter

property cbar

cbar Formatoption instance in the plotter

property default_formatters

Default locator of the axis of the colorbars

name = 'Colorbar ticklabels'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

set_default_formatters()

Sets the default formatters that is used for updating to None

set_formatter(formatter)

Sets a given formatter

class psy_simple.plotters.CTickProps(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: CbarOptions, TickPropsBase

Specify the font properties of the colorbar ticklabels

Possible types

dict

Items may be anything of the matplotlib.pyplot.tick_params() function

See also

cticksize, ctickweight, cticklabels, cticks, vcticksize, vctickweight, vcticklabels, vcticks

Attributes:

cbar	cbar Formatoption instance in the plotter
children	list of str.
group	str.
name	str.
plot	plot Formatoption instance in the plotter

Methods:

update_axis(value)

property cbar

cbar Formatoption instance in the plotter

children = ['plot']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

name = 'Font properties of the colorbar ticklabels'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

update_axis(value)

class psy_simple.plotters.CTickSize(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: CbarOptions, TickSizeBase

Specify the font size of the colorbar ticklabels

Possible types

float

The absolute font size in points (e.g., 12)

string

Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

ctickweight, ctickprops, cticklabels, cticks, vctickweight, vctickprops, vcticklabels, vcticks

Attributes:

cbar	cbar Formatoption instance in the plotter
ctickprops	ctickprops Formatoption instance in the plotter
dependencies	list of str.
group	str.
name	str.
plot	plot Formatoption instance in the plotter

property cbar

cbar Formatoption instance in the plotter

property ctickprops

ctickprops Formatoption instance in the plotter

dependencies = ['cbar', 'ctickprops']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

name = 'Font size of the colorbar ticklabels'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

class psy_simple.plotters.CTickWeight(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: CbarOptions, TickWeightBase

Specify the fontweight of the colorbar ticklabels

Possible types

float

a float between 0 and 1000

string

Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

cticksize, ctickprops, cticklabels, cticks, vcticksize, vctickprops, vcticklabels, vcticks

Attributes:

cbar	cbar Formatoption instance in the plotter
ctickprops	ctickprops Formatoption instance in the plotter
dependencies	list of str.
group	str.
name	str.
plot	plot Formatoption instance in the plotter

property cbar

cbar Formatoption instance in the plotter

property ctickprops

ctickprops Formatoption instance in the plotter

dependencies = ['cbar', 'ctickprops']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

name = 'Font weight of the colorbar ticklabels'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

class psy_simple.plotters.CTicks(*args, **kwargs)

Bases: CbarOptions, TicksBase

Specify the tick locations of the colorbar

Possible types

None

use the default ticks

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

bounds

let the bounds keyword determine the ticks. An additional integer i may be specified to only use every i-th bound as a tick (see also int below)

midbounds

Same as bounds but in the middle between two bounds

int

Specifies how many ticks to use with the 'bounds' option. I.e. if integer i, then this is the same as ['bounds', i].

See also

cticklabels

Attributes:

bounds	bounds Formatoption instance in the plotter
cbar	cbar Formatoption instance in the plotter
cmap	cmap Formatoption instance in the plotter
connections	list of str.
default_locator	Default locator of the axis of the colorbars
dependencies	list of str.
name	str.
plot	plot Formatoption instance in the plotter

Methods:

get_fmt_widget(parent, project)	Open a psy_simple.widget.CMapFmtWidget
set_default_locators(*args, **kwargs)	Sets the default locator that is used for updating to None or int
set_ticks(value)
update(value)	Method that is call to update the formatoption on the axes
update_axis(value)

property bounds

bounds Formatoption instance in the plotter

property cbar

cbar Formatoption instance in the plotter

property cmap

cmap Formatoption instance in the plotter

connections = ['cmap']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

property default_locator

Default locator of the axis of the colorbars

dependencies = ['cbar', 'bounds']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

get_fmt_widget(parent, project)

Open a psy_simple.widget.CMapFmtWidget

name = 'Colorbar ticks'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

set_default_locators(*args, **kwargs)

Sets the default locator that is used for updating to None or int

Parameters:

which ({None, 'minor', 'major'}) – Specify which locator shall be set

set_ticks(value)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

update_axis(value)

class psy_simple.plotters.CategoricalBars(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

The location of each bar

Possible types

None

If None, use a categorical plotting if the widths are 'equal', otherwise, not

bool

If True, use a categorical plotting

See also

widths

Attributes:

dependencies	list of str.
name	str.
priority	int.
widths	widths Formatoption instance in the plotter

Methods:

update(value)

Method that is call to update the formatoption on the axes

dependencies = ['widths']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

name = 'Categorical or non-categorical plotting'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

property widths

widths Formatoption instance in the plotter

class psy_simple.plotters.Cbar(*args, **kwargs)

Bases: Formatoption

Specify the position of the colorbars

Possible types

bool

True: defaults to ‘b’ False: Don’t draw any colorbar

str

The string can be a combination of one of the following strings: {‘fr’, ‘fb’, ‘fl’, ‘ft’, ‘b’, ‘r’, ‘sv’, ‘sh’}

• ‘b’, ‘r’ stand for bottom and right of the axes

• ‘fr’, ‘fb’, ‘fl’, ‘ft’ stand for bottom, right, left and top of the figure

• ‘sv’ and ‘sh’ stand for a vertical or horizontal colorbar in a separate figure

list

A containing one of the above positions

Examples

Draw a colorbar at the bottom and left of the axes:

>>> plotter.update(cbar='bl')

Attributes:

bounds	bounds Formatoption instance in the plotter
cbarspacing	cbarspacing Formatoption instance in the plotter
cmap	cmap Formatoption instance in the plotter
dependencies	list of str.
extend	extend Formatoption instance in the plotter
figure_positions
group	str.
init_kwargs	dict key word arguments that are passed to the initialization of a new instance when accessed from the descriptor
levels	levels Formatoption instance in the plotter
name	str.
original_position
plot	plot Formatoption instance in the plotter
priority	int.
value2share	Those colorbar positions that are directly at the axes

Methods:

draw_colorbar(pos)
finish_update()	Finish the update, initialization and sharing process
initialize_plot(value)	Method that is called when the plot is made the first time
remove([positions])	Method to remove the effects of this formatoption
set_label_pos(pos)
update(value)	Updates the colorbar
update_colorbar(pos)

property bounds

bounds Formatoption instance in the plotter

property cbarspacing

cbarspacing Formatoption instance in the plotter

property cmap

cmap Formatoption instance in the plotter

dependencies = ['plot', 'cmap', 'bounds', 'extend', 'cbarspacing', 'levels']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

draw_colorbar(pos)

property extend

extend Formatoption instance in the plotter

figure_positions = {'b', 'fb', 'fl', 'fr', 'ft', 'l', 'r', 't'}

finish_update()

Finish the update, initialization and sharing process

This function is called at the end of the Plotter.start_update(), Plotter.initialize_plot() or the Plotter.share() methods.

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

property init_kwargs

dict key word arguments that are passed to the initialization of a new instance when accessed from the descriptor

initialize_plot(value)

Method that is called when the plot is made the first time

Parameters:

value – The value to use for the initialization

property levels

levels Formatoption instance in the plotter

name = 'Position of the colorbar'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

original_position = None

property plot

plot Formatoption instance in the plotter

priority = 10.1

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

remove(positions='all')

Method to remove the effects of this formatoption

This method is called when the axes is cleared due to a formatoption with requires_clearing set to True. You don’t necessarily have to implement this formatoption if your plot results are removed by the usual matplotlib.axes.Axes.clear() method.

set_label_pos(pos)

update(value)

Updates the colorbar

Parameters:

• value – The value to update (see possible types)

• no_fig_cbars – Does not update the colorbars that are not in the axes of this plot

update_colorbar(pos)

property value2share

Those colorbar positions that are directly at the axes

class psy_simple.plotters.CbarOptions(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Base class for colorbar formatoptions

Attributes:

axis	axis of the colorbar with the ticks.
axis_locations
axisname
cbar	cbar Formatoption instance in the plotter
children	list of str.
colorbar
data	The data that is plotted
dependencies	list of str.
plot	plot Formatoption instance in the plotter
which

Methods:

update(value)

Method that is call to update the formatoption on the axes

property axis

axis of the colorbar with the ticks. Will be overwritten during update process.

axis_locations = {'b': 'x', 'fb': 'x', 'fl': 'y', 'fr': 'y', 'ft': 'x', 'l': 'y', 'r': 'y', 'sh': 'x', 'sv': 'y', 't': 'x'}

property axisname

property cbar

cbar Formatoption instance in the plotter

children = ['plot']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

property colorbar

property data

The data that is plotted

dependencies = ['cbar']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property plot

plot Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

which = 'major'

class psy_simple.plotters.CbarSpacing(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Specify the spacing of the bounds in the colorbar

Possible types

str {‘uniform’, ‘proportional’}

if 'uniform', every color has exactly the same width in the colorbar, if 'proportional', the size is chosen according to the data

Attributes:

cbar	cbar Formatoption instance in the plotter
connections	list of str.
group	str.
name	str.

Methods:

update(value)

Method that is call to update the formatoption on the axes

property cbar

cbar Formatoption instance in the plotter

connections = ['cbar']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

name = 'Spacing of the colorbar'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.CombinedBase(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: ScalarCombinedBase

Base plotter for combined 2-dimensional scalar and vector plot

Attributes:

arrowsize	Change the size of the arrows
arrowstyle	Change the style of the arrows
color	Set the color for the arrows
linewidth	Change the linewidth of the arrows
vbounds	Specify the boundaries of the vector colorbar
vcbar	Specify the position of the vector plot colorbars
vcbarspacing	Specify the spacing of the bounds in the colorbar
vclabel	Show the colorbar label of the vector plot
vclabelprops	Properties of the Vector colorbar label
vclabelsize	Set the size of the Vector colorbar label
vclabelweight	Set the fontweight of the Vector colorbar label
vcmap	Specify the color map
vcticklabels	Specify the colorbar ticklabels
vctickprops	Specify the font properties of the colorbar ticklabels
vcticks	Specify the tick locations of the vector colorbar
vcticksize	Specify the font size of the colorbar ticklabels
vctickweight	Specify the fontweight of the colorbar ticklabels

Methods:

check_data(name, dims, is_unstructured)

A validation method for the data shape

arrowsize

Change the size of the arrows

Possible types

None

make no scaling

float

Factor scaling the size of the arrows

See also

arrowstyle, linewidth, density, color

arrowstyle

Change the style of the arrows

Possible types

str

Any arrow style string (see FancyArrowPatch)

Notes

This formatoption only has an effect for stream plots

See also

arrowsize, linewidth, density, color

classmethod check_data(name, dims, is_unstructured)

A validation method for the data shape

Parameters:

• name (list of str with length 2) – The variable names (one for the first, two for the second array)

• dims (list with length 2 of lists with length 1) – The dimension of the arrays. Only 2D-Arrays are allowed (or 1-D if an array is unstructured)

• is_unstructured (bool or list of bool) – True if the corresponding array is unstructured.

Returns:

• list of bool or None – True, if everything is okay, False in case of a serious error, None if it is intermediate. Each object in this list corresponds to one in the given name

• list of str – The message giving more information on the reason. Each object in this list corresponds to one in the given name

color

Set the color for the arrows

This formatoption can be used to set a single color for the vectors or define the color coding

Possible types

float

Determines the greyness

color

Defines the same color for all arrows. The string can be either a html hex string (e.g. ‘#eeefff’), a single letter (e.g. ‘b’: blue, ‘g’: green, ‘r’: red, ‘c’: cyan, ‘m’: magenta, ‘y’: yellow, ‘k’: black, ‘w’: white) or any other color

string {‘absolute’, ‘u’, ‘v’}

Strings may define how the formatoption is calculated. Possible strings are

• absolute: for the absolute wind speed

• u: for the u component

• v: for the v component

2D-array

The values determine the color for each plotted arrow. Note that the shape has to match the one of u and v.

See also

arrowsize, arrowstyle, density, linewidth

linewidth

Change the linewidth of the arrows

Possible types

float

give the linewidth explicitly

string {‘absolute’, ‘u’, ‘v’}

Strings may define how the formatoption is calculated. Possible strings are

• absolute: for the absolute wind speed

• u: for the u component

• v: for the v component

tuple (string, float)

string may be one of the above strings, float may be a scaling factor

2D-array

The values determine the linewidth for each plotted arrow. Note that the shape has to match the one of u and v.

See also

arrowsize, arrowstyle, density, color

vbounds

Specify the boundaries of the vector colorbar

Possible types

None

make no normalization

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

int

Specifies how many ticks to use with the 'rounded' option. I.e. if integer i, then this is the same as ['rounded', i].

matplotlib.colors.Normalize

A matplotlib normalization instance

Examples

• Plot 11 bounds over the whole data range:

  >>> plotter.update(bounds='rounded')
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded'})
  

• Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

  >>> plotter.update(bounds=['minmax', 7])
  

  which is equivaluent to:

  >>> plotter.update(bounds={'method': 'minmax', 'N': 7})
  

• chop the first and last five percentiles:

  >>> plotter.update(bounds=['rounded', None, 5, 95])
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded', 'percmin': 5,
  ...                        'percmax': 95})
  

• Plot 3 bounds per power of ten:

  >>> plotter.update(bounds=['log', 3])
  

• Plot continuous logarithmic bounds:

  >>> from matplotlib.colors import LogNorm
  >>> plotter.update(bounds=LogNorm())
  

See also

cmap

Specifies the colormap

vcbar

Specify the position of the vector plot colorbars

Possible types

bool

True: defaults to ‘b’ False: Don’t draw any colorbar

str

The string can be a combination of one of the following strings: {‘fr’, ‘fb’, ‘fl’, ‘ft’, ‘b’, ‘r’, ‘sv’, ‘sh’}

• ‘b’, ‘r’ stand for bottom and right of the axes

• ‘fr’, ‘fb’, ‘fl’, ‘ft’ stand for bottom, right, left and top of the figure

• ‘sv’ and ‘sh’ stand for a vertical or horizontal colorbar in a separate figure

list

A containing one of the above positions

vcbarspacing

Specify the spacing of the bounds in the colorbar

Possible types

str {‘uniform’, ‘proportional’}

if 'uniform', every color has exactly the same width in the colorbar, if 'proportional', the size is chosen according to the data

vclabel

Show the colorbar label of the vector plot

Set the label of the colorbar. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str

The title for the set_label() method.

See also

vclabelsize, vclabelweight, vclabelprops

vclabelprops

Properties of the Vector colorbar label

Specify the font properties of the figure title manually.

Possible types

dict

Items may be any valid text property

See also

vclabel, vclabelsize, vclabelweight

vclabelsize

Set the size of the Vector colorbar label

Possible types

float

The absolute font size in points (e.g., 12)

string

Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

vclabel, vclabelweight, vclabelprops

vclabelweight

Set the fontweight of the Vector colorbar label

Possible types

float

a float between 0 and 1000

string

Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

vclabel, vclabelsize, vclabelprops

vcmap

Specify the color map

This formatoption specifies the color coding of the data via a matplotlib.colors.Colormap

Possible types

str

Strings may be any valid colormap name suitable for the matplotlib.cm.get_cmap() function or one of the color lists defined in the ‘colors.cmaps’ key of the psyplot.rcParams dictionary (including their reversed color maps given via the ‘_r’ extension).

matplotlib.colors.Colormap

The colormap instance to use

See also

bounds

specifies the boundaries of the colormap

vcticklabels

Specify the colorbar ticklabels

Possible types

str

A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

array

An array of strings to use for the ticklabels

See also

cticks, cticksize, ctickweight, ctickprops, vcticks, vcticksize, vctickweight, vctickprops

vctickprops

Specify the font properties of the colorbar ticklabels

Possible types

dict

Items may be anything of the matplotlib.pyplot.tick_params() function

See also

cticksize, ctickweight, cticklabels, cticks, vcticksize, vctickweight, vcticklabels, vcticks

vcticks

Specify the tick locations of the vector colorbar

Possible types

None

use the default ticks

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

bounds

let the bounds keyword determine the ticks. An additional integer i may be specified to only use every i-th bound as a tick (see also int below)

midbounds

Same as bounds but in the middle between two bounds

int

Specifies how many ticks to use with the 'bounds' option. I.e. if integer i, then this is the same as ['bounds', i].

See also

cticklabels, vcticklabels

vcticksize

Specify the font size of the colorbar ticklabels

Possible types

float

The absolute font size in points (e.g., 12)

string

Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

ctickweight, ctickprops, cticklabels, cticks, vctickweight, vctickprops, vcticklabels, vcticks

vctickweight

Specify the fontweight of the colorbar ticklabels

Possible types

float

a float between 0 and 1000

string

Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

cticksize, ctickprops, cticklabels, cticks, vcticksize, vctickprops, vcticklabels, vcticks

class psy_simple.plotters.CombinedSimplePlotter(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: CombinedBase, Simple2DPlotter, SimpleVectorPlotter

Combined 2D plotter and vector plotter

See also

psyplot.plotter.maps.CombinedPlotter

for visualizing the data on a map

Attributes:

density	Change the density of the arrows
plot	Choose how to visualize a 2-dimensional scalar data field
vplot	Choose the vector plot type

density

Change the density of the arrows

Possible types

float

Scales the density of the arrows in x- and y-direction (1.0 means no scaling)

tuple (x, y)

Defines the scaling in x- and y-direction manually

Notes

quiver plots do not support density scaling

plot

Choose how to visualize a 2-dimensional scalar data field

Possible types

None

Don’t make any plotting

‘mesh’

Use the matplotlib.pyplot.pcolormesh() function to make the plot or the matplotlib.pyplot.tripcolor() for an unstructered grid

‘poly’

Draw each polygon indivually. This method is used by default for unstructured grids. If there are no grid cell boundaries in the dataset, we will interpolate them

‘contourf’

Make a filled contour plot using the matplotlib.pyplot.contourf() function. The levels for the contour plot are controlled by the levels formatoption

‘contour’

Same a 'contourf', but does not make a filled contour plot, only lines.

vplot

Choose the vector plot type

Possible types

str

Plot types can be either

quiver

to make a quiver plot

stream

to make a stream plot

class psy_simple.plotters.CombinedVectorPlot(*args, **kwargs)

Bases: VectorPlot

Choose the vector plot type

Possible types

str

Plot types can be either

quiver

to make a quiver plot

stream

to make a stream plot

Attributes:

arrowsize	arrowsize Formatoption instance in the plotter
arrowstyle	arrowstyle Formatoption instance in the plotter
bounds	bounds Formatoption instance in the plotter
cmap	cmap Formatoption instance in the plotter
color	color Formatoption instance in the plotter
data_dependent	bool or a callable.
density	density Formatoption instance in the plotter
linewidth	linewidth Formatoption instance in the plotter
transform	transform Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter

Methods:

update(*args, **kwargs)

Method that is call to update the formatoption on the axes

property arrowsize

arrowsize Formatoption instance in the plotter

property arrowstyle

arrowstyle Formatoption instance in the plotter

property bounds

bounds Formatoption instance in the plotter

property cmap

cmap Formatoption instance in the plotter

property color

color Formatoption instance in the plotter

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

property density

density Formatoption instance in the plotter

property linewidth

linewidth Formatoption instance in the plotter

property transform

transform Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

update(*args, **kwargs)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.ContourLevels(*args, **kwargs)

Bases: Bounds

The levels for the contour plot

This formatoption sets the levels for the filled contour plot and only has an effect if the plot Formatoption is set to 'contourf'

Possible types

None

Use the settings from the bounds formatoption and if this does not specify boundaries, use 11

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

int

Specifies how many ticks to use with the 'rounded' option. I.e. if integer i, then this is the same as ['rounded', i].

Attributes:

cbar	cbar Formatoption instance in the plotter
cbounds	cbounds Formatoption instance in the plotter
cmap	cmap Formatoption instance in the plotter
dependencies	list of str.
name	str.
priority	int.

Methods:

update(value)

Method that is call to update the formatoption on the axes

property cbar

cbar Formatoption instance in the plotter

property cbounds

cbounds Formatoption instance in the plotter

property cmap

cmap Formatoption instance in the plotter

dependencies = ['cbounds']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

name = 'Levels for the filled contour plot'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.DataGrid(*args, **kwargs)

Bases: Formatoption

Show the grid of the data

This formatoption shows the grid of the data (without labels)

Possible types

None

Don’t show the data grid

str

A linestyle in the form 'k-', where 'k' is the color and '-' the linestyle.

dict

any keyword arguments that are passed to the plotting function ( matplotlib.pyplot.triplot() for unstructured grids and matplotlib.pyplot.hlines() for rectilinear grids)

See also

mask_datagrid

To display cells with NaN

Attributes:

cell_nodes_x	The unstructured x-boundaries with shape (N, m) where m > 2
cell_nodes_y	The unstructured y-boundaries with shape (N, m) where m > 2
children	list of str.
connections	list of str.
data_dependent	bool or a callable.
dependencies	list of str.
mask_datagrid	mask_datagrid Formatoption instance in the plotter
name	str.
plot	plot Formatoption instance in the plotter
transform	transform Formatoption instance in the plotter
xbounds	Boundaries of the x-coordinate
xcoord	The x coordinate xarray.Variable
ybounds	Boundaries of the y-coordinate
ycoord	The y coordinate xarray.Variable

Methods:

remove()	Method to remove the effects of this formatoption
update(value)	Method that is call to update the formatoption on the axes

property cell_nodes_x

The unstructured x-boundaries with shape (N, m) where m > 2

property cell_nodes_y

The unstructured y-boundaries with shape (N, m) where m > 2

children = ['transform']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

connections = ['plot']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

dependencies = ['mask_datagrid']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property mask_datagrid

mask_datagrid Formatoption instance in the plotter

name = 'Grid of the data'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

remove()

Method to remove the effects of this formatoption

This method is called when the axes is cleared due to a formatoption with requires_clearing set to True. You don’t necessarily have to implement this formatoption if your plot results are removed by the usual matplotlib.axes.Axes.clear() method.

property transform

transform Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

property xbounds

Boundaries of the x-coordinate

property xcoord

The x coordinate xarray.Variable

property ybounds

Boundaries of the y-coordinate

property ycoord

The y coordinate xarray.Variable

class psy_simple.plotters.DataPrecision(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Set the precision of the data

This formatoption can be used to specify the precision of the data which then will be the minimal bin width of the 2D histogram or the bandwith of the kernel size (if the density formatoption is set to 'kde')

Possible types

float

If 0, this formatoption has no effect at all. Otherwise it is assumed to be the precision of the data

str

One of {'scott' | 'silverman'}. This uses the statsmodels package to estimate the bandwidth of the data that is then used in the histogram or KDE plot

Attributes:

connections	list of str.
data_dependent	bool or a callable.
density	density Formatoption instance in the plotter
dependencies	list of str.
group	str.
name	str.
priority	int.
xrange	xrange Formatoption instance in the plotter
yrange	yrange Formatoption instance in the plotter

Methods:

estimate_bw(method, values[, data_range])
update(value)	Method that is call to update the formatoption on the axes

connections = ['density']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

property density

density Formatoption instance in the plotter

dependencies = ['xrange', 'yrange']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

estimate_bw(method, values, data_range=None)

group = 'data'

str. Key of the group name in groups of this formatoption keyword

name = 'Precision of the visualized data'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 30

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

property xrange

xrange Formatoption instance in the plotter

property yrange

yrange Formatoption instance in the plotter

class psy_simple.plotters.DataTicksCalculator(*args, **kwargs)

Bases: Formatoption

Abstract base formatoption to calculate ticks and bounds from the data

Possible types

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

Attributes:

array	The numpy array of the data
data_dependent	bool or a callable.
full_array	The full array of this and the shared data

property array

The numpy array of the data

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

property full_array

The full array of this and the shared data

class psy_simple.plotters.Density(*args, **kwargs)

Bases: Formatoption

Change the density of the arrows

Possible types

float

Scales the density of the arrows in x- and y-direction (1.0 means no scaling)

tuple (x, y)

Defines the scaling in x- and y-direction manually

Notes

quiver plots do not support density scaling

Attributes:

data_dependent	bool or a callable.
dependencies	list of str.
group	str.
name	str.
plot	plot Formatoption instance in the plotter
priority	int.

Methods:

remove([plot_type])	Method to remove the effects of this formatoption
update(value)	Method that is call to update the formatoption on the axes

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

dependencies = ['plot']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

group = 'vector'

str. Key of the group name in groups of this formatoption keyword

name = 'Density of the arrows'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

remove(plot_type=None)

Method to remove the effects of this formatoption

This method is called when the axes is cleared due to a formatoption with requires_clearing set to True. You don’t necessarily have to implement this formatoption if your plot results are removed by the usual matplotlib.axes.Axes.clear() method.

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.DensityPlotter(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: Simple2DPlotter

A plotter to visualize the density of points in a 2-dimensional grid

Attributes:

allowed_dims	The number of allowed dimensions in the for the visualization.
allowed_vars	The number variables that one data array visualized by this plotter might have.
bins	Specify the bins of the 2D-Histogramm
coord	Use an alternative variable as x-coordinate
density	Specify the method to calculate the density
normed	Specify the normalization of the histogram
precision	Set the precision of the data
xrange	Specify the range of the histogram for the x-dimension
yrange	Specify the range of the histogram for the x-dimension

allowed_dims = 1

The number of allowed dimensions in the for the visualization. If the array is unstructured, one dimension will be subtracted

allowed_vars = 1

The number variables that one data array visualized by this plotter might have.

bins

Specify the bins of the 2D-Histogramm

This formatoption can be used to specify, how many bins to use. In other words, it determines the grid size of the resulting histogram or kde plot. If however you also set the precision formatoption keyword then the minimum of precision and the bins specified here will be used.

Possible types

int

If 0, only use the bins specified by the precision keyword (raises an error if the precision is also set to 0), otherwise the number of bins to use

tuple (x, y) of int

The bins for x and y explicitly

coord

Use an alternative variable as x-coordinate

This formatoption let’s you specify another variable in the base dataset of the data array in case you want to use this as the x-coordinate instead of the raw data

Possible types

None

Use the default

str

The name of the variable to use in the base dataset

xarray.DataArray

An alternative variable with the same shape as the displayed array

Examples

To see the difference, we create a simple test dataset:

>>> import xarray as xr

>>> import numpy as np

>>> import psyplot.project as psy

>>> ds = xr.Dataset({
...     'temp': xr.Variable(('time', ), np.arange(5)),
...     'std': xr.Variable(('time', ), np.arange(5, 10))})
>>> ds
<xarray.Dataset>
Dimensions:  (time: 5)
Coordinates:
  * time     (time) int64 0 1 2 3 4
Data variables:
    temp     (time) int64 0 1 2 3 4
    std      (time) int64 5 6 7 8 9

If we create a plot with it, we get the 'time' dimension on the x-axis:

>>> plotter = psy.plot.lineplot(ds, name=['temp']).plotters[0]

>>> plotter.plot_data[0].dims
('time',)

If we however set the 'coord' keyword, we get:

>>> plotter = psy.plot.lineplot(
...     ds, name=['temp'], coord='std').plotters[0]

>>> plotter.plot_data[0].dims
('std',)

and 'std' is plotted on the x-axis.

density

Specify the method to calculate the density

Possible types

str

One of the following strings are possible

hist

Make a 2D-histogram. The normalization is controlled by the normed formatoption

kde

Fit a bivariate kernel density estimate to the data. Note that this choice requires pythons [statsmodels] module to be installed

References

[statsmodels]

https://www.statsmodels.org

normed

Specify the normalization of the histogram

This formatoption can be used to normalize the histogram. It has no effect if the density formatoption is set to 'kde'

Possible types

None

Do not make any normalization

str

One of

counts

To make the normalization based on the total number counts

area

To make the normalization basen on the total number of counts and area (the default behaviour of numpy.histogram2d())

x, col, column or columns

To normalize every column

y, row or rows

To normalize every row

See also

density

precision

Set the precision of the data

This formatoption can be used to specify the precision of the data which then will be the minimal bin width of the 2D histogram or the bandwith of the kernel size (if the density formatoption is set to 'kde')

Possible types

float

If 0, this formatoption has no effect at all. Otherwise it is assumed to be the precision of the data

str

One of {'scott' | 'silverman'}. This uses the statsmodels package to estimate the bandwidth of the data that is then used in the histogram or KDE plot

xrange

Specify the range of the histogram for the x-dimension

This formatoption specifies the minimum and maximum of the histogram in the x-dimension

Possible types

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

Notes

This formatoption always acts on the coordinate, no matter what the value of the transpose formatoption is

See also

yrange

yrange

Specify the range of the histogram for the x-dimension

This formatoption specifies the minimum and maximum of the histogram in the x-dimension

Possible types

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

Notes

This formatoption always acts on the DataArray, no matter what the value of the transpose formatoption is

See also

xrange

class psy_simple.plotters.DtTicksBase(*args, **kwargs)

Bases: TicksBase, TicksManager

Abstract base class for x- and y-tick formatoptions

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

Attributes:

dtdata	The np.unique data as datetime objects
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter

Methods:

update(value)

Method that is call to update the formatoption on the axes

property dtdata

The np.unique data as datetime objects

property plot

plot Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.ErrorAlpha(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Set the alpha value for the error range

This formatoption can be used to set the alpha value (opacity) for the error formatoption

Possible types

float

A float between 0 and 1

See also

error

Attributes:

connections	list of str.
error	error Formatoption instance in the plotter
group	str.
name	str.
priority	int.

Methods:

update(value)

Method that is call to update the formatoption on the axes

connections = ['error']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

property error

error Formatoption instance in the plotter

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

name = 'Alpha value of the error range'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.ErrorCalculator(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Calculation of the error

This formatoption is used to calculate the error range.

Possible types

None

Do not calculate any error range

float

A float between 0 and 50. This will represent the distance from the median (i.e. the 50th percentile). A value of 45 will hence correspond to the 5th and 95th percentile

list of 2 floats between 0 and 100

Two floats where the first corresponds to the minimum and the second to the maximum percentile

str

A string with ‘std’ in it. Then we will use the standard deviation. Any number in this string, e.g. ‘3.5std’ will serve as a multiplier (in this case 3.5 times the standard deviation).

See also

mean

Determines how the line is calculated

Attributes:

children	list of str.
data_dependent	bool or a callable.
group	str.
mean	mean Formatoption instance in the plotter
name	str.
priority	int.
requires_replot	Boolean that is True if an update of the formatoption requires a replot

Methods:

update(value)

Method that is call to update the formatoption on the axes

children = ['mean']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

group = 'data'

str. Key of the group name in groups of this formatoption keyword

property mean

mean Formatoption instance in the plotter

name = 'Mean calculation'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 30

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

requires_replot = True

Boolean that is True if an update of the formatoption requires a replot

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.ErrorPlot(*args, **kwargs)

Bases: Formatoption

Visualize the error range

This formatoption visualizes the error range. For this, you must provide a two-dimensional data array as input. The first dimension might be either of length

• 2 to provide the deviation from minimum and maximum error range from the data

• 3 to provide the minimum and maximum error range explicitly

Possible types

None

No errors are visualized

‘fill’

The area between min- and max-error is filled with the same color as the line and the alpha is determined by the fillalpha attribute

Examples

Assume you have the standard deviation stored in the 'std'-variable and the data in the 'data' variable. Then you can visualize the standard deviation simply via:

>>> psy.plot.lineplot(input_ds, name=[['data', 'std']])

On the other hand, assume you want to visualize the area between the 25th and 75th percentile (stored in the variables 'p25' and 'p75'):

>>> psy.plot.lineplot(input_ds, name=[['data', 'p25', 'p75']])

See also

erroralpha

Attributes:

children	list of str.
color	color Formatoption instance in the plotter
data_dependent	bool or a callable.
group	str.
name	str.
plot	plot Formatoption instance in the plotter
plot_fmt	bool.
priority	int.
transpose	transpose Formatoption instance in the plotter

Methods:

make_plot()
plot_fill(index, min_range, max_range, c, ...)
remove()	Method to remove the effects of this formatoption
update(value)	Method that is call to update the formatoption on the axes

children = ['color', 'transpose', 'plot']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

property color

color Formatoption instance in the plotter

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

group = 'plotting'

str. Key of the group name in groups of this formatoption keyword

make_plot()

name = 'Error plot type'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

plot_fill(index, min_range, max_range, c, **kwargs)

plot_fmt = True

bool. Has to be True if the formatoption has a make_plot method to make the plot.

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

remove()

Method to remove the effects of this formatoption

This method is called when the axes is cleared due to a formatoption with requires_clearing set to True. You don’t necessarily have to implement this formatoption if your plot results are removed by the usual matplotlib.axes.Axes.clear() method.

property transpose

transpose Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.Extend(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Draw arrows at the side of the colorbar

Possible types

str {‘neither’, ‘both’, ‘min’ or ‘max’}

If not ‘neither’, make pointed end(s) for out-of-range values

Attributes:

connections	list of str.
group	str.
name	str.
plot	plot Formatoption instance in the plotter

Methods:

update(value)

Method that is call to update the formatoption on the axes

connections = ['plot']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

name = 'Ends of the colorbar'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.FldmeanPlotter(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: LinePlotter

Attributes:

allowed_dims	The number of allowed dimensions in the for the visualization.
coord	Use an alternative variable as x-coordinate
err_calc	Calculation of the error
mask	Mask the data where a certain condition is True
maskbetween	Mask data points between two numbers
maskgeq	Mask data points greater than or equal to a number
maskgreater	Mask data points greater than a number
maskleq	Mask data points smaller than or equal to a number
maskless	Mask data points smaller than a number
mean	Determine how the error is visualized

allowed_dims = 3

The number of allowed dimensions in the for the visualization. If the array is unstructured, one dimension will be subtracted

coord

Use an alternative variable as x-coordinate

This formatoption let’s you specify another variable in the base dataset of the data array in case you want to use this as the x-coordinate instead of the raw data

Possible types

None

Use the default

str

The name of the variable to use in the base dataset

xarray.DataArray

An alternative variable with the same shape as the displayed array

Examples

To see the difference, we create a simple test dataset:

>>> import xarray as xr

>>> import numpy as np

>>> import psyplot.project as psy

>>> ds = xr.Dataset({
...     'temp': xr.Variable(('time', ), np.arange(5)),
...     'std': xr.Variable(('time', ), np.arange(5, 10))})
>>> ds
<xarray.Dataset>
Dimensions:  (time: 5)
Coordinates:
  * time     (time) int64 0 1 2 3 4
Data variables:
    temp     (time) int64 0 1 2 3 4
    std      (time) int64 5 6 7 8 9

If we create a plot with it, we get the 'time' dimension on the x-axis:

>>> plotter = psy.plot.lineplot(ds, name=['temp']).plotters[0]

>>> plotter.plot_data[0].dims
('time',)

If we however set the 'coord' keyword, we get:

>>> plotter = psy.plot.lineplot(
...     ds, name=['temp'], coord='std').plotters[0]

>>> plotter.plot_data[0].dims
('std',)

and 'std' is plotted on the x-axis.

err_calc

Calculation of the error

This formatoption is used to calculate the error range.

Possible types

None

Do not calculate any error range

float

A float between 0 and 50. This will represent the distance from the median (i.e. the 50th percentile). A value of 45 will hence correspond to the 5th and 95th percentile

list of 2 floats between 0 and 100

Two floats where the first corresponds to the minimum and the second to the maximum percentile

str

A string with ‘std’ in it. Then we will use the standard deviation. Any number in this string, e.g. ‘3.5std’ will serve as a multiplier (in this case 3.5 times the standard deviation).

See also

mean

Determines how the line is calculated

mask

Mask the data where a certain condition is True

This formatoption can be used to mask the plotting data based on another array. This array can be the name of a variable in the base dataset, or it can be a numeric array. Note that the data needs to be on exactly the same coordinates as the data shown here

Possible types

None

Apply no mask

str

The name of a variable in the base dataset to use.

• dimensions that are in the given mask but not in the visualized base variable will be aggregated using numpy.any()

• if the given mask misses dimensions that are in the visualized data (i.e. the data of this plotter), we broadcast the mask to match the shape of the data

• dimensions that are in mask and the base variable, but not in the visualized data will be matched against each other

str

The path to a netCDF file that shall be loaded

xr.DataArray or np.ndarray

An array that can be broadcasted to the shape of the data

maskbetween

Mask data points between two numbers

Possible types

float

The floating number to mask above

See also

maskless, maskleq, maskgreater, maskgeq

maskgeq

Mask data points greater than or equal to a number

Possible types

float

The floating number to mask above

See also

maskless, maskleq, maskgreater, maskbetween

maskgreater

Mask data points greater than a number

Possible types

float

The floating number to mask above

See also

maskless, maskleq, maskgeq, maskbetween

maskleq

Mask data points smaller than or equal to a number

Possible types

float

The floating number to mask below

See also

maskless, maskgreater, maskgeq, maskbetween

maskless

Mask data points smaller than a number

Possible types

float

The floating number to mask below

See also

maskleq, maskgreater, maskgeq, maskbetween

mean

Determine how the error is visualized

Possible types

‘mean’

Calculate the weighted mean

‘median’

Calculate the weighted median (i.e. the 50th percentile)

float between 0 and 100

Calculate the given quantile

See also

err_calc

Determines how to calculate the error

class psy_simple.plotters.Grid(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Display the grid

Show the grid on the plot with the specified color.

Possible types

None

If the grid is currently shown, it will not be displayed any longer. If the grid is not shown, it will be drawn

bool

If True, the grid is displayed with the automatic settings (usually black)

string, tuple.

Defines the color of the grid.

Notes

The following color abbreviations are supported:

character	color
‘b’	blue
‘g’	green
‘r’	red
‘c’	cyan
‘m’	magenta
‘y’	yellow
‘k’	black
‘w’	white

In addition, you can specify colors in many weird and wonderful ways, including full names ('green'), hex strings ('#008000'), RGB or RGBA tuples ((0,1,0,1)) or grayscale intensities as a string ('0.8').

Attributes:

group	str.
name	str.

Methods:

update(value)

Method that is call to update the formatoption on the axes

group = 'axes'

str. Key of the group name in groups of this formatoption keyword

name = 'Grid lines'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.Hist2DXRange(*args, **kwargs)

Bases: LimitBase

Specify the range of the histogram for the x-dimension

This formatoption specifies the minimum and maximum of the histogram in the x-dimension

Possible types

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

Notes

This formatoption always acts on the coordinate, no matter what the value of the transpose formatoption is

See also

yrange

Attributes:

array	The numpy array of the data
coord	coord Formatoption instance in the plotter
data_dependent	bool or a callable.
dependencies	list of str.
group	str.
name	str.
plot	plot Formatoption instance in the plotter
priority	int.
transpose	transpose Formatoption instance in the plotter

Methods:

set_limit(*args)

The method to set the minimum and maximum limit

property array

The numpy array of the data

property coord

coord Formatoption instance in the plotter

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

dependencies = ['coord']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

group = 'data'

str. Key of the group name in groups of this formatoption keyword

name = 'Range of the histogram in x-direction'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

priority = 30

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

set_limit(*args)

The method to set the minimum and maximum limit

Parameters:

• min_val (float) – The value for the lower limit

• max_val (float) – The value for the upper limit

property transpose

transpose Formatoption instance in the plotter

class psy_simple.plotters.Hist2DYRange(*args, **kwargs)

Bases: Hist2DXRange

Specify the range of the histogram for the x-dimension

This formatoption specifies the minimum and maximum of the histogram in the x-dimension

Possible types

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

Notes

This formatoption always acts on the DataArray, no matter what the value of the transpose formatoption is

See also

xrange

Attributes:

array	The numpy array of the data
coord	coord Formatoption instance in the plotter
data_dependent	bool or a callable.
name	str.
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter

property array

The numpy array of the data

property coord

coord Formatoption instance in the plotter

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

name = 'Range of the histogram in y-direction'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

class psy_simple.plotters.HistBins(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Specify the bins of the 2D-Histogramm

This formatoption can be used to specify, how many bins to use. In other words, it determines the grid size of the resulting histogram or kde plot. If however you also set the precision formatoption keyword then the minimum of precision and the bins specified here will be used.

Possible types

int

If 0, only use the bins specified by the precision keyword (raises an error if the precision is also set to 0), otherwise the number of bins to use

tuple (x, y) of int

The bins for x and y explicitly

Attributes:

data_dependent	bool or a callable.
dependencies	list of str.
group	str.
name	str.
precision	precision Formatoption instance in the plotter
priority	int.

Methods:

update(value)

Method that is call to update the formatoption on the axes

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

dependencies = ['precision']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

group = 'data'

str. Key of the group name in groups of this formatoption keyword

name = 'Number of bins of the histogram'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property precision

precision Formatoption instance in the plotter

priority = 30

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.InterpolateBounds(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Interpolate grid cell boundaries for 2D plots

This formatoption can be used to tell enable and disable the interpolation of grid cell boundaries. Usually, netCDF files only contain the centered coordinates. In this case, we interpolate the boundaries between the grid cell centers.

Possible types

None

Interpolate the boundaries, except for circumpolar grids

bool

If True (the default), the grid cell boundaries are inter- and extrapolated. Otherwise, if False, the coordinate centers are used and the default behaviour of matplotlib cuts of the most outer row and column of the 2D-data. Note that this results in a slight shift of the data

Attributes:

priority

int.

Methods:

update(value)

Method that is call to update the formatoption on the axes

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.LabelOptions(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: DictFormatoption

Base formatoption class for label sizes

Possible types

dict

A dictionary with the keys 'x' and (or) 'y' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is used for the x- and y-axis. The values in the dictionary can be one types below.

Attributes:

children	list of str.
xlabel	xlabel Formatoption instance in the plotter
ylabel	ylabel Formatoption instance in the plotter

Methods:

update(value)	Method that is call to update the formatoption on the axes
update_axis(value)

children = ['xlabel', 'ylabel']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

abstract update_axis(value)

property xlabel

xlabel Formatoption instance in the plotter

property ylabel

ylabel Formatoption instance in the plotter

class psy_simple.plotters.LabelProps(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: LabelOptions

Set the font properties of both, x- and y-label

Possible types

dict

A dictionary with the keys 'x' and (or) 'y' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is used for the x- and y-axis. The values in the dictionary can be one types below.

dict

Items may be any valid text property

See also

xlabel, ylabel, labelsize, labelweight

Attributes:

children	list of str.
group	str.
labelsize	labelsize Formatoption instance in the plotter
labelweight	labelweight Formatoption instance in the plotter
name	str.
xlabel	xlabel Formatoption instance in the plotter
ylabel	ylabel Formatoption instance in the plotter

Methods:

update_axis(fontprops)

children = ['xlabel', 'ylabel', 'labelsize', 'labelweight']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

group = 'labels'

str. Key of the group name in groups of this formatoption keyword

property labelsize

labelsize Formatoption instance in the plotter

property labelweight

labelweight Formatoption instance in the plotter

name = 'font properties of x- and y-axis label'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

update_axis(fontprops)

property xlabel

xlabel Formatoption instance in the plotter

property ylabel

ylabel Formatoption instance in the plotter

class psy_simple.plotters.LabelSize(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: LabelOptions

Set the size of both, x- and y-label

Possible types

dict

A dictionary with the keys 'x' and (or) 'y' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is used for the x- and y-axis. The values in the dictionary can be one types below.

float

The absolute font size in points (e.g., 12)

string

Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

xlabel, ylabel, labelweight, labelprops

Attributes:

group	str.
labelprops	labelprops Formatoption instance in the plotter
name	str.
parents	list of str.
xlabel	xlabel Formatoption instance in the plotter
ylabel	ylabel Formatoption instance in the plotter

Methods:

update_axis(value)

group = 'labels'

str. Key of the group name in groups of this formatoption keyword

property labelprops

labelprops Formatoption instance in the plotter

name = 'font size of x- and y-axis label'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

parents = ['labelprops']

list of str. List of formatoptions that, if included in the update, prevent the update of this formatoption.

update_axis(value)

property xlabel

xlabel Formatoption instance in the plotter

property ylabel

ylabel Formatoption instance in the plotter

class psy_simple.plotters.LabelWeight(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: LabelOptions

Set the font size of both, x- and y-label

Possible types

dict

A dictionary with the keys 'x' and (or) 'y' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is used for the x- and y-axis. The values in the dictionary can be one types below.

float

a float between 0 and 1000

string

Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

xlabel, ylabel, labelsize, labelprops

Attributes:

group	str.
labelprops	labelprops Formatoption instance in the plotter
name	str.
parents	list of str.
xlabel	xlabel Formatoption instance in the plotter
ylabel	ylabel Formatoption instance in the plotter

Methods:

update_axis(value)

group = 'labels'

str. Key of the group name in groups of this formatoption keyword

property labelprops

labelprops Formatoption instance in the plotter

name = 'font weight of x- and y-axis label'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

parents = ['labelprops']

list of str. List of formatoptions that, if included in the update, prevent the update of this formatoption.

update_axis(value)

property xlabel

xlabel Formatoption instance in the plotter

property ylabel

ylabel Formatoption instance in the plotter

class psy_simple.plotters.Legend(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: DictFormatoption

Draw a legend

This formatoption determines where and if to draw the legend. It uses the labels formatoption to determine the labels.

Possible types

bool

Draw a legend or not

str or int

Specifies where to plot the legend (i.e. the location)

dict

Give the keywords for the matplotlib.pyplot.legend() function

See also

labels

Attributes:

color	color Formatoption instance in the plotter
dependencies	list of str.
legendlabels	legendlabels Formatoption instance in the plotter
marker	marker Formatoption instance in the plotter
name	str.
plot	plot Formatoption instance in the plotter

Methods:

get_artists_and_labels()
remove()	Method to remove the effects of this formatoption
update(value)	Method that is call to update the formatoption on the axes

property color

color Formatoption instance in the plotter

dependencies = ['legendlabels', 'plot', 'color', 'marker']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

get_artists_and_labels()

property legendlabels

legendlabels Formatoption instance in the plotter

property marker

marker Formatoption instance in the plotter

name = 'Properties of the legend'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

remove()

Method to remove the effects of this formatoption

This method is called when the axes is cleared due to a formatoption with requires_clearing set to True. You don’t necessarily have to implement this formatoption if your plot results are removed by the usual matplotlib.axes.Axes.clear() method.

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.LegendLabels(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption, TextBase

Set the labels of the arrays in the legend

This formatoption specifies the labels for each array in the legend. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str:

A single string that shall be used for all arrays.

list of str:

Same as a single string but specified for each array

See also

legend

Attributes:

data_dependent	bool or a callable.
name	str.

Methods:

update(value)

Method that is call to update the formatoption on the axes

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

name = 'Labels in the legend'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.LimitBase(*args, **kwargs)

Bases: DataTicksCalculator

Base class for x- and y-limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

Attributes:

children	list of str.
connections	list of str.
group	str.
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
value2share	The value that is passed to shared formatoptions (by default, the value attribute)

Methods:

set_limit(min_val, max_val)	The method to set the minimum and maximum limit
update(value)	Method that is call to update the formatoption on the axes

children = ['transpose']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

connections = ['plot']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

group = 'axes'

str. Key of the group name in groups of this formatoption keyword

property plot

plot Formatoption instance in the plotter

abstract set_limit(min_val, max_val)

The method to set the minimum and maximum limit

Parameters:

• min_val (float) – The value for the lower limit

• max_val (float) – The value for the upper limit

property transpose

transpose Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

property value2share

The value that is passed to shared formatoptions (by default, the value attribute)

class psy_simple.plotters.LineColors(*args, **kwargs)

Bases: Formatoption

Set the color coding

This formatoptions sets the color of the lines, bars, etc.

Possible types

None

to use the axes color_cycle

iterable

(e.g. list) to specify the colors manually

str

Strings may be any valid colormap name suitable for the matplotlib.cm.get_cmap() function or one of the color lists defined in the ‘colors.cmaps’ key of the psyplot.rcParams dictionary (including their reversed color maps given via the ‘_r’ extension).

matplotlib.colors.ColorMap

to automatically choose the colors according to the number of lines, etc. from the given colormap

Attributes:

extended_colors
group	str.
name	str.
priority	int.
value2pickle	The value that can be used when pickling the information of the project
value2share	The value that is passed to shared formatoptions (by default, the value attribute)

Methods:

update(value)

Method that is call to update the formatoption on the axes

property extended_colors

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

name = 'Color cycle'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

property value2pickle

The value that can be used when pickling the information of the project

property value2share

The value that is passed to shared formatoptions (by default, the value attribute)

class psy_simple.plotters.LinePlot(*args, **kwargs)

Bases: Formatoption

Choose the line style of the plot

Possible types

None

Don’t make any plotting

'area'

To make an area plot (filled between y=0 and y), see matplotlib.pyplot.fill_between()

'areax'

To make a transposed area plot (filled between x=0 and x), see matplotlib.pyplot.fill_betweenx()

'stacked'

Make a stacked plot

str or list of str

The line style string to use ([‘solid’ | ‘dashed’, ‘dashdot’, ‘dotted’ | (offset, on-off-dash-seq) | ‘-’ | ‘–’ | ‘-.’ | ‘:’ | ‘None’ | ‘ ‘ | ‘’]).

Attributes:

children	list of str.
color	color Formatoption instance in the plotter
data_dependent	bool or a callable.
group	str.
marker	marker Formatoption instance in the plotter
name	str.
plot_fmt	bool.
plotted_data	The data that is shown to the user
priority	int.
transpose	transpose Formatoption instance in the plotter

Methods:

make_plot()
plot_arr(arr, c, ls, m)
remove()	Method to remove the effects of this formatoption
update(value)	Method that is call to update the formatoption on the axes

children = ['color', 'transpose', 'marker']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

property color

color Formatoption instance in the plotter

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

group = 'plotting'

str. Key of the group name in groups of this formatoption keyword

make_plot()

property marker

marker Formatoption instance in the plotter

name = 'Line plot type'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

plot_arr(arr, c, ls, m)

plot_fmt = True

bool. Has to be True if the formatoption has a make_plot method to make the plot.

property plotted_data

The data that is shown to the user

priority = 20.1

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

remove()

Method to remove the effects of this formatoption

This method is called when the axes is cleared due to a formatoption with requires_clearing set to True. You don’t necessarily have to implement this formatoption if your plot results are removed by the usual matplotlib.axes.Axes.clear() method.

property transpose

transpose Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.LinePlotter(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: SimplePlotterBase

Plotter for simple one-dimensional line plots

Attributes:

allowed_vars	The number variables that one data array visualized by this plotter might have.
coord	Use an alternative variable as x-coordinate
error	Visualize the error range
erroralpha	Set the alpha value for the error range
linewidth	Choose the width of the lines
marker	Choose the marker for points
markersize	Choose the size of the markers for points
plot	Choose the line style of the plot

allowed_vars = 3

The number variables that one data array visualized by this plotter might have. We allow up to 3 variableswhere the second and third variable might be the errors (see the error formatoption)

coord

Use an alternative variable as x-coordinate

This formatoption let’s you specify another variable in the base dataset of the data array in case you want to use this as the x-coordinate instead of the raw data

Possible types

None

Use the default

str

The name of the variable to use in the base dataset

xarray.DataArray

An alternative variable with the same shape as the displayed array

Examples

To see the difference, we create a simple test dataset:

>>> import xarray as xr

>>> import numpy as np

>>> import psyplot.project as psy

>>> ds = xr.Dataset({
...     'temp': xr.Variable(('time', ), np.arange(5)),
...     'std': xr.Variable(('time', ), np.arange(5, 10))})
>>> ds
<xarray.Dataset>
Dimensions:  (time: 5)
Coordinates:
  * time     (time) int64 0 1 2 3 4
Data variables:
    temp     (time) int64 0 1 2 3 4
    std      (time) int64 5 6 7 8 9

If we create a plot with it, we get the 'time' dimension on the x-axis:

>>> plotter = psy.plot.lineplot(ds, name=['temp']).plotters[0]

>>> plotter.plot_data[0].dims
('time',)

If we however set the 'coord' keyword, we get:

>>> plotter = psy.plot.lineplot(
...     ds, name=['temp'], coord='std').plotters[0]

>>> plotter.plot_data[0].dims
('std',)

and 'std' is plotted on the x-axis.

error

Visualize the error range

This formatoption visualizes the error range. For this, you must provide a two-dimensional data array as input. The first dimension might be either of length

• 2 to provide the deviation from minimum and maximum error range from the data

• 3 to provide the minimum and maximum error range explicitly

Possible types

None

No errors are visualized

‘fill’

The area between min- and max-error is filled with the same color as the line and the alpha is determined by the fillalpha attribute

Examples

Assume you have the standard deviation stored in the 'std'-variable and the data in the 'data' variable. Then you can visualize the standard deviation simply via:

>>> psy.plot.lineplot(input_ds, name=[['data', 'std']])

On the other hand, assume you want to visualize the area between the 25th and 75th percentile (stored in the variables 'p25' and 'p75'):

>>> psy.plot.lineplot(input_ds, name=[['data', 'p25', 'p75']])

See also

erroralpha

erroralpha

Set the alpha value for the error range

This formatoption can be used to set the alpha value (opacity) for the error formatoption

Possible types

float

A float between 0 and 1

See also

error

linewidth

Choose the width of the lines

Possible types

None

Use the default from matplotlibs rcParams

float

The width of the lines

marker

Choose the marker for points

Possible types

None

Use the default from matplotlibs rcParams

str

A valid symbol for the matplotlib markers (see matplotlib.markers)

markersize

Choose the size of the markers for points

Possible types

None

Use the default from matplotlibs rcParams

float

The size of the marker

plot

Choose the line style of the plot

Possible types

None

Don’t make any plotting

'area'

To make an area plot (filled between y=0 and y), see matplotlib.pyplot.fill_between()

'areax'

To make a transposed area plot (filled between x=0 and x), see matplotlib.pyplot.fill_betweenx()

'stacked'

Make a stacked plot

str or list of str

The line style string to use ([‘solid’ | ‘dashed’, ‘dashdot’, ‘dotted’ | (offset, on-off-dash-seq) | ‘-’ | ‘–’ | ‘-.’ | ‘:’ | ‘None’ | ‘ ‘ | ‘’]).

class psy_simple.plotters.LineWidth(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Choose the width of the lines

Possible types

None

Use the default from matplotlibs rcParams

float

The width of the lines

Attributes:

connections	list of str.
plot	plot Formatoption instance in the plotter
priority	int.

Methods:

update(value)

Method that is call to update the formatoption on the axes

connections = ['plot']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

property plot

plot Formatoption instance in the plotter

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.Marker(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Choose the marker for points

Possible types

None

Use the default from matplotlibs rcParams

str

A valid symbol for the matplotlib markers (see matplotlib.markers)

Attributes:

priority

int.

Methods:

update(value)

Method that is call to update the formatoption on the axes

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.MarkerSize(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Choose the size of the markers for points

Possible types

None

Use the default from matplotlibs rcParams

float

The size of the marker

Attributes:

connections	list of str.
plot	plot Formatoption instance in the plotter
priority	int.

Methods:

update(value)

Method that is call to update the formatoption on the axes

connections = ['plot']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

property plot

plot Formatoption instance in the plotter

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.MaskDataGrid(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Mask the datagrid where the array is NaN

This boolean formatoption enables to mask the grid of the datagrid formatoption where the data is NaN

Possible types

bool

Either True, to not display the data grid for cells with NaN, or False

See also

datagrid

Methods:

update(value)

dummy, since this fmt is considered in the :class:`DataGrid ` fmt

update(value)

dummy, since this fmt is considered in the :class:`DataGrid ` fmt

class psy_simple.plotters.MeanCalculator(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Determine how the error is visualized

Possible types

‘mean’

Calculate the weighted mean

‘median’

Calculate the weighted median (i.e. the 50th percentile)

float between 0 and 100

Calculate the given quantile

See also

err_calc

Determines how to calculate the error

Attributes:

data_dependent	bool or a callable.
group	str.
name	str.
priority	int.
requires_replot	Boolean that is True if an update of the formatoption requires a replot

Methods:

update(value)

Method that is call to update the formatoption on the axes

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

group = 'data'

str. Key of the group name in groups of this formatoption keyword

name = 'Mean calculation'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 30

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

requires_replot = True

Boolean that is True if an update of the formatoption requires a replot

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.MissColor(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Set the color for missing values

Possible types

None

Use the default from the colormap

string, tuple.

Defines the color of the grid.

Attributes:

connections	list of str.
dependencies	list of str.
group	str.
name	str.
plot	plot Formatoption instance in the plotter
priority	int.
transform	transform Formatoption instance in the plotter
update_after_plot	bool.

Methods:

remove()	Method to remove the effects of this formatoption
update(value)	Method that is call to update the formatoption on the axes

connections = ['transform']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

dependencies = ['plot']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

name = 'Color of missing values'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

priority = 10

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

remove()

Method to remove the effects of this formatoption

This method is called when the axes is cleared due to a formatoption with requires_clearing set to True. You don’t necessarily have to implement this formatoption if your plot results are removed by the usual matplotlib.axes.Axes.clear() method.

property transform

transform Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

update_after_plot = True

bool. True if this formatoption needs an update after the plot has changed

class psy_simple.plotters.NormedHist2D(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Specify the normalization of the histogram

This formatoption can be used to normalize the histogram. It has no effect if the density formatoption is set to 'kde'

Possible types

None

Do not make any normalization

str

One of

counts

To make the normalization based on the total number counts

area

To make the normalization basen on the total number of counts and area (the default behaviour of numpy.histogram2d())

x, col, column or columns

To normalize every column

y, row or rows

To normalize every row

See also

density

Attributes:

data_dependent	bool or a callable.
group	str.
name	str.
priority	int.

Methods:

hist2d(da, **kwargs)	Make the two dimensional histogram
update(value)	Method that is call to update the formatoption on the axes

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

group = 'data'

str. Key of the group name in groups of this formatoption keyword

hist2d(da, **kwargs)

Make the two dimensional histogram

Parameters:

da (xarray.DataArray) – The data source

name = 'Normalize the histogram'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 30

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.Plot2D(*args, **kwargs)

Bases: Formatoption

Choose how to visualize a 2-dimensional scalar data field

Possible types

None

Don’t make any plotting

‘mesh’

Use the matplotlib.pyplot.pcolormesh() function to make the plot or the matplotlib.pyplot.tripcolor() for an unstructered grid

‘poly’

Draw each polygon indivually. This method is used by default for unstructured grids. If there are no grid cell boundaries in the dataset, we will interpolate them

‘contourf’

Make a filled contour plot using the matplotlib.pyplot.contourf() function. The levels for the contour plot are controlled by the levels formatoption

‘contour’

Same a 'contourf', but does not make a filled contour plot, only lines.

Methods:

add2format_coord(x, y)	Additional information for the format_coord()
get_xyz_1d(xcoord, x, ycoord, y, data)	Get closest x, y and z for the given x and y in data for 1d coords
get_xyz_2d(xcoord, x, ycoord, y, data)	Get closest x, y and z for the given x and y in data for 2d coords
get_xyz_tri(xcoord, x, ycoord, y, data)	Get closest x, y and z for the given x and y in data for 1d coords
make_plot()
remove()	Method to remove the effects of this formatoption
update(value)	Method that is call to update the formatoption on the axes

Attributes:

array	The (masked) data array that is plotted
bounds	bounds Formatoption instance in the plotter
cell_nodes_x	The unstructured x-boundaries with shape (N, m) where m > 2
cell_nodes_y	The unstructured y-boundaries with shape (N, m) where m > 2
children	list of str.
cmap	cmap Formatoption instance in the plotter
data_dependent	bool or a callable.
dependencies	list of str.
format_coord	The function that can replace the axes.format_coord method
group	str.
interp_bounds	interp_bounds Formatoption instance in the plotter
levels	levels Formatoption instance in the plotter
mappable	Returns the mappable that can be used for colorbars
name	str.
notnull_array	The data array that is plotted
plot_fmt	bool.
priority	int.
xbounds	Boundaries of the x-coordinate
xcoord	The x coordinate xarray.Variable
ybounds	Boundaries of the y-coordinate
ycoord	The y coordinate xarray.Variable

add2format_coord(x, y)

Additional information for the format_coord()

property array

The (masked) data array that is plotted

property bounds

bounds Formatoption instance in the plotter

property cell_nodes_x

The unstructured x-boundaries with shape (N, m) where m > 2

property cell_nodes_y

The unstructured y-boundaries with shape (N, m) where m > 2

children = ['cmap', 'bounds']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

property cmap

cmap Formatoption instance in the plotter

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

dependencies = ['levels', 'interp_bounds']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property format_coord

The function that can replace the axes.format_coord method

get_xyz_1d(xcoord, x, ycoord, y, data)

Get closest x, y and z for the given x and y in data for 1d coords

get_xyz_2d(xcoord, x, ycoord, y, data)

Get closest x, y and z for the given x and y in data for 2d coords

get_xyz_tri(xcoord, x, ycoord, y, data)

Get closest x, y and z for the given x and y in data for 1d coords

group = 'plotting'

str. Key of the group name in groups of this formatoption keyword

property interp_bounds

interp_bounds Formatoption instance in the plotter

property levels

levels Formatoption instance in the plotter

make_plot()

property mappable

Returns the mappable that can be used for colorbars

name = '2D plot type'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property notnull_array

The data array that is plotted

plot_fmt = True

bool. Has to be True if the formatoption has a make_plot method to make the plot.

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

remove()

Method to remove the effects of this formatoption

This method is called when the axes is cleared due to a formatoption with requires_clearing set to True. You don’t necessarily have to implement this formatoption if your plot results are removed by the usual matplotlib.axes.Axes.clear() method.

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

property xbounds

Boundaries of the x-coordinate

property xcoord

The x coordinate xarray.Variable

property ybounds

Boundaries of the y-coordinate

property ycoord

The y coordinate xarray.Variable

class psy_simple.plotters.PointDensity(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Specify the method to calculate the density

Possible types

str

One of the following strings are possible

hist

Make a 2D-histogram. The normalization is controlled by the normed formatoption

kde

Fit a bivariate kernel density estimate to the data. Note that this choice requires pythons [statsmodels] module to be installed

References

[statsmodels]

https://www.statsmodels.org

Attributes:

bins	bins Formatoption instance in the plotter
coord	coord Formatoption instance in the plotter
data_dependent	bool or a callable.
dependencies	list of str.
group	str.
name	str.
normed	normed Formatoption instance in the plotter
precision	precision Formatoption instance in the plotter
priority	int.
xrange	xrange Formatoption instance in the plotter
yrange	yrange Formatoption instance in the plotter

Methods:

update(value)

Method that is call to update the formatoption on the axes

property bins

bins Formatoption instance in the plotter

property coord

coord Formatoption instance in the plotter

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

dependencies = ['normed', 'bins', 'xrange', 'yrange', 'precision', 'coord']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

group = 'data'

str. Key of the group name in groups of this formatoption keyword

name = 'Calculation of the point density'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property normed

normed Formatoption instance in the plotter

property precision

precision Formatoption instance in the plotter

priority = 30

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

property xrange

xrange Formatoption instance in the plotter

property yrange

yrange Formatoption instance in the plotter

class psy_simple.plotters.ScalarCombinedBase(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: Plotter

Base plotter for combined 2-dimensional scalar field with any other plotter

Attributes:

bounds	Specify the boundaries of the colorbar
cbar	Specify the position of the colorbars
cticks	Specify the tick locations of the colorbar
maskbetween	Mask data points between two numbers
maskgeq	Mask data points greater than or equal to a number
maskgreater	Mask data points greater than a number
maskleq	Mask data points smaller than or equal to a number
maskless	Mask data points smaller than a number

bounds

Specify the boundaries of the colorbar

Possible types

None

make no normalization

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

int

Specifies how many ticks to use with the 'rounded' option. I.e. if integer i, then this is the same as ['rounded', i].

matplotlib.colors.Normalize

A matplotlib normalization instance

Examples

• Plot 11 bounds over the whole data range:

  >>> plotter.update(bounds='rounded')
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded'})
  

• Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

  >>> plotter.update(bounds=['minmax', 7])
  

  which is equivaluent to:

  >>> plotter.update(bounds={'method': 'minmax', 'N': 7})
  

• chop the first and last five percentiles:

  >>> plotter.update(bounds=['rounded', None, 5, 95])
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded', 'percmin': 5,
  ...                        'percmax': 95})
  

• Plot 3 bounds per power of ten:

  >>> plotter.update(bounds=['log', 3])
  

• Plot continuous logarithmic bounds:

  >>> from matplotlib.colors import LogNorm
  >>> plotter.update(bounds=LogNorm())
  

See also

cmap

Specifies the colormap

cbar

Specify the position of the colorbars

Possible types

bool

True: defaults to ‘b’ False: Don’t draw any colorbar

str

The string can be a combination of one of the following strings: {‘fr’, ‘fb’, ‘fl’, ‘ft’, ‘b’, ‘r’, ‘sv’, ‘sh’}

• ‘b’, ‘r’ stand for bottom and right of the axes

• ‘fr’, ‘fb’, ‘fl’, ‘ft’ stand for bottom, right, left and top of the figure

• ‘sv’ and ‘sh’ stand for a vertical or horizontal colorbar in a separate figure

list

A containing one of the above positions

Examples

Draw a colorbar at the bottom and left of the axes:

>>> plotter.update(cbar='bl')

cticks

Specify the tick locations of the colorbar

Possible types

None

use the default ticks

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

bounds

let the bounds keyword determine the ticks. An additional integer i may be specified to only use every i-th bound as a tick (see also int below)

midbounds

Same as bounds but in the middle between two bounds

int

Specifies how many ticks to use with the 'bounds' option. I.e. if integer i, then this is the same as ['bounds', i].

See also

cticklabels

maskbetween

Mask data points between two numbers

Possible types

float

The floating number to mask above

See also

maskless, maskleq, maskgreater, maskgeq

maskgeq

Mask data points greater than or equal to a number

Possible types

float

The floating number to mask above

See also

maskless, maskleq, maskgreater, maskbetween

maskgreater

Mask data points greater than a number

Possible types

float

The floating number to mask above

See also

maskless, maskleq, maskgeq, maskbetween

maskleq

Mask data points smaller than or equal to a number

Possible types

float

The floating number to mask below

See also

maskless, maskgreater, maskgeq, maskbetween

maskless

Mask data points smaller than a number

Possible types

float

The floating number to mask below

See also

maskleq, maskgreater, maskgeq, maskbetween

class psy_simple.plotters.Simple2DBase(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: Base2D

Base class for Simple2DPlotter and psyplot.plotter.maps.FieldPlotter that defines the data management

Attributes:

allowed_dims	The number of allowed dimensions in the for the visualization.
miss_color	Set the color for missing values

Methods:

check_data(name, dims, is_unstructured)

A validation method for the data shape

allowed_dims = 2

The number of allowed dimensions in the for the visualization. If the array is unstructured, one dimension will be subtracted

classmethod check_data(name, dims, is_unstructured)

A validation method for the data shape

Parameters:

• name (str or list of str) – The variable names (one variable per array)

• dims (list with length 1 or list of lists with length 1) – The dimension of the arrays. Only 1D-Arrays are allowed

• is_unstructured (bool or list of bool) – True if the corresponding array is unstructured.

Returns:

• list of bool or None – True, if everything is okay, False in case of a serious error, None if it is intermediate. Each object in this list corresponds to one in the given name

• list of str – The message giving more information on the reason. Each object in this list corresponds to one in the given name

miss_color

Set the color for missing values

Possible types

None

Use the default from the colormap

string, tuple.

Defines the color of the grid.

class psy_simple.plotters.Simple2DPlotter(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: Simple2DBase, SimplePlotterBase

Plotter for visualizing 2-dimensional data.

See also

psyplot.plotter.maps.FieldPlotter

Attributes:

color
interp_bounds	Interpolate grid cell boundaries for 2D plots
legend
legendlabels
levels	The levels for the contour plot
plot	Specify the plotting method
transpose	Switch x- and y-axes
xlim	Set the x-axis limits
xticks	Modify the x-axis ticks
ylim	Set the y-axis limits
yticks	Modify the y-axis ticks

color = None

interp_bounds

Interpolate grid cell boundaries for 2D plots

This formatoption can be used to tell enable and disable the interpolation of grid cell boundaries. Usually, netCDF files only contain the centered coordinates. In this case, we interpolate the boundaries between the grid cell centers.

Possible types

None

Interpolate the boundaries, except for circumpolar grids

bool

If True (the default), the grid cell boundaries are inter- and extrapolated. Otherwise, if False, the coordinate centers are used and the default behaviour of matplotlib cuts of the most outer row and column of the 2D-data. Note that this results in a slight shift of the data

legend = None

legendlabels = None

levels

The levels for the contour plot

This formatoption sets the levels for the filled contour plot and only has an effect if the plot Formatoption is set to 'contourf'

Possible types

None

Use the settings from the bounds formatoption and if this does not specify boundaries, use 11

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

int

Specifies how many ticks to use with the 'rounded' option. I.e. if integer i, then this is the same as ['rounded', i].

plot

Specify the plotting method

Possible types

None

Don’t make any plotting

‘mesh’

Use the matplotlib.pyplot.pcolormesh() function to make the plot

transpose

Switch x- and y-axes

By default, one-dimensional arrays have the dimension on the x-axis and two dimensional arrays have the first dimension on the y and the second on the x-axis. You can set this formatoption to True to change this behaviour

Possible types

bool

If True, axes are switched

xlim

Set the x-axis limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

ylim

xticks

Modify the x-axis ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

Examples

Plot 11 ticks over the whole data range:

>>> plotter.update(xticks='rounded')

Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

>>> plotter.update(xticks=['minmax', 7])

Plot ticks every year and minor ticks every month:

>>> plotter.update(xticks={'major': 'year', 'minor': 'month'})

See also

xticklabels, ticksize, tickweight, xtickprops, yticks

ylim

Set the y-axis limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

xlim

yticks

Modify the y-axis ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

See also

yticklabels, ticksize, tickweight, ytickprops

xticks

for possible examples

class psy_simple.plotters.SimplePlot2D(*args, **kwargs)

Bases: Plot2D

Specify the plotting method

Possible types

None

Don’t make any plotting

‘mesh’

Use the matplotlib.pyplot.pcolormesh() function to make the plot

Attributes:

array	The (masked) data array that is plotted
bounds	bounds Formatoption instance in the plotter
cell_nodes_x	The unstructured x-boundaries with shape (N, m) where m > 2
cell_nodes_y	The unstructured y-boundaries with shape (N, m) where m > 2
cmap	cmap Formatoption instance in the plotter
data_dependent	bool or a callable.
dependencies	list of str.
interp_bounds	interp_bounds Formatoption instance in the plotter
levels	levels Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
xbounds	Boundaries of the x-coordinate
xcoord	The x coordinate xarray.Variable
ybounds	Boundaries of the y-coordinate
ycoord	The y coordinate xarray.Variable

property array

The (masked) data array that is plotted

property bounds

bounds Formatoption instance in the plotter

property cell_nodes_x

The unstructured x-boundaries with shape (N, m) where m > 2

property cell_nodes_y

The unstructured y-boundaries with shape (N, m) where m > 2

property cmap

cmap Formatoption instance in the plotter

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

dependencies = ['levels', 'interp_bounds', 'transpose']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property interp_bounds

interp_bounds Formatoption instance in the plotter

property levels

levels Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

property xbounds

Boundaries of the x-coordinate

property xcoord

The x coordinate xarray.Variable

property ybounds

Boundaries of the y-coordinate

property ycoord

The y coordinate xarray.Variable

class psy_simple.plotters.SimplePlotterBase(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: BasePlotter, XYTickPlotter

Base class for all simple plotters

Attributes:

allowed_dims	The number of allowed dimensions in the for the visualization.
allowed_vars	The number variables that one data array visualized by this plotter might have.
axiscolor	Color the x- and y-axes
color	Set the color coding
grid	Display the grid
legend	Draw a legend
legendlabels	Set the labels of the arrays in the legend
sym_lims	Make x- and y-axis symmetric
transpose	Switch x- and y-axes
xlim	Set the x-axis limits
ylim	Set the y-axis limits

Methods:

check_data(name, dims[, is_unstructured])

A validation method for the data shape

allowed_dims = 1

The number of allowed dimensions in the for the visualization. If the array is unstructured, one dimension will be subtracted

allowed_vars = 1

The number variables that one data array visualized by this plotter might have.

axiscolor

Color the x- and y-axes

This formatoption colors the left, right, bottom and top axis bar.

Possible types

dict

Keys may be one of {‘right’, ‘left’, ‘bottom’, ‘top’}, the values can be any valid color or None.

Notes

The following color abbreviations are supported:

character	color
‘b’	blue
‘g’	green
‘r’	red
‘c’	cyan
‘m’	magenta
‘y’	yellow
‘k’	black
‘w’	white

In addition, you can specify colors in many weird and wonderful ways, including full names ('green'), hex strings ('#008000'), RGB or RGBA tuples ((0,1,0,1)) or grayscale intensities as a string ('0.8').

classmethod check_data(name, dims, is_unstructured=None)

A validation method for the data shape

Parameters:

• name (str or list of str) – The variable names (at maximum allowed_vars variables per array)

• dims (list with length 1 or list of lists with length 1) – The dimension of the arrays. Only 1D-Arrays are allowed

• is_unstructured (bool or list of bool, optional) – True if the corresponding array is unstructured. This keyword is ignored

Returns:

• list of bool or None – True, if everything is okay, False in case of a serious error, None if it is intermediate. Each object in this list corresponds to one in the given name

• list of str – The message giving more information on the reason. Each object in this list corresponds to one in the given name

color

Set the color coding

This formatoptions sets the color of the lines, bars, etc.

Possible types

None

to use the axes color_cycle

iterable

(e.g. list) to specify the colors manually

str

Strings may be any valid colormap name suitable for the matplotlib.cm.get_cmap() function or one of the color lists defined in the ‘colors.cmaps’ key of the psyplot.rcParams dictionary (including their reversed color maps given via the ‘_r’ extension).

matplotlib.colors.ColorMap

to automatically choose the colors according to the number of lines, etc. from the given colormap

grid

Display the grid

Show the grid on the plot with the specified color.

Possible types

None

If the grid is currently shown, it will not be displayed any longer. If the grid is not shown, it will be drawn

bool

If True, the grid is displayed with the automatic settings (usually black)

string, tuple.

Defines the color of the grid.

Notes

The following color abbreviations are supported:

character	color
‘b’	blue
‘g’	green
‘r’	red
‘c’	cyan
‘m’	magenta
‘y’	yellow
‘k’	black
‘w’	white

In addition, you can specify colors in many weird and wonderful ways, including full names ('green'), hex strings ('#008000'), RGB or RGBA tuples ((0,1,0,1)) or grayscale intensities as a string ('0.8').

legend

Draw a legend

This formatoption determines where and if to draw the legend. It uses the labels formatoption to determine the labels.

Possible types

bool

Draw a legend or not

str or int

Specifies where to plot the legend (i.e. the location)

dict

Give the keywords for the matplotlib.pyplot.legend() function

See also

labels

legendlabels

Set the labels of the arrays in the legend

This formatoption specifies the labels for each array in the legend. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str:

A single string that shall be used for all arrays.

list of str:

Same as a single string but specified for each array

See also

legend

sym_lims

Make x- and y-axis symmetric

Possible types

None

No symmetric type

‘min’

Use the minimum of x- and y-limits

‘max’

Use the maximum of x- and y-limits

[str, str]

A combination, None, 'min' and 'max' specific for minimum and maximum limit

transpose

Switch x- and y-axes

By default, one-dimensional arrays have the dimension on the x-axis and two dimensional arrays have the first dimension on the y and the second on the x-axis. You can set this formatoption to True to change this behaviour

Possible types

bool

If True, axes are switched

xlim

Set the x-axis limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

ylim

ylim

Set the y-axis limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

xlim

class psy_simple.plotters.SimpleVectorPlot(*args, **kwargs)

Bases: VectorPlot

Choose the vector plot type

Possible types

str

Plot types can be either

quiver

to make a quiver plot

stream

to make a stream plot

Attributes:

arrowsize	arrowsize Formatoption instance in the plotter
arrowstyle	arrowstyle Formatoption instance in the plotter
bounds	bounds Formatoption instance in the plotter
cmap	cmap Formatoption instance in the plotter
color	color Formatoption instance in the plotter
data_dependent	bool or a callable.
density	density Formatoption instance in the plotter
linewidth	linewidth Formatoption instance in the plotter
transform	transform Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter

Methods:

set_value(value, *args, **kwargs)

Set (and validate) the value in the plotter.

property arrowsize

arrowsize Formatoption instance in the plotter

property arrowstyle

arrowstyle Formatoption instance in the plotter

property bounds

bounds Formatoption instance in the plotter

property cmap

cmap Formatoption instance in the plotter

property color

color Formatoption instance in the plotter

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

property density

density Formatoption instance in the plotter

property linewidth

linewidth Formatoption instance in the plotter

set_value(value, *args, **kwargs)

Set (and validate) the value in the plotter. This method is called by the plotter when it attempts to change the value of the formatoption.

Parameters:

• value – Value to set

• validate (bool) – if True, validate the value before it is set

• todefault (bool) – True if the value is updated to the default value

property transform

transform Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

class psy_simple.plotters.SimpleVectorPlotter(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: BaseVectorPlotter, SimplePlotterBase

Plotter for visualizing 2-dimensional vector data

See also

psyplot.plotter.maps.VectorPlotter

Attributes:

legend
legendlabels
plot	Choose the vector plot type
xlim	Set the x-axis limits
xticks	Modify the x-axis ticks
ylim	Set the y-axis limits
yticks	Modify the y-axis ticks

legend = None

legendlabels = None

plot

Choose the vector plot type

Possible types

str

Plot types can be either

quiver

to make a quiver plot

stream

to make a stream plot

xlim

Set the x-axis limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

ylim

xticks

Modify the x-axis ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

Examples

Plot 11 ticks over the whole data range:

>>> plotter.update(xticks='rounded')

Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

>>> plotter.update(xticks=['minmax', 7])

Plot ticks every year and minor ticks every month:

>>> plotter.update(xticks={'major': 'year', 'minor': 'month'})

See also

xticklabels, ticksize, tickweight, xtickprops, yticks

ylim

Set the y-axis limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

xlim

yticks

Modify the y-axis ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

See also

yticklabels, ticksize, tickweight, ytickprops

xticks

for possible examples

class psy_simple.plotters.SymmetricLimits(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Make x- and y-axis symmetric

Possible types

None

No symmetric type

‘min’

Use the minimum of x- and y-limits

‘max’

Use the maximum of x- and y-limits

[str, str]

A combination, None, 'min' and 'max' specific for minimum and maximum limit

Attributes:

dependencies	list of str.
name	str.
xlim	xlim Formatoption instance in the plotter
ylim	ylim Formatoption instance in the plotter

Methods:

update(value)

Method that is call to update the formatoption on the axes

dependencies = ['xlim', 'ylim']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

name = 'Symmetric x- and y-axis limits'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

property xlim

xlim Formatoption instance in the plotter

property ylim

ylim Formatoption instance in the plotter

class psy_simple.plotters.TickLabels(*args, **kwargs)

Bases: TickLabelsBase, TicksManager

Methods:

set_default_formatters([which])	Sets the default formatters that is used for updating to None
set_formatter(formatter[, which])	Sets a given formatter
update(value)	Method that is call to update the formatoption on the axes

Attributes:

transpose

transpose Formatoption instance in the plotter

set_default_formatters(which=None)

Sets the default formatters that is used for updating to None

Parameters:

which ({None, 'minor', 'major'}) – Specify which locator shall be set

set_formatter(formatter, which=None)

Sets a given formatter

property transpose

transpose Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.TickLabelsBase(*args, **kwargs)

Bases: TicksManagerBase

Abstract base class for ticklabels

Possible types

str

A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

array

An array of strings to use for the ticklabels

Attributes:

axis	The axis on the axes to modify the ticks of
dependencies	list of str.
group	str.
transpose	transpose Formatoption instance in the plotter

Methods:

initialize_plot(value)	Method that is called when the plot is made the first time
set_default_formatters()	Sets the default formatters that is used for updating to None
set_formatter(formatter)	Sets a given formatter
set_stringformatter(s)
set_ticklabels(labels)	Sets the given tick labels
update_axis(value)

abstract property axis

The axis on the axes to modify the ticks of

dependencies = ['transpose']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

group = 'ticks'

str. Key of the group name in groups of this formatoption keyword

initialize_plot(value)

Method that is called when the plot is made the first time

Parameters:

value – The value to use for the initialization

abstract set_default_formatters()

Sets the default formatters that is used for updating to None

abstract set_formatter(formatter)

Sets a given formatter

set_stringformatter(s)

set_ticklabels(labels)

Sets the given tick labels

property transpose

transpose Formatoption instance in the plotter

update_axis(value)

class psy_simple.plotters.TickPropsBase(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: TicksManagerBase

Abstract base class for tick parameters

Possible types

dict

Items may be anything of the matplotlib.pyplot.tick_params() function

Attributes:

axisname

The name of the axis (either 'x' or 'y')

Methods:

update_axis(value)

abstract property axisname

The name of the axis (either ‘x’ or ‘y’)

update_axis(value)

class psy_simple.plotters.TickSize(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: TickSizeBase, TicksOptions, DictFormatoption

Change the ticksize of the ticklabels

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

float

The absolute font size in points (e.g., 12)

string

Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

tickweight, xtickprops, ytickprops

Attributes:

dependencies	list of str.
name	str.
xtickprops	xtickprops Formatoption instance in the plotter
ytickprops	ytickprops Formatoption instance in the plotter

dependencies = ['xtickprops', 'ytickprops']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

name = 'Font size of the ticklabels'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property xtickprops

xtickprops Formatoption instance in the plotter

property ytickprops

ytickprops Formatoption instance in the plotter

class psy_simple.plotters.TickSizeBase(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: TicksOptions

Abstract base class for modifying tick sizes

Methods:

update_axis(value)

update_axis(value)

class psy_simple.plotters.TickWeight(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: TickWeightBase, TicksOptions, DictFormatoption

Change the fontweight of the ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

float

a float between 0 and 1000

string

Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

ticksize, xtickprops, ytickprops

Attributes:

dependencies	list of str.
name	str.
xtickprops	xtickprops Formatoption instance in the plotter
ytickprops	ytickprops Formatoption instance in the plotter

dependencies = ['xtickprops', 'ytickprops']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

name = 'Font weight of the ticklabels'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property xtickprops

xtickprops Formatoption instance in the plotter

property ytickprops

ytickprops Formatoption instance in the plotter

class psy_simple.plotters.TickWeightBase(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: TicksOptions

Abstract base class for modifying font weight of ticks

Methods:

update_axis(value)

update_axis(value)

class psy_simple.plotters.TicksBase(*args, **kwargs)

Bases: TicksManagerBase, DataTicksCalculator

Abstract base class for calculating ticks

Possible types

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

Attributes:

axis
dependencies	list of str.
group	str.
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter

Methods:

get_locator()
initialize_plot(value)	Method that is called when the plot is made the first time
set_default_locators([which])	Sets the default locator that is used for updating to None or int
set_locator(locator)	Sets the locator corresponding of the axis
set_ticks(value)
update_axis(value)

abstract property axis

dependencies = ['transpose', 'plot']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

get_locator()

group = 'ticks'

str. Key of the group name in groups of this formatoption keyword

initialize_plot(value)

Method that is called when the plot is made the first time

Parameters:

value – The value to use for the initialization

property plot

plot Formatoption instance in the plotter

set_default_locators(which=None)

Sets the default locator that is used for updating to None or int

Parameters:

which ({None, 'minor', 'major'}) – Specify which locator shall be set

set_locator(locator)

Sets the locator corresponding of the axis

Parameters:

• locator (matplotlib.ticker.Locator) – The locator to set

• which ({None, 'minor', 'major'}) – Specify which locator shall be set. If None, it will be taken from the which attribute

set_ticks(value)

property transpose

transpose Formatoption instance in the plotter

update_axis(value)

class psy_simple.plotters.TicksManager(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: TicksManagerBase, DictFormatoption

Abstract base class for ticks formatoptions controlling major and minor ticks

This formatoption simply serves as a base that allows the simultaneous managment of major and minor ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

Attributes:

group

str.

Methods:

update(value)

Method that is call to update the formatoption on the axes

group = 'ticks'

str. Key of the group name in groups of this formatoption keyword

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.TicksManagerBase(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Abstract base class for formatoptions handling ticks

Methods:

update_axis(val)

abstract update_axis(val)

class psy_simple.plotters.TicksOptions(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: TicksManagerBase

Base class for ticklabels options that apply for x- and y-axis

Methods:

update(value)

Method that is call to update the formatoption on the axes

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.Transpose(*args, **kwargs)

Bases: Formatoption

Switch x- and y-axes

By default, one-dimensional arrays have the dimension on the x-axis and two dimensional arrays have the first dimension on the y and the second on the x-axis. You can set this formatoption to True to change this behaviour

Possible types

bool

If True, axes are switched

Methods:

get_x(arr)
get_y(arr)
initialize_plot(value)	Method that is called when the plot is made the first time
update(value)	Method that is call to update the formatoption on the axes

Attributes:

group	str.
name	str.
priority	int.

get_x(arr)

get_y(arr)

group = 'axes'

str. Key of the group name in groups of this formatoption keyword

initialize_plot(value)

Method that is called when the plot is made the first time

Parameters:

value – The value to use for the initialization

name = 'Switch x- and y-axes'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 30

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.VCLabel(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: CLabel

Show the colorbar label of the vector plot

Set the label of the colorbar. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str

The title for the set_label() method.

See also

vclabelsize, vclabelweight, vclabelprops

Attributes:

cbar	cbar Formatoption instance in the plotter
plot	plot Formatoption instance in the plotter

property cbar

cbar Formatoption instance in the plotter

property plot

plot Formatoption instance in the plotter

class psy_simple.plotters.VectorBounds(*args, **kwargs)

Bases: Bounds

Specify the boundaries of the vector colorbar

Possible types

None

make no normalization

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

int

Specifies how many ticks to use with the 'rounded' option. I.e. if integer i, then this is the same as ['rounded', i].

matplotlib.colors.Normalize

A matplotlib normalization instance

Examples

• Plot 11 bounds over the whole data range:

  >>> plotter.update(bounds='rounded')
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded'})
  

• Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

  >>> plotter.update(bounds=['minmax', 7])
  

  which is equivaluent to:

  >>> plotter.update(bounds={'method': 'minmax', 'N': 7})
  

• chop the first and last five percentiles:

  >>> plotter.update(bounds=['rounded', None, 5, 95])
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded', 'percmin': 5,
  ...                        'percmax': 95})
  

• Plot 3 bounds per power of ten:

  >>> plotter.update(bounds=['log', 3])
  

• Plot continuous logarithmic bounds:

  >>> from matplotlib.colors import LogNorm
  >>> plotter.update(bounds=LogNorm())
  

See also

cmap

Specifies the colormap

Attributes:

array	The numpy array of the data
cbar	cbar Formatoption instance in the plotter
cmap	cmap Formatoption instance in the plotter
color	color Formatoption instance in the plotter
parents	list of str.

Methods:

update(*args, **kwargs)

Method that is call to update the formatoption on the axes

property array

The numpy array of the data

property cbar

cbar Formatoption instance in the plotter

property cmap

cmap Formatoption instance in the plotter

property color

color Formatoption instance in the plotter

parents = ['color']

list of str. List of formatoptions that, if included in the update, prevent the update of this formatoption.

update(*args, **kwargs)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.VectorCTicks(*args, **kwargs)

Bases: CTicks

Specify the tick locations of the vector colorbar

Possible types

None

use the default ticks

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

bounds

let the bounds keyword determine the ticks. An additional integer i may be specified to only use every i-th bound as a tick (see also int below)

midbounds

Same as bounds but in the middle between two bounds

int

Specifies how many ticks to use with the 'bounds' option. I.e. if integer i, then this is the same as ['bounds', i].

See also

cticklabels, vcticklabels

Attributes:

array	The numpy array of the data
bounds	bounds Formatoption instance in the plotter
cbar	cbar Formatoption instance in the plotter
cmap	cmap Formatoption instance in the plotter
color	color Formatoption instance in the plotter
dependencies	list of str.
plot	plot Formatoption instance in the plotter

property array

The numpy array of the data

property bounds

bounds Formatoption instance in the plotter

property cbar

cbar Formatoption instance in the plotter

property cmap

cmap Formatoption instance in the plotter

property color

color Formatoption instance in the plotter

dependencies = ['cbar', 'bounds', 'color']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property plot

plot Formatoption instance in the plotter

class psy_simple.plotters.VectorCalculator(*args, **kwargs)

Bases: Formatoption

Abstract formatoption that provides calculation functions for speed, etc.

Possible types

string {‘absolute’, ‘u’, ‘v’}

Strings may define how the formatoption is calculated. Possible strings are

• absolute: for the absolute wind speed

• u: for the u component

• v: for the v component

Attributes:

data_dependent	bool or a callable.
dependencies	list of str.
plot	plot Formatoption instance in the plotter
priority	int.
transpose	transpose Formatoption instance in the plotter

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

dependencies = ['plot', 'transpose']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property plot

plot Formatoption instance in the plotter

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

property transpose

transpose Formatoption instance in the plotter

class psy_simple.plotters.VectorCbar(*args, **kwargs)

Bases: Cbar

Specify the position of the vector plot colorbars

Possible types

bool

True: defaults to ‘b’ False: Don’t draw any colorbar

str

The string can be a combination of one of the following strings: {‘fr’, ‘fb’, ‘fl’, ‘ft’, ‘b’, ‘r’, ‘sv’, ‘sh’}

• ‘b’, ‘r’ stand for bottom and right of the axes

• ‘fr’, ‘fb’, ‘fl’, ‘ft’ stand for bottom, right, left and top of the figure

• ‘sv’ and ‘sh’ stand for a vertical or horizontal colorbar in a separate figure

list

A containing one of the above positions

Attributes:

bounds	bounds Formatoption instance in the plotter
cbarspacing	cbarspacing Formatoption instance in the plotter
cmap	cmap Formatoption instance in the plotter
color	color Formatoption instance in the plotter
dependencies	list of str.
extend	extend Formatoption instance in the plotter
levels	levels Formatoption instance in the plotter
plot	plot Formatoption instance in the plotter
priority	int.

Methods:

update(*args, **kwargs)

Updates the colorbar

property bounds

bounds Formatoption instance in the plotter

property cbarspacing

cbarspacing Formatoption instance in the plotter

property cmap

cmap Formatoption instance in the plotter

property color

color Formatoption instance in the plotter

dependencies = ['plot', 'cmap', 'bounds', 'extend', 'cbarspacing', 'levels', 'color']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property extend

extend Formatoption instance in the plotter

property levels

levels Formatoption instance in the plotter

property plot

plot Formatoption instance in the plotter

priority = 10

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(*args, **kwargs)

Updates the colorbar

Parameters:

• value – The value to update (see possible types)

• no_fig_cbars – Does not update the colorbars that are not in the axes of this plot

class psy_simple.plotters.VectorColor(*args, **kwargs)

Bases: VectorCalculator

Set the color for the arrows

This formatoption can be used to set a single color for the vectors or define the color coding

Possible types

float

Determines the greyness

color

Defines the same color for all arrows. The string can be either a html hex string (e.g. ‘#eeefff’), a single letter (e.g. ‘b’: blue, ‘g’: green, ‘r’: red, ‘c’: cyan, ‘m’: magenta, ‘y’: yellow, ‘k’: black, ‘w’: white) or any other color

string {‘absolute’, ‘u’, ‘v’}

Strings may define how the formatoption is calculated. Possible strings are

• absolute: for the absolute wind speed

• u: for the u component

• v: for the v component

2D-array

The values determine the color for each plotted arrow. Note that the shape has to match the one of u and v.

See also

arrowsize, arrowstyle, density, linewidth

Attributes:

bounds	bounds Formatoption instance in the plotter
cmap	cmap Formatoption instance in the plotter
dependencies	list of str.
group	str.
name	str.
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter

Methods:

update(value)

Method that is call to update the formatoption on the axes

property bounds

bounds Formatoption instance in the plotter

property cmap

cmap Formatoption instance in the plotter

dependencies = ['plot', 'transpose', 'cmap', 'bounds']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

name = 'Color of the arrows'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.VectorDataGrid(*args, **kwargs)

Bases: DataGrid

Attributes:

data	The data that is plotted
mask_datagrid	mask_datagrid Formatoption instance in the plotter
plot	plot Formatoption instance in the plotter
transform	transform Formatoption instance in the plotter

property data

The data that is plotted

property mask_datagrid

mask_datagrid Formatoption instance in the plotter

property plot

plot Formatoption instance in the plotter

property transform

transform Formatoption instance in the plotter

class psy_simple.plotters.VectorLineWidth(*args, **kwargs)

Bases: VectorCalculator

Change the linewidth of the arrows

Possible types

float

give the linewidth explicitly

string {‘absolute’, ‘u’, ‘v’}

Strings may define how the formatoption is calculated. Possible strings are

• absolute: for the absolute wind speed

• u: for the u component

• v: for the v component

tuple (string, float)

string may be one of the above strings, float may be a scaling factor

2D-array

The values determine the linewidth for each plotted arrow. Note that the shape has to match the one of u and v.

See also

arrowsize, arrowstyle, density, color

Attributes:

name	str.
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter

Methods:

update(value)

Method that is call to update the formatoption on the axes

name = 'Linewidth of the arrows'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.VectorPlot(*args, **kwargs)

Bases: Formatoption

Choose the vector plot type

Possible types

str

Plot types can be either

quiver

to make a quiver plot

stream

to make a stream plot

Methods:

add2format_coord(x, y)	Additional information for the format_coord()
get_xyz_1d(xcoord, x, ycoord, y, u, v)	Get closest x, y and z for the given x and y in data for 1d coords
get_xyz_2d(xcoord, x, ycoord, y, u, v)	Get closest x, y and z for the given x and y in data for 2d coords
get_xyz_tri(xcoord, x, ycoord, y, u, v)	Get closest x, y and z for the given x and y in data for 1d coords
make_plot()
remove()	Method to remove the effects of this formatoption
update(value)	Method that is call to update the formatoption on the axes

Attributes:

array
arrowsize	arrowsize Formatoption instance in the plotter
arrowstyle	arrowstyle Formatoption instance in the plotter
bounds	bounds Formatoption instance in the plotter
children	list of str.
cmap	cmap Formatoption instance in the plotter
color	color Formatoption instance in the plotter
connections	list of str.
data_dependent	bool or a callable.
density	density Formatoption instance in the plotter
format_coord	The function that can replace the axes.format_coord method
group	str.
linewidth	linewidth Formatoption instance in the plotter
mappable	The mappable, i.e. the container of the plot.
name	str.
plot_fmt	bool.
priority	int.
transform	transform Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
xcoord	The x coordinate xarray.Variable
ycoord	The y coordinate xarray.Variable

add2format_coord(x, y)

Additional information for the format_coord()

property array

property arrowsize

arrowsize Formatoption instance in the plotter

property arrowstyle

arrowstyle Formatoption instance in the plotter

property bounds

bounds Formatoption instance in the plotter

children = ['cmap', 'bounds']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

property cmap

cmap Formatoption instance in the plotter

property color

color Formatoption instance in the plotter

connections = ['transpose', 'transform', 'arrowsize', 'arrowstyle', 'density', 'linewidth', 'color']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

property density

density Formatoption instance in the plotter

property format_coord

The function that can replace the axes.format_coord method

get_xyz_1d(xcoord, x, ycoord, y, u, v)

Get closest x, y and z for the given x and y in data for 1d coords

get_xyz_2d(xcoord, x, ycoord, y, u, v)

Get closest x, y and z for the given x and y in data for 2d coords

get_xyz_tri(xcoord, x, ycoord, y, u, v)

Get closest x, y and z for the given x and y in data for 1d coords

group = 'plotting'

str. Key of the group name in groups of this formatoption keyword

property linewidth

linewidth Formatoption instance in the plotter

make_plot()

property mappable

The mappable, i.e. the container of the plot

name = 'Plot type of the arrows'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

plot_fmt = True

bool. Has to be True if the formatoption has a make_plot method to make the plot.

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

remove()

Method to remove the effects of this formatoption

This method is called when the axes is cleared due to a formatoption with requires_clearing set to True. You don’t necessarily have to implement this formatoption if your plot results are removed by the usual matplotlib.axes.Axes.clear() method.

property transform

transform Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

property xcoord

The x coordinate xarray.Variable

property ycoord

The y coordinate xarray.Variable

class psy_simple.plotters.ViolinPlot(*args, **kwargs)

Bases: Formatoption

Choose how to make the violin plot

Possible types

None or False

Don’t make any plotting

bool

If True, visualize the violins

Attributes:

children	list of str.
color	color Formatoption instance in the plotter
data_dependent	bool or a callable.
group	str.
name	str.
plot_fmt	bool.
priority	int.
transpose	transpose Formatoption instance in the plotter

Methods:

make_plot()
remove()	Method to remove the effects of this formatoption
update(value)	Method that is call to update the formatoption on the axes

children = ['color', 'transpose']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

property color

color Formatoption instance in the plotter

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

group = 'plotting'

str. Key of the group name in groups of this formatoption keyword

make_plot()

name = 'Violin plot type'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

plot_fmt = True

bool. Has to be True if the formatoption has a make_plot method to make the plot.

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

remove()

Method to remove the effects of this formatoption

This method is called when the axes is cleared due to a formatoption with requires_clearing set to True. You don’t necessarily have to implement this formatoption if your plot results are removed by the usual matplotlib.axes.Axes.clear() method.

property transpose

transpose Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.ViolinPlotter(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: SimplePlotterBase

Plotter for making violin plots

Attributes:

plot	Choose how to make the violin plot
xlim	Set the x-axis limits
xticklabels	Modify the x-axis ticklabels
xticks	Modify the x-axis ticks
ylim	Set the y-axis limits
yticklabels	Modify the x-axis ticklabels
yticks	Modify the y-axis ticks

plot

Choose how to make the violin plot

Possible types

None or False

Don’t make any plotting

bool

If True, visualize the violins

xlim

Set the x-axis limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

ylim

xticklabels

Modify the x-axis ticklabels

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

str

A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

array

An array of strings to use for the ticklabels

See also

xticks, ticksize, tickweight, xtickprops, yticklabels

xticks

Modify the x-axis ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

Examples

Plot 11 ticks over the whole data range:

>>> plotter.update(xticks='rounded')

Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

>>> plotter.update(xticks=['minmax', 7])

Plot ticks every year and minor ticks every month:

>>> plotter.update(xticks={'major': 'year', 'minor': 'month'})

See also

xticklabels, ticksize, tickweight, xtickprops, yticks

ylim

Set the y-axis limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

xlim

yticklabels

Modify the x-axis ticklabels

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

str

A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

array

An array of strings to use for the ticklabels

See also

xticks, ticksize, tickweight, xtickprops, yticklabels

yticks

Modify the y-axis ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

See also

yticklabels, ticksize, tickweight, ytickprops

xticks

for possible examples

class psy_simple.plotters.ViolinXTickLabels(*args, **kwargs)

Bases: XTickLabels, TextBase

Modify the x-axis ticklabels

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

str

A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

array

An array of strings to use for the ticklabels

See also

xticks, ticksize, tickweight, xtickprops, yticklabels

Attributes:

data_dependent	bool or a callable.
transpose	transpose Formatoption instance in the plotter
xticks	xticks Formatoption instance in the plotter
yticklabels	yticklabels Formatoption instance in the plotter

Methods:

update_axis(value)

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

property transpose

transpose Formatoption instance in the plotter

update_axis(value)

property xticks

xticks Formatoption instance in the plotter

property yticklabels

yticklabels Formatoption instance in the plotter

class psy_simple.plotters.ViolinXTicks(*args, **kwargs)

Bases: XTicks

Modify the x-axis ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

Examples

Plot 11 ticks over the whole data range:

>>> plotter.update(xticks='rounded')

Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

>>> plotter.update(xticks=['minmax', 7])

Plot ticks every year and minor ticks every month:

>>> plotter.update(xticks={'major': 'year', 'minor': 'month'})

See also

xticklabels, ticksize, tickweight, xtickprops, yticks

Attributes:

array	The numpy array of the data
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
yticks	yticks Formatoption instance in the plotter

property array

The numpy array of the data

property plot

plot Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

property yticks

yticks Formatoption instance in the plotter

class psy_simple.plotters.ViolinXlim(*args, **kwargs)

Bases: Xlim

Set the x-axis limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

ylim

Attributes:

array	The numpy array of the data
plot	plot Formatoption instance in the plotter
sym_lims	sym_lims Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
xticks	xticks Formatoption instance in the plotter
ylim	ylim Formatoption instance in the plotter

property array

The numpy array of the data

property plot

plot Formatoption instance in the plotter

property sym_lims

sym_lims Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

property xticks

xticks Formatoption instance in the plotter

property ylim

ylim Formatoption instance in the plotter

class psy_simple.plotters.ViolinYTickLabels(*args, **kwargs)

Bases: YTickLabels, TextBase

Modify the x-axis ticklabels

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

str

A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

array

An array of strings to use for the ticklabels

See also

xticks, ticksize, tickweight, xtickprops, yticklabels

Attributes:

data_dependent	bool or a callable.
transpose	transpose Formatoption instance in the plotter
yticks	yticks Formatoption instance in the plotter

Methods:

update_axis(value)

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

property transpose

transpose Formatoption instance in the plotter

update_axis(value)

property yticks

yticks Formatoption instance in the plotter

class psy_simple.plotters.ViolinYTicks(*args, **kwargs)

Bases: YTicks

Modify the y-axis ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

See also

yticklabels, ticksize, tickweight, ytickprops

xticks

for possible examples

Attributes:

array	The numpy array of the data
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter

property array

The numpy array of the data

property plot

plot Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

class psy_simple.plotters.ViolinYlim(*args, **kwargs)

Bases: Ylim

Set the y-axis limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

xlim

Attributes:

array	The numpy array of the data
plot	plot Formatoption instance in the plotter
sym_lims	sym_lims Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
xlim	xlim Formatoption instance in the plotter
yticks	yticks Formatoption instance in the plotter

property array

The numpy array of the data

property plot

plot Formatoption instance in the plotter

property sym_lims

sym_lims Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

property xlim

xlim Formatoption instance in the plotter

property yticks

yticks Formatoption instance in the plotter

class psy_simple.plotters.XRotation(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Rotate the x-axis ticks

Possible types

float

The rotation angle in degrees

See also

yrotation

Attributes:

children	list of str.
group	str.
name	str.
yticklabels	yticklabels Formatoption instance in the plotter

Methods:

update(value)

Method that is call to update the formatoption on the axes

children = ['yticklabels']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

group = 'ticks'

str. Key of the group name in groups of this formatoption keyword

name = 'Rotate x-ticklabels'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

property yticklabels

yticklabels Formatoption instance in the plotter

class psy_simple.plotters.XTickLabels(*args, **kwargs)

Bases: TickLabels

Modify the x-axis ticklabels

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

str

A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

array

An array of strings to use for the ticklabels

See also

xticks, ticksize, tickweight, xtickprops, yticklabels

Attributes:

axis	The axis on the axes to modify the ticks of
dependencies	list of str.
name	str.
transpose	transpose Formatoption instance in the plotter
xticks	xticks Formatoption instance in the plotter
yticklabels	yticklabels Formatoption instance in the plotter

Methods:

initialize_plot(*args, **kwargs)

Method that is called when the plot is made the first time

property axis

The axis on the axes to modify the ticks of

dependencies = ['transpose', 'xticks', 'yticklabels']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

initialize_plot(*args, **kwargs)

Method that is called when the plot is made the first time

Parameters:

value – The value to use for the initialization

name = 'x-xxis Ticklabels'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property transpose

transpose Formatoption instance in the plotter

property xticks

xticks Formatoption instance in the plotter

property yticklabels

yticklabels Formatoption instance in the plotter

class psy_simple.plotters.XTickProps(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: TickPropsBase, TicksManager, DictFormatoption

Specify the x-axis tick parameters

This formatoption can be used to make a detailed change of the ticks parameters on the x-axis.

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

dict

Items may be anything of the matplotlib.pyplot.tick_params() function

See also

xticks, yticks, ticksize, tickweight, ytickprops

Attributes:

axis
axisname
name	str.

property axis

axisname = 'x'

name = 'Font properties of the x-ticklabels'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

class psy_simple.plotters.XTicks(*args, **kwargs)

Bases: DtTicksBase

Modify the x-axis ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

Examples

Plot 11 ticks over the whole data range:

>>> plotter.update(xticks='rounded')

Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

>>> plotter.update(xticks=['minmax', 7])

Plot ticks every year and minor ticks every month:

>>> plotter.update(xticks={'major': 'year', 'minor': 'month'})

See also

xticklabels, ticksize, tickweight, xtickprops, yticks

Attributes:

axis
children	list of str.
data	The data that is plotted
dependencies	list of str.
name	str.
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
yticks	yticks Formatoption instance in the plotter

Methods:

initialize_plot(*args, **kwargs)

Method that is called when the plot is made the first time

property axis

children = ['yticks']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

property data

The data that is plotted

dependencies = ['transpose', 'plot', 'plot']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

initialize_plot(*args, **kwargs)

Method that is called when the plot is made the first time

Parameters:

value – The value to use for the initialization

name = 'Location of the x-Axis ticks'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

property yticks

yticks Formatoption instance in the plotter

class psy_simple.plotters.XTicks2D(*args, **kwargs)

Bases: XTicks

Modify the x-axis ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

Examples

Plot 11 ticks over the whole data range:

>>> plotter.update(xticks='rounded')

Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

>>> plotter.update(xticks=['minmax', 7])

Plot ticks every year and minor ticks every month:

>>> plotter.update(xticks={'major': 'year', 'minor': 'month'})

See also

xticklabels, ticksize, tickweight, xtickprops, yticks

Attributes:

data	The data that is plotted
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
yticks	yticks Formatoption instance in the plotter

property data

The data that is plotted

property plot

plot Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

property yticks

yticks Formatoption instance in the plotter

class psy_simple.plotters.XYTickPlotter(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: Plotter

Plotter class for x- and y-ticks and x- and y- ticklabels

Attributes:

labelprops	Set the font properties of both, x- and y-label
labelsize	Set the size of both, x- and y-label
labelweight	Set the font size of both, x- and y-label
ticksize	Change the ticksize of the ticklabels
tickweight	Change the fontweight of the ticks
transpose	Switch x- and y-axes
xlabel	Set the x-axis label
xrotation	Rotate the x-axis ticks
xticklabels	Modify the x-axis ticklabels
xtickprops	Specify the x-axis tick parameters
xticks	Modify the x-axis ticks
ylabel	Set the y-axis label
yrotation	Rotate the y-axis ticks
yticklabels	Modify the y-axis ticklabels
ytickprops	Specify the y-axis tick parameters
yticks	Modify the y-axis ticks

labelprops

Set the font properties of both, x- and y-label

Possible types

dict

A dictionary with the keys 'x' and (or) 'y' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is used for the x- and y-axis. The values in the dictionary can be one types below.

dict

Items may be any valid text property

See also

xlabel, ylabel, labelsize, labelweight

labelsize

Set the size of both, x- and y-label

Possible types

dict

A dictionary with the keys 'x' and (or) 'y' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is used for the x- and y-axis. The values in the dictionary can be one types below.

float

The absolute font size in points (e.g., 12)

string

Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

xlabel, ylabel, labelweight, labelprops

labelweight

Set the font size of both, x- and y-label

Possible types

dict

A dictionary with the keys 'x' and (or) 'y' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is used for the x- and y-axis. The values in the dictionary can be one types below.

float

a float between 0 and 1000

string

Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

xlabel, ylabel, labelsize, labelprops

ticksize

Change the ticksize of the ticklabels

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

float

The absolute font size in points (e.g., 12)

string

Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

tickweight, xtickprops, ytickprops

tickweight

Change the fontweight of the ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

float

a float between 0 and 1000

string

Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

ticksize, xtickprops, ytickprops

transpose

Switch x- and y-axes

By default, one-dimensional arrays have the dimension on the x-axis and two dimensional arrays have the first dimension on the y and the second on the x-axis. You can set this formatoption to True to change this behaviour

Possible types

bool

If True, axes are switched

xlabel

Set the x-axis label

Set the label for the x-axis. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str

The text for the xlabel() function.

See also

xlabelsize, xlabelweight, xlabelprops

xrotation

Rotate the x-axis ticks

Possible types

float

The rotation angle in degrees

See also

yrotation

xticklabels

Modify the x-axis ticklabels

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

str

A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

array

An array of strings to use for the ticklabels

See also

xticks, ticksize, tickweight, xtickprops, yticklabels

xtickprops

Specify the x-axis tick parameters

This formatoption can be used to make a detailed change of the ticks parameters on the x-axis.

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

dict

Items may be anything of the matplotlib.pyplot.tick_params() function

See also

xticks, yticks, ticksize, tickweight, ytickprops

xticks

Modify the x-axis ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

Examples

Plot 11 ticks over the whole data range:

>>> plotter.update(xticks='rounded')

Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

>>> plotter.update(xticks=['minmax', 7])

Plot ticks every year and minor ticks every month:

>>> plotter.update(xticks={'major': 'year', 'minor': 'month'})

See also

xticklabels, ticksize, tickweight, xtickprops, yticks

ylabel

Set the y-axis label

Set the label for the y-axis. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str

The text for the ylabel() function.

See also

ylabelsize, ylabelweight, ylabelprops

yrotation

Rotate the y-axis ticks

Possible types

float

The rotation angle in degrees

See also

xrotation

yticklabels

Modify the y-axis ticklabels

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

str

A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

array

An array of strings to use for the ticklabels

See also

yticks, ticksize, tickweight, ytickprops, xticklabels

ytickprops

Specify the y-axis tick parameters

This formatoption can be used to make a detailed change of the ticks parameters of the y-axis.

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

dict

Items may be anything of the matplotlib.pyplot.tick_params() function

See also

xticks, yticks, ticksize, tickweight, xtickprops

yticks

Modify the y-axis ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

See also

yticklabels, ticksize, tickweight, ytickprops

xticks

for possible examples

class psy_simple.plotters.Xlabel(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: TextBase, Formatoption

Set the x-axis label

Set the label for the x-axis. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str

The text for the xlabel() function.

See also

xlabelsize, xlabelweight, xlabelprops

Attributes:

children	list of str.
enhanced_attrs	The enhanced attributes of the array
name	str.
transpose	transpose Formatoption instance in the plotter
ylabel	ylabel Formatoption instance in the plotter

Methods:

initialize_plot(value)	Method that is called when the plot is made the first time
update(value)	Method that is call to update the formatoption on the axes

children = ['transpose', 'ylabel']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

property enhanced_attrs

The enhanced attributes of the array

initialize_plot(value)

Method that is called when the plot is made the first time

Parameters:

value – The value to use for the initialization

name = 'x-axis label'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property transpose

transpose Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

property ylabel

ylabel Formatoption instance in the plotter

class psy_simple.plotters.Xlim(*args, **kwargs)

Bases: LimitBase

Set the x-axis limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

ylim

Attributes:

array	The numpy array of the data
axisname
children	list of str.
connections	list of str.
dependencies	list of str.
name	str.
plot	plot Formatoption instance in the plotter
sym_lims	sym_lims Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
xticks	xticks Formatoption instance in the plotter
ylim	ylim Formatoption instance in the plotter

Methods:

initialize_plot(value)	Method that is called when the plot is made the first time
set_limit(*args)	The method to set the minimum and maximum limit

property array

The numpy array of the data

axisname = 'x'

children = ['transpose', 'ylim']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

connections = ['plot', 'sym_lims']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

dependencies = ['xticks']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

initialize_plot(value)

Method that is called when the plot is made the first time

Parameters:

value – The value to use for the initialization

name = 'x-axis limits'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

set_limit(*args)

The method to set the minimum and maximum limit

Parameters:

• min_val (float) – The value for the lower limit

• max_val (float) – The value for the upper limit

property sym_lims

sym_lims Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

property xticks

xticks Formatoption instance in the plotter

property ylim

ylim Formatoption instance in the plotter

class psy_simple.plotters.Xlim2D(*args, **kwargs)

Bases: Xlim

Set the x-axis limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

ylim

Attributes:

array	The numpy array of the data
plot	plot Formatoption instance in the plotter
sym_lims	sym_lims Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
xticks	xticks Formatoption instance in the plotter
ylim	ylim Formatoption instance in the plotter

property array

The numpy array of the data

property plot

plot Formatoption instance in the plotter

property sym_lims

sym_lims Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

property xticks

xticks Formatoption instance in the plotter

property ylim

ylim Formatoption instance in the plotter

class psy_simple.plotters.YRotation(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: Formatoption

Rotate the y-axis ticks

Possible types

float

The rotation angle in degrees

See also

xrotation

Attributes:

children	list of str.
group	str.
name	str.
yticklabels	yticklabels Formatoption instance in the plotter

Methods:

update(value)

Method that is call to update the formatoption on the axes

children = ['yticklabels']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

group = 'ticks'

str. Key of the group name in groups of this formatoption keyword

name = 'Rotate y-ticklabels'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

property yticklabels

yticklabels Formatoption instance in the plotter

class psy_simple.plotters.YTickLabels(*args, **kwargs)

Bases: TickLabels

Modify the y-axis ticklabels

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

str

A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

array

An array of strings to use for the ticklabels

See also

yticks, ticksize, tickweight, ytickprops, xticklabels

Attributes:

axis	The axis on the axes to modify the ticks of
dependencies	list of str.
name	str.
transpose	transpose Formatoption instance in the plotter
yticks	yticks Formatoption instance in the plotter

property axis

The axis on the axes to modify the ticks of

dependencies = ['transpose', 'yticks']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

name = 'y-xxis ticklabels'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property transpose

transpose Formatoption instance in the plotter

property yticks

yticks Formatoption instance in the plotter

class psy_simple.plotters.YTickProps(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: XTickProps

Specify the y-axis tick parameters

This formatoption can be used to make a detailed change of the ticks parameters of the y-axis.

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

dict

Items may be anything of the matplotlib.pyplot.tick_params() function

See also

xticks, yticks, ticksize, tickweight, xtickprops

Attributes:

axis
axisname
name	str.

property axis

axisname = 'y'

name = 'Font properties of the y-ticklabels'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

class psy_simple.plotters.YTicks(*args, **kwargs)

Bases: DtTicksBase

Modify the y-axis ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

See also

yticklabels, ticksize, tickweight, ytickprops

xticks

for possible examples

Attributes:

axis
data	The data that is plotted
dependencies	list of str.
name	str.
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter

property axis

property data

The data that is plotted

dependencies = ['transpose', 'plot', 'plot']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

name = 'Location of the y-Axis ticks'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

class psy_simple.plotters.YTicks2D(*args, **kwargs)

Bases: YTicks

Modify the y-axis ticks

Possible types

dict

A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

None

use the default ticks

int

for an integer i, only every i-th tick of the default ticks are used

numeric array

specifies the ticks manually

str or list [str, …]

A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

dict

Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

N

An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

percmin

The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

percmax

The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

vmin

The minimum to use (in which case it is not calculated from the specified method)

vmax

The maximum to use (in which case it is not calculated from the specified method)

method

A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

data

plot the ticks exactly where the data is.

mid

plot the ticks in the middle of the data.

rounded

Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the ticks are chose such that they are symmetric around zero

minmax

Uses the minimum as minimal tick and maximum as maximal tick

sym

Same as minmax but symmetric around zero

log

Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

symlog

The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

hour

draw ticks every hour

day

draw ticks every day

week

draw ticks every week

month, monthend, monthbegin

draw ticks in the middle, at the end or at the beginning of each month

year, yearend, yearbegin

draw ticks in the middle, at the end or at the beginning of each year

For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

See also

yticklabels, ticksize, tickweight, ytickprops

xticks

for possible examples

Attributes:

data	The data that is plotted
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter

property data

The data that is plotted

property plot

plot Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

class psy_simple.plotters.Ylabel(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: TextBase, Formatoption

Set the y-axis label

Set the label for the y-axis. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str

The text for the ylabel() function.

See also

ylabelsize, ylabelweight, ylabelprops

Attributes:

children	list of str.
enhanced_attrs	The enhanced attributes of the array
name	str.
transpose	transpose Formatoption instance in the plotter

Methods:

initialize_plot(value)	Method that is called when the plot is made the first time
update(value)	Method that is call to update the formatoption on the axes

children = ['transpose']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

property enhanced_attrs

The enhanced attributes of the array

initialize_plot(value)

Method that is called when the plot is made the first time

Parameters:

value – The value to use for the initialization

name = 'y-axis label'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property transpose

transpose Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters:

value – Value to update

class psy_simple.plotters.Ylim(*args, **kwargs)

Bases: LimitBase

Set the y-axis limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

xlim

Attributes:

array	The numpy array of the data
axisname
children	list of str.
connections	list of str.
dependencies	list of str.
name	str.
plot	plot Formatoption instance in the plotter
sym_lims	sym_lims Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
xlim	xlim Formatoption instance in the plotter
yticks	yticks Formatoption instance in the plotter

Methods:

set_limit(*args)

The method to set the minimum and maximum limit

property array

The numpy array of the data

axisname = 'y'

children = ['transpose', 'xlim']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

connections = ['plot', 'sym_lims']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

dependencies = ['yticks']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

name = 'y-axis limits'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

set_limit(*args)

The method to set the minimum and maximum limit

Parameters:

• min_val (float) – The value for the lower limit

• max_val (float) – The value for the upper limit

property sym_lims

sym_lims Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

property xlim

xlim Formatoption instance in the plotter

property yticks

yticks Formatoption instance in the plotter

class psy_simple.plotters.Ylim2D(*args, **kwargs)

Bases: Ylim

Set the y-axis limits

Possible types

None

To not change the current limits

str or list [str, str] or [[str, float], [str, float]]

Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

rounded

Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

roundedsym

Same as rounded above but the limits are chosen such that they are symmetric around zero

minmax

Uses the minimum and maximum

sym

Same as minmax but symmetric around zero

tuple (xmin, xmax)

xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

xlim

Attributes:

array	The numpy array of the data
plot	plot Formatoption instance in the plotter
sym_lims	sym_lims Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
xlim	xlim Formatoption instance in the plotter
yticks	yticks Formatoption instance in the plotter

property array

The numpy array of the data

property plot

plot Formatoption instance in the plotter

property sym_lims

sym_lims Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

property xlim

xlim Formatoption instance in the plotter

property yticks

yticks Formatoption instance in the plotter

psy_simple.plotters.convert_radian(coord, *variables)

Convert the given coordinate from radian to degree

Parameters:

• coord (xr.Variable) – The variable to transform

• *variables – The variables that are on the same unit.

Returns:

The transformed variable if one of the given variables has units in radian

Return type:

xr.Variable

psy_simple.plotters.format_coord_func(ax, ref)

Create a function that can replace the matplotlib.axes.Axes.format_coord()

Parameters:

• ax (matplotlib.axes.Axes) – The axes instance

• ref (weakref.weakref) – The reference to the Formatoption instance

Returns:

The function that can be used to replace ax.format_coord

Return type:

function

psy_simple.plotters.round_to_05(n, exp=None, mode='s')

Round to the next 0.5-value.

This function applies the round function func to round n to the next 0.5-value with respect to its exponent with base 10 (i.e. 1.3e-4 will be rounded to 1.5e-4) if exp is None or with respect to the given exponent in exp.

Parameters:

• n (numpy.ndarray) – number to round

• exp (int or numpy.ndarray) – Exponent for rounding. If None, it will be computed from n to be the exponents for base 10.

• mode ({'s', 'l'}) – rounding mode. If ‘s’, it will be rounded to value whose absolute value is below n, if ‘l’ it will rounded to the value whose absolute value is above n.

Returns:

rounded n

Return type:

numpy.ndarray

Examples

The effects of the different parameters are show in the example below:

>>> from psyplot.plotter.simple import round_to_05
>>> a = [-100.3, 40.6, 8.7, -0.00023]
>>>round_to_05(a, mode='s')
array([ -1.00000000e+02,   4.00000000e+01,   8.50000000e+00,
        -2.00000000e-04])

>>> round_to_05(a, mode='l')
array([ -1.50000000e+02,   4.50000000e+01,   9.00000000e+00,
        -2.50000000e-04])