psy-maps psyplot plugin

This module defines the rcParams for the psy-maps plugin

Classes:

ProjectionValidator(key, valid[, ...])

Functions:

get_versions([requirements])
patch_prior_1_0(plotter_d, versions)	Patch psy_maps plotters for versions smaller than 1.0
validate_dict_yaml(s)
validate_google_map_detail(value)
validate_grid(val)
validate_lonlatbox(value)
validate_lsm(val)

Data:

patches

patches to apply when loading a project

class psy_maps.plugin.ProjectionValidator(key, valid, ignorecase=False, *, _deprecated_since=None)

Bases: ValidateInStrings

psy_maps.plugin.get_versions(requirements=True)

psy_maps.plugin.patch_prior_1_0(plotter_d, versions)

Patch psy_maps plotters for versions smaller than 1.0

Before psyplot 1.0.0, the plotters in the psy_maps package where part of the psyplot.plotter.maps module. This has to be corrected

psy_maps.plugin.patches = {('psyplot.plotter.maps', 'CombinedPlotter'): <function patch_prior_1_0>, ('psyplot.plotter.maps', 'FieldPlotter'): <function patch_prior_1_0>, ('psyplot.plotter.maps', 'MapPlotter'): <function patch_prior_1_0>, ('psyplot.plotter.maps', 'VectorPlotter'): <function patch_prior_1_0>}

patches to apply when loading a project

psy_maps.plugin.rcParams = {'lonlatbox.boxes': {}, 'plotter.maps.clat': None, 'plotter.maps.clip': None, 'plotter.maps.clon': None, 'plotter.maps.google_map_detail': None, 'plotter.maps.grid_color': 'k', 'plotter.maps.grid_labels': None, 'plotter.maps.grid_labelsize': 12.0, 'plotter.maps.grid_settings': {}, 'plotter.maps.lonlatbox': None, 'plotter.maps.lsm': {'coast': 'k', 'linewidth': 1.0, 'res': '110m'}, 'plotter.maps.map_extent': None, 'plotter.maps.projection': 'cf', 'plotter.maps.stock_img': False, 'plotter.maps.transform': 'cf', 'plotter.maps.transpose': False, 'plotter.maps.xgrid': True, 'plotter.maps.ygrid': True, 'project.plotters': {'mapcombined': {'default_dims': {'x': slice(None, None, None), 'y': slice(None, None, None)}, 'default_slice': 0, 'example_call': "filename, name=[['my_variable', ['u_var', 'v_var']]], ...", 'module': 'psy_maps.plotters', 'plotter_name': 'CombinedPlotter', 'plugin': 'psy_maps.plugin', 'prefer_list': True, 'summary': 'Plot a 2D scalar field with an overlying vector field on a map'}, 'mapplot': {'default_dims': {'x': slice(None, None, None), 'y': slice(None, None, None)}, 'default_slice': 0, 'module': 'psy_maps.plotters', 'plotter_name': 'FieldPlotter', 'plugin': 'psy_maps.plugin', 'prefer_list': False, 'summary': 'Plot a 2D scalar field on a map'}, 'maps': {'module': 'psy_maps.plotters', 'plot_func': False, 'plotter_name': 'MapPlotter', 'plugin': 'psy_maps.plugin', 'summary': 'The data objects visualized on a map'}, 'mapvector': {'default_dims': {'x': slice(None, None, None), 'y': slice(None, None, None)}, 'default_slice': 0, 'example_call': "filename, name=[['u_var', 'v_var']], ...", 'module': 'psy_maps.plotters', 'plotter_name': 'VectorPlotter', 'plugin': 'psy_maps.plugin', 'prefer_list': False, 'summary': 'Plot a 2D vector field on a map'}}}

the RcParams for the psy-simple plugin

psy_maps.plugin.validate_dict_yaml(s)

psy_maps.plugin.validate_google_map_detail(value)

psy_maps.plugin.validate_grid(val)

psy_maps.plugin.validate_lonlatbox(value)

psy_maps.plugin.validate_lsm(val)