rompy.core.source.SourceBase#

pydantic model rompy.core.source.SourceBase[source]#

Abstract base class for a source dataset.

Show JSON schema
{
   "title": "SourceBase",
   "description": "Abstract base class for a source dataset.",
   "type": "object",
   "properties": {
      "model_type": {
         "const": "base_source",
         "description": "Model type discriminator, must be overriden by a subclass",
         "title": "Model Type",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "model_type"
   ]
}

Fields:
field model_type: Literal['base_source'] [Required]#

Model type discriminator, must be overriden by a subclass

open(variables: list = [], filters: Filter = {}, **kwargs) → Dataset[source]#

Return the filtered dataset object.

Parameters:

  • variables (list, optional) – List of variables to select from the dataset.

  • filters (Filter, optional) – Filters to apply to the dataset.

Notes

The kwargs are only a placeholder in case a subclass needs to pass additional arguments to the open method.

property coordinates: Dataset#

Return the coordinates of the datasource.