geoips.pydantic_models package

Subpackages

• geoips.pydantic_models.v1 package
  • Submodules
  • geoips.pydantic_models.v1.algorithms module
    • AlgorithmArgumentsModel
      • AlgorithmArgumentsModel.gamma_list
      • AlgorithmArgumentsModel.grid_geo
      • AlgorithmArgumentsModel.input_units
      • AlgorithmArgumentsModel.inverse
      • AlgorithmArgumentsModel.mask_day
      • AlgorithmArgumentsModel.mask_night
      • AlgorithmArgumentsModel.max_day_zen
      • AlgorithmArgumentsModel.max_night_zen
      • AlgorithmArgumentsModel.max_outbounds
      • AlgorithmArgumentsModel.min_night_zen
      • AlgorithmArgumentsModel.min_outbounds
      • AlgorithmArgumentsModel.norm
      • AlgorithmArgumentsModel.output_data_range
      • AlgorithmArgumentsModel.output_units
      • AlgorithmArgumentsModel.pressure_key
      • AlgorithmArgumentsModel.pressure_level_range
      • AlgorithmArgumentsModel.satellite_zenith_angle_cutoff
      • AlgorithmArgumentsModel.scale_factor
      • AlgorithmArgumentsModel.sun_zen_correction
      • AlgorithmArgumentsModel.time_dim
      • AlgorithmArgumentsModel.time_fcst
      • AlgorithmArgumentsModel.time_key
      • AlgorithmArgumentsModel.var_map
      • AlgorithmArgumentsModel.variables
  • geoips.pydantic_models.v1.bases module
    • CoreBaseModel
      • CoreBaseModel.model_name
      • CoreBaseModel.restricted_fields
    • DynamicModel
    • FrozenModel
    • PermissiveDynamicModel
    • PermissiveFrozenModel
    • PluginModel
      • PluginModel.abspath
      • PluginModel.description
      • PluginModel.docstring
      • PluginModel.family
      • PluginModel.interface
      • PluginModel.is_registered
      • PluginModel.name
      • PluginModel.package
      • PluginModel.relpath
      • PluginModel.apiVersion
    • PluginModelMetadata
    • get_interfaces()
    • python_identifier()
    • step_reference()
  • geoips.pydantic_models.v1.colormappers module
    • ColormapperArgumentsModel
      • ColormapperArgumentsModel.cbar_full_width
      • ColormapperArgumentsModel.cbar_label
      • ColormapperArgumentsModel.cbar_spacing
      • ColormapperArgumentsModel.cbar_tick_labels
      • ColormapperArgumentsModel.cbar_ticks
      • ColormapperArgumentsModel.cmap_name
      • ColormapperArgumentsModel.cmap_path
      • ColormapperArgumentsModel.cmap_source
      • ColormapperArgumentsModel.colorbar_kwargs
      • ColormapperArgumentsModel.create_colorbar
      • ColormapperArgumentsModel.data_range
      • ColormapperArgumentsModel.pressure_range_legend
      • ColormapperArgumentsModel.set_label_kwarg
      • ColormapperArgumentsModel.set_ticks_kwargs
  • geoips.pydantic_models.v1.coverage_checkers module
    • CoverageCheckerArgumentsModel
      • CoverageCheckerArgumentsModel.area_def
      • CoverageCheckerArgumentsModel.radius_km
      • CoverageCheckerArgumentsModel.variable_name
  • geoips.pydantic_models.v1.feature_annotators module
    • CartopyFeature
      • CartopyFeature.edgecolor
      • CartopyFeature.enabled
      • CartopyFeature.linewidth
    • FeatureAnnotatorPluginModel
      • FeatureAnnotatorPluginModel.spec
    • FeatureAnnotatorSpec
      • FeatureAnnotatorSpec.background
      • FeatureAnnotatorSpec.borders
      • FeatureAnnotatorSpec.coastline
      • FeatureAnnotatorSpec.rivers
      • FeatureAnnotatorSpec.states
  • geoips.pydantic_models.v1.filename_formatters module
    • FilenameFormatterArgumentsModel
      • FilenameFormatterArgumentsModel.area_def
      • FilenameFormatterArgumentsModel.basedir
      • FilenameFormatterArgumentsModel.coverage
      • FilenameFormatterArgumentsModel.extension
      • FilenameFormatterArgumentsModel.extra
      • FilenameFormatterArgumentsModel.metadata_dir
      • FilenameFormatterArgumentsModel.metadata_type
      • FilenameFormatterArgumentsModel.output_dict
      • FilenameFormatterArgumentsModel.output_type
      • FilenameFormatterArgumentsModel.output_type_dir
      • FilenameFormatterArgumentsModel.product_dir
      • FilenameFormatterArgumentsModel.product_filename
      • FilenameFormatterArgumentsModel.product_subdir
      • FilenameFormatterArgumentsModel.source_dir
  • geoips.pydantic_models.v1.gridline_annotators module
    • GridlineAnnotatorPluginModel
      • GridlineAnnotatorPluginModel.spec
    • GridlineAnnotatorSpec
      • GridlineAnnotatorSpec.background
      • GridlineAnnotatorSpec.labels
      • GridlineAnnotatorSpec.lines
      • GridlineAnnotatorSpec.spacing
    • Labels
      • Labels.alpha
      • Labels.backgroundcolor
      • Labels.bottom
      • Labels.color
      • Labels.fontfamily
      • Labels.fontsize
      • Labels.fontstretch
      • Labels.fontstyle
      • Labels.fontvariant
      • Labels.fontweight
      • Labels.left
      • Labels.linespacing
      • Labels.mouseover
      • Labels.position
      • Labels.right
      • Labels.rotation
      • Labels.rotation_mode
      • Labels.snap
      • Labels.top
      • Labels.wrap
      • Labels.xpadding
      • Labels.ypadding
      • Labels.zorder
    • Lines
      • Lines.color
      • Lines.linestyle
      • Lines.linewidth
    • Spacing
      • Spacing.latitude
      • Spacing.longitude
  • geoips.pydantic_models.v1.interpolators module
    • InterpGaussInterpolator
      • InterpGaussInterpolator.drop_nan
      • InterpGaussInterpolator.sigmaval
    • InterpGridInterpolator
      • InterpGridInterpolator.method
    • InterpolatorArgumentsModel
      • InterpolatorArgumentsModel.area_def
      • InterpolatorArgumentsModel.drop_nan
      • InterpolatorArgumentsModel.method
      • InterpolatorArgumentsModel.sigmaval
      • InterpolatorArgumentsModel.varlist
  • geoips.pydantic_models.v1.output_checkers module
    • OutputCheckerArgumentsModel
      • OutputCheckerArgumentsModel.compare_path
      • OutputCheckerArgumentsModel.output_products
      • OutputCheckerArgumentsModel.threshold
  • geoips.pydantic_models.v1.output_formatters module
    • OutputFormatterArgumentsModel
      • OutputFormatterArgumentsModel.append
      • OutputFormatterArgumentsModel.area_def
      • OutputFormatterArgumentsModel.basedir
      • OutputFormatterArgumentsModel.bg_data
      • OutputFormatterArgumentsModel.bg_datatype_title
      • OutputFormatterArgumentsModel.bg_mpl_colors_info
      • OutputFormatterArgumentsModel.bg_product_name_title
      • OutputFormatterArgumentsModel.bg_xarray
      • OutputFormatterArgumentsModel.clean_fname
      • OutputFormatterArgumentsModel.clobber
      • OutputFormatterArgumentsModel.cog
      • OutputFormatterArgumentsModel.existing_image
      • OutputFormatterArgumentsModel.hist_colorbar
      • OutputFormatterArgumentsModel.is_3d
      • OutputFormatterArgumentsModel.metadata_dir
      • OutputFormatterArgumentsModel.metadata_fname_dict
      • OutputFormatterArgumentsModel.mpl_colors_info
      • OutputFormatterArgumentsModel.output_dict
      • OutputFormatterArgumentsModel.output_fname_dict
      • OutputFormatterArgumentsModel.overwrite
      • OutputFormatterArgumentsModel.pressure_range_dict
      • OutputFormatterArgumentsModel.product_datatype_title
      • OutputFormatterArgumentsModel.product_name_title
      • OutputFormatterArgumentsModel.remove_duplicate_minrange
      • OutputFormatterArgumentsModel.savefig_kwargs
      • OutputFormatterArgumentsModel.title_copyright
      • OutputFormatterArgumentsModel.title_formatter
      • OutputFormatterArgumentsModel.use_compression
      • OutputFormatterArgumentsModel.var_name
      • OutputFormatterArgumentsModel.working_directory
      • OutputFormatterArgumentsModel.x_size
      • OutputFormatterArgumentsModel.y_size
  • geoips.pydantic_models.v1.products module
    • ModulePluginArgumentsModel
      • ModulePluginArgumentsModel.arguments
      • ModulePluginArgumentsModel.name
    • ProductDefaultPluginModel
      • ProductDefaultPluginModel.spec
    • ProductDefaultSpec
      • ProductDefaultSpec.algorithm
      • ProductDefaultSpec.colormapper
      • ProductDefaultSpec.coverage_checker
      • ProductDefaultSpec.display_name
      • ProductDefaultSpec.interpolator
      • ProductDefaultSpec.mtif_type
      • ProductDefaultSpec.pad_area_definition
      • ProductDefaultSpec.windbarb_plotter
    • ProductPluginModel
    • ProductSpec
      • ProductSpec.variables
    • ProductsListPluginModel
      • ProductsListPluginModel.spec
    • ProductsListSpec
      • ProductsListSpec.products
    • SingleProductPluginModel
      • SingleProductPluginModel.interface
      • SingleProductPluginModel.product_defaults
      • SingleProductPluginModel.source_names
      • SingleProductPluginModel.spec
    • SpecPlugin
      • SpecPlugin.plugin
  • geoips.pydantic_models.v1.readers module
    • ReaderArgumentsModel
      • ReaderArgumentsModel.area_def
      • ReaderArgumentsModel.chans
      • ReaderArgumentsModel.filenames
      • ReaderArgumentsModel.metadata_only
      • ReaderArgumentsModel.resampled_read
      • ReaderArgumentsModel.sectored_read
      • ReaderArgumentsModel.self_register
      • ReaderArgumentsModel.self_register_dataset
      • ReaderArgumentsModel.self_register_source
  • geoips.pydantic_models.v1.sectors module
    • AreaDefinitionSpec
      • AreaDefinitionSpec.area_extent
      • AreaDefinitionSpec.area_id
      • AreaDefinitionSpec.center
      • AreaDefinitionSpec.description
      • AreaDefinitionSpec.projection
      • AreaDefinitionSpec.resolution
      • AreaDefinitionSpec.shape
      • AreaDefinitionSpec.units
    • BoxMetadata
      • BoxMetadata.box_resolution_km
      • BoxMetadata.max_lat
      • BoxMetadata.max_lon
      • BoxMetadata.min_lat
      • BoxMetadata.min_lon
    • DynamicSectorPluginModel
      • DynamicSectorPluginModel.spec
    • DynamicSectorSpec
      • DynamicSectorSpec.area_id
      • DynamicSectorSpec.description
      • DynamicSectorSpec.sector_spec_generator
    • EarthConstants
      • EarthConstants.SEMI_MAJOR_AXIS
    • RegionMetadata
      • RegionMetadata.area
      • RegionMetadata.city
      • RegionMetadata.continent
      • RegionMetadata.country
      • RegionMetadata.state
      • RegionMetadata.subarea
    • SectorAreaExtent
      • SectorAreaExtent.lower_left_xy
      • SectorAreaExtent.upper_right_xy
    • SectorPluginModel
    • SectorProjection
      • SectorProjection.R
      • SectorProjection.a
      • SectorProjection.ellipsoid
      • SectorProjection.h
      • SectorProjection.k_0
      • SectorProjection.lat_0
      • SectorProjection.lat_1
      • SectorProjection.lat_2
      • SectorProjection.lat_ts
      • SectorProjection.lon_0
      • SectorProjection.proj
      • SectorProjection.t_epoch
      • SectorProjection.t_final
      • SectorProjection.units
      • SectorProjection.x_0
      • SectorProjection.y_0
    • SectorResolution
      • SectorResolution.dx
      • SectorResolution.dy
    • SectorShape
      • SectorShape.height
      • SectorShape.width
    • SectorSpecGenerator
      • SectorSpecGenerator.arguments
      • SectorSpecGenerator.name
    • StaticMetadata
      • StaticMetadata.region
    • StaticSectorPluginModel
      • StaticSectorPluginModel.metadata
      • StaticSectorPluginModel.spec
    • StitchedMetadata
      • StitchedMetadata.primary_area_definition
    • TCMetadata
      • TCMetadata.aid_type
      • TCMetadata.center_lat
      • TCMetadata.center_lon
      • TCMetadata.deck_line
      • TCMetadata.final_storm_name
      • TCMetadata.pressure
      • TCMetadata.source_file
      • TCMetadata.storm_basin
      • TCMetadata.storm_name
      • TCMetadata.storm_num
      • TCMetadata.storm_year
      • TCMetadata.synoptic_time
      • TCMetadata.velocity_max
    • VolcanoMetadata
      • VolcanoMetadata.clat
      • VolcanoMetadata.clon
      • VolcanoMetadata.plume_height
      • VolcanoMetadata.summit_elevation
      • VolcanoMetadata.wind_dir
      • VolcanoMetadata.wind_speed
    • XYCoordinate
      • XYCoordinate.x
      • XYCoordinate.y
    • validate_lat_lon_coordinate()
  • geoips.pydantic_models.v1.title_formatters module
    • TitleFormatterArgumentsModel
      • TitleFormatterArgumentsModel.area_def
      • TitleFormatterArgumentsModel.bg_datatype_title
      • TitleFormatterArgumentsModel.bg_product_name_title
      • TitleFormatterArgumentsModel.product_datatype_title
      • TitleFormatterArgumentsModel.product_name_title
      • TitleFormatterArgumentsModel.title_copyright
  • geoips.pydantic_models.v1.workflows module
    • AlgorithmStepValidationModel
    • ColormapperArgumentsModel
    • DEFAULT_RETENTION
    • FeatureAnnotatorArgumentsModel
    • GlobalVariablesModel
      • GlobalVariablesModel.minimum_coverage
      • GlobalVariablesModel.presector
      • GlobalVariablesModel.product_db
      • GlobalVariablesModel.product_db_writer
      • GlobalVariablesModel.product_db_writer_kwargs
      • GlobalVariablesModel.product_name
      • GlobalVariablesModel.reader_defined_area_def
      • GlobalVariablesModel.sector_list
      • GlobalVariablesModel.window_end_time
      • GlobalVariablesModel.window_start_time
    • GridlineAnnotatorArgumentsModel
    • INPUT_REF
    • NestedSpecOverride
      • NestedSpecOverride.steps
    • OutputCheckerOverrideModel
      • OutputCheckerOverrideModel.compare_path
      • OutputCheckerOverrideModel.full_test_policy
      • OutputCheckerOverrideModel.name
      • OutputCheckerOverrideModel.threshold
    • OutputFormatterArgumentsModel
    • ProductArgumentsModel
    • ProductDefaultArgumentsModel
    • SCAFFOLD_KINDS
    • SectorArgumentsModel
    • StepOverrideType
      • StepOverrideType.spec
    • WorkflowArgumentsModel
    • WorkflowPluginModel
      • WorkflowPluginModel.abspath
      • WorkflowPluginModel.description
      • WorkflowPluginModel.docstring
      • WorkflowPluginModel.family
      • WorkflowPluginModel.interface
      • WorkflowPluginModel.is_registered
      • WorkflowPluginModel.name
      • WorkflowPluginModel.package
      • WorkflowPluginModel.relpath
      • WorkflowPluginModel.spec
      • WorkflowPluginModel.test
    • WorkflowSpecModel
      • WorkflowSpecModel.defaults
      • WorkflowSpecModel.globals
      • WorkflowSpecModel.retention
      • WorkflowSpecModel.retention_by_kind
      • WorkflowSpecModel.steps
      • WorkflowSpecModel.expand_step()
      • WorkflowSpecModel.extend_dict()
      • WorkflowSpecModel.product_to_steps()
    • WorkflowStepDefinitionModel
      • WorkflowStepDefinitionModel.arguments
      • WorkflowStepDefinitionModel.depends_on
      • WorkflowStepDefinitionModel.full_test_policy
      • WorkflowStepDefinitionModel.keep
      • WorkflowStepDefinitionModel.kind
      • WorkflowStepDefinitionModel.name
      • WorkflowStepDefinitionModel.scope
      • WorkflowStepDefinitionModel.spec
      • WorkflowStepDefinitionModel.when
    • WorkflowTestModel
      • WorkflowTestModel.filenames
      • WorkflowTestModel.globals
      • WorkflowTestModel.kinds
      • WorkflowTestModel.outputs
      • WorkflowTestModel.steps
    • get_plugin_kinds()
    • get_plugin_names()
  • Module contents
    • collect_classes()
    • collect_modules()

Module contents

GeoIPS order-based procflow models init file.