domains class#

class pycif.utils.classes.domains.Domain(**kwargs)[source]#

Bases: Plugin

calc_areas(*args, **kwargs)[source]#

Computes the area of each grid cell in your domain.

create_domain(*args, **kwargs)[source]#

Creates a grid if needed

Args:

domain (dictionary): dictionary defining the domain.

get_sides()[source]#

Gets the sides of the domain

get_vmiddle()[source]#
initiate_template()[source]#

Initializes a Plugin template, with methods from the corresponding module.

Args:

self: the plugin to initialize plg_type: the type of the plugin to initialize default_functions (dict[str, bool]):

functions to load from the module and to attach to the plugin. Each key names the function and each value is a boolean to determine whether the corresponding function is a class method (with a reflective self as argument) or a classical static function

read_grid(*args, **kwargs)[source]#

Read a grid from an existing file

Args:

self (Domain): plugin defining the domain. Should include filegrid to be able to read the grid from a file

Return:

Grid domain with meshgrids for center lon/lat and corner lon/lat

classmethod register_plugin(name, version, module, subtype='', **kwargs)[source]#

Register a module for a plugin and version with possibly options

Args:

name (str): name of the plugin version (str): version of the plugin module (types.ModuleType): module defining the interface

between pyCIF and the plugin

plugin_type (str): type of plugin **kwargs (dictionary): default options for module

property vdomain_type#
vshifted = False#