psy_strat.plugin module¶

psy-strat psyplot plugin

This module defines the rcParams for the psy-strat plugin. This module will be imported when psyplot is imported. What is should contain is:

an rcParams variable as instance of psyplot.config.rcsetup.RcParams that describes the configuration of your plugin
a get_versions function that returns the version of your plugin and the ones from its requirements

Warning

Because of recursion issues, You have to load the psyplot module before loading this module! In other words, you have to type

import psyplot
import psy_strat.plugin

Functions

`get_versions`([requirements])	Get the versions of psy-strat and it’s requirements
`validate_axislinestyle`(value)	Validate a dictionary containing axiscolor definitions
`validate_grouper`(value)	Validate the grouper formatoption
`validate_hlines`(value)	Validate the hlines formatoption

psy_strat.plugin.get_versions(requirements=True)[source]¶

Get the versions of psy-strat and it’s requirements

Parameters: requirements (bool) – If True, the requirements are imported and it’s versions are included

psy_strat.plugin.validate_axislinestyle(value)[source]¶

Validate a dictionary containing axiscolor definitions

Parameters: value (dict) – a mapping from ‘left’, ‘right’, ‘bottom’, ‘top’ to the linestyle
Returns
Return type: dict
Raises: ValueError –

psy_strat.plugin.validate_grouper(value)[source]¶

Validate the grouper formatoption

Parameters: value (tuple (float y1, str s)) – A tuple of length 2, where the first parameter 0<=y1<=1 determines the distance of the bar to the top y-axis and the second is the title of the group

psy_strat.plugin.validate_hlines(value)[source]¶

Validate the hlines formatoption