psyplot package

psyplot visualization framework.

Functions:

get_versions([requirements, key])

Get the version information for psyplot, the plugins and its requirements

Data:

with_gui

Boolean that is True, if psyplot runs inside the graphical user interface by the psyplot_gui module
psyplot.get_versions(requirements=True, key=None)[source]

Get the version information for psyplot, the plugins and its requirements

Parameters:

  • requirements (bool) – If True, the requirements of the plugins and psyplot are investigated

  • key (func) – A function that determines whether a plugin shall be considererd or not. The function must take a single argument, that is the name of the plugin as string, and must return True (import the plugin) or False (skip the plugin). If None, all plugins are imported

Returns:

A mapping from 'psyplot'/the plugin names to a dictionary with the 'version' key and the corresponding version is returned. If requirements is True, it also contains a mapping from 'requirements' a dictionary with the versions

Return type:

dict

Examples

Using the built-in JSON module, we get something like

import json

print(json.dumps(psyplot.get_versions(), indent=4))
{
    "psy_simple.plugin": {"version": "1.0.0.dev0"},
    "psyplot": {
        "version": "1.0.0.dev0",
        "requirements": {
            "matplotlib": "1.5.3",
            "numpy": "1.11.3",
            "pandas": "0.19.2",
            "xarray": "0.9.1",
        },
    },
    "psy_maps.plugin": {
        "version": "1.0.0.dev0",
        "requirements": {"cartopy": "0.15.0"},
    },
}
psyplot.with_gui = False

Boolean that is True, if psyplot runs inside the graphical user interface by the psyplot_gui module

Subpackages

Submodules