geoips.interfaces.module_based package

Submodules

geoips.interfaces.module_based.algorithms module

Algorithms interface module.

class geoips.interfaces.module_based.algorithms.AlgorithmsInterface

Bases: BaseModuleInterface

GeoIPS interface for algorithms plugins.

name = 'algorithms'

required_args = {'channel_combination': ['arrays'], 'list_numpy_to_numpy': ['arrays'], 'rgb': ['arrays'], 'scalar_to_scalar': [], 'single_channel': ['arrays'], 'xarray_dict_area_def_to_numpy': ['xarray_dict', 'area_def'], 'xarray_dict_dict_to_xarray': ['xarray_dict_dict'], 'xarray_dict_to_xarray': ['xarray_dict'], 'xarray_dict_to_xarray_dict': ['xarray_dict'], 'xarray_to_numpy': ['xobj']}

required_kwargs = {'channel_combination': [], 'list_numpy_to_numpy': [], 'rgb': [], 'scalar_to_scalar': ['value'], 'single_channel': [], 'xarray_dict_area_def_to_numpy': [], 'xarray_dict_dict_to_xarray': [], 'xarray_dict_to_xarray': [], 'xarray_dict_to_xarray_dict': [], 'xarray_to_numpy': []}

geoips.interfaces.module_based.colormappers module

Colormappers interface module.

class geoips.interfaces.module_based.colormappers.ColormappersInterface

Bases: BaseModuleInterface

GeoIPS interface for colormappers plugins.

allowable_kwargs = {'matplotlib': ['data_range', 'cmap_name', 'ascii_path', 'create_colorbar', 'cbar_label', 'cbar_ticks', 'cbar_tick_labels', 'cbar_spacing', 'cbar_full_width', 'colorbar_kwargs', 'set_ticks_kwargs', 'set_label_kwargs']}

name = 'colormappers'

required_args = {'matplotlib': []}

required_kwargs = {'matplotlib': []}

geoips.interfaces.module_based.coverage_checkers module

Interpolators interface module.

class geoips.interfaces.module_based.coverage_checkers.CoverageCheckersInterface

Bases: BaseModuleInterface

GeoIPS interface for coverage_checkers plugins.

allowable_kwargs = {'standard': {'area_def', 'radius_km'}}

get_plugin_for_product(product, checker_field='coverage_checker')

Get plugin for product.

name = 'coverage_checkers'

required_args = {'standard': ['xarray_obj', 'variable_name']}

required_kwargs = {'standard': {}}

geoips.interfaces.module_based.filename_formatters module

Filename formatters interface module.

class geoips.interfaces.module_based.filename_formatters.FilenameFormattersInterface

Bases: BaseModuleInterface

GeoIPS interface for filename_formatters plugins.

find_duplicates(*args, **kwargs)

Find duplicate files.

name = 'filename_formatters'

remove_duplicates()

Remove duplicate files.

required_args = {'data': ['area_def', 'xarray_obj', 'product_names'], 'standard': ['area_def', 'xarray_obj', 'product_name'], 'standard_metadata': ['area_def', 'xarray_obj', 'product_filename'], 'xarray_metadata_to_filename': ['xarray_obj']}

required_kwargs = {'data': ['coverage', 'output_type', 'output_type_dir', 'product_dir', 'product_subdir', 'source_dir', 'basedir'], 'standard': ['coverage', 'output_type', 'output_type_dir', 'product_dir', 'product_subdir', 'source_dir', 'basedir'], 'standard_metadata': ['metadata_dir', 'metadata_type', 'basedir'], 'xarray_metadata_to_filename': ['extension', 'basedir']}

geoips.interfaces.module_based.interpolators module

Interpolators interface module.

class geoips.interfaces.module_based.interpolators.InterpolatorsInterface

Bases: BaseModuleInterface

GeoIPS interface for interpolators plugins.

name = 'interpolators'

required_args = {'2d': ['area_def', 'input_xarray', 'output_xarray', 'varlist'], 'grid': ['area_def', 'input_xarray', 'output_xarray', 'varlist']}

required_kwargs = {'2d': ['array_num'], 'grid': ['array_num']}

geoips.interfaces.module_based.output_formatters module

Output formatters interface module.

class geoips.interfaces.module_based.output_formatters.OutputFormattersInterface

Bases: BaseModuleInterface

GeoIPS interface for output_formatters plugins.

name = 'output_formatters'

required_args = {'image': ['area_def', 'xarray_obj', 'product_name', 'output_fnames'], 'image_multi': ['area_def', 'xarray_obj', 'product_names', 'output_fnames', 'mpl_colors_info'], 'image_overlay': ['area_def', 'xarray_obj', 'product_name', 'output_fnames'], 'standard_metadata': ['area_def', 'xarray_obj', 'metadata_yaml_filename', 'product_filename'], 'unprojected': ['xarray_obj', 'product_name', 'output_fnames'], 'xarray_data': ['xarray_obj', 'product_names', 'output_fnames'], 'xrdict_area_product_outfnames_to_outlist': ['xarray_dict', 'area_def', 'product_name', 'output_fnames'], 'xrdict_area_product_to_outlist': ['xarray_dict', 'area_def', 'product_name'], 'xrdict_area_varlist_to_outlist': ['xarray_dict', 'area_def', 'varlist'], 'xrdict_varlist_outfnames_to_outlist': ['xarray_dict', 'varlist', 'output_fnames']}

required_kwargs = {'image': ['product_name_title', 'mpl_colors_info', 'existing_image'], 'image_multi': ['product_name_titles'], 'image_overlay': ['product_name_title', 'clean_fname', 'mpl_colors_info', 'clean_fname', 'feature_annotator', 'gridline_annotator', 'clean_fname', 'product_datatype_title', 'clean_fname', 'bg_data', 'bg_mpl_colors_info', 'clean_fname', 'bg_xarray', 'bg_product_name_title', 'bg_datatype_title', 'clean_fname', 'remove_duplicate_minrange'], 'standard_metadata': ['metadata_dir', 'basedir', 'output_dict'], 'unprojected': ['product_name_title', 'mpl_colors_info'], 'xarray_data': [], 'xarray_dict_data': ['append', 'overwrite'], 'xarray_dict_to_image': [], 'xrdict_area_product_outfnames_to_outlist': [], 'xrdict_area_product_to_outlist': [], 'xrdict_area_varlist_to_outlist': [], 'xrdict_varlist_outfnames_to_outlist': []}

geoips.interfaces.module_based.procflows module

Procflows interface module.

class geoips.interfaces.module_based.procflows.ProcflowsInterface

Bases: BaseModuleInterface

GeoIPS interface for procflows plugins.

name = 'procflows'

required_args = {'standard': ['fnames']}

required_kwargs = {'standard': ['command_line_args']}

geoips.interfaces.module_based.readers module

Readers interface module.

class geoips.interfaces.module_based.readers.ReadersInterface

Bases: BaseModuleInterface

GeoIPS interface for readers plugins.

name = 'readers'

required_args = {'standard': ['fnames']}

required_kwargs = {'standard': ['metadata_only', 'chans', 'area_def', 'self_register']}

geoips.interfaces.module_based.sector_adjusters module

Sector adjusters interface module.

class geoips.interfaces.module_based.sector_adjusters.SectorAdjustersInterface

Bases: BaseModuleInterface

GeoIPS interface for sector_adjusters plugins.

name = 'sector_adjusters'

required_args = {'list_xarray_list_variables_to_area_def_out_fnames': ['xobjs', 'area_def', 'variables']}

required_kwargs = {'list_xarray_list_variables_to_area_def_out_fnames': ['recenter_variables']}

geoips.interfaces.module_based.sector_metadata_generators module

Sector metadata generators interface module.

class geoips.interfaces.module_based.sector_metadata_generators.SectorMetadataGeneratorsInterface

Bases: BaseModuleInterface

GeoIPS interface for sector_metadata_generators plugins.

name = 'sector_metadata_generators'

required_args = {'tc': ['trackfile_name']}

required_kwargs = {'tc': []}

geoips.interfaces.module_based.sector_spec_generators module

Sector spec generators interface module.

class geoips.interfaces.module_based.sector_spec_generators.SectorSpecGeneratorsInterface

Bases: BaseModuleInterface

GeoIPS interface for sector_spec_generators plugins.

name = 'sector_spec_generators'

required_args = {'area_definition': []}

required_kwargs = {'area_definition': []}

geoips.interfaces.module_based.title_formatters module

Title formatters interface module.

class geoips.interfaces.module_based.title_formatters.TitleFormattersInterface

Bases: BaseModuleInterface

GeoIPS interface for title_formatters plugins.

name = 'title_formatters'

required_args = {'standard': []}

required_kwargs = {'standard': []}

Module contents

Module based interfaces init file.