rompy.core.data.SourceIntake

pydantic model rompy.core.data.SourceIntake

Source dataset from intake catalog.

Note

The intake catalog can be prescribed either by the URI of an existing catalog file or by a YAML string defining the catalog. The YAML string can be obtained from calling the yaml() method on an intake dataset instance.

Fields:

• catalog_uri (str | pathlib.Path | None)

• catalog_yaml (str | None)

• dataset_id (str)

• kwargs (dict)

• model_type (Literal['intake'])

Validators:

• check_catalog » all fields

field catalog_uri: str | Path | None = None

The URI of the catalog to read from

Validated by:

• check_catalog

field catalog_yaml: str | None = None

The YAML string of the catalog to read from

Validated by:

• check_catalog

field dataset_id: str [Required]

The id of the dataset to read in the catalog

Validated by:

• check_catalog

field kwargs: dict = {}

Keyword arguments to define intake dataset parameters

Validated by:

• check_catalog

field model_type: Literal['intake'] = 'intake'

Model type discriminator

Validated by:

• check_catalog

validator check_catalog  »  all fields

property catalog: Catalog

The intake catalog instance.