Readers in GeoIPS#

A reader is a class-based GeoIPS plugin that reads data from a specific source, such as, for example, Level 1b data from the GOES ABI sensor. GeoIPS has a wide array of built-in readers available for use, which are primarily focused on satellite-based meteorological data, but can support nearly any type of environmental data.

Note that when developing readers, some variables and attributes are required to be set to ensure compatibility with other components of GeoIPS. See the reader plugin development tutorial for the list of required variables and attributes, as well as information on developing and using a new reader.

Readers can be called in two ways:

1. Specification at the Command Line: Readers are specified as arguments at the command line. For example, the ABI Level 1b NetCDF reader is called as follows:

--reader_name abi_netcdf

The ABI Infrared test script serves as an example of command line call utilizing the abi_netcdf reader.

Direct Invocation: Readers can be called within another program:

from geoips.interfaces import readers
reader_name = "abi_netcdf"
data = readers.get_plugin(reader_name)

Plugin arguments#

The arguments accepted by a reader step (validated in Order-Based Processing workflows) are defined by the model below. These fields are generated directly from the code, so they always reflect the current validation rules.

pydantic model geoips.pydantic_models.v1.readers.ReaderArgumentsModel[source]

Reader step argument definition.

Pydantic model defining and validating Reader step arguments.

Fields:

Validators:

_handle_deprecated_chans » all fields
_validate_and_normalize_areadefinition » area_def
_validate_and_normalize_fnames » filenames

field area_def: AreaDefinition | None = None: The domain over which to read data.

field chans: List[str] = None (alias 'variables'): List of variables to read

field filenames: List[Path] = None: full path to the file(s) for static dataset inputs.

field metadata_only: bool = False: Read metadata only.

field resampled_read: bool = False: Specify whether a resampled read is required, needed for datatypes that will be read within ‘get_alg_xarray’

field sectored_read: bool = False

field self_register: str = None: Enable self-registration.

field self_register_dataset: str = None: Dataset within the source to use for self-registration

field self_register_source: str = None: Source dataset to use for self-registration