example: For yadg testing

This is an example extractor, used mainly for testing of the yadg package. It provides no real functionality.

Usage

Available since yadg-4.0.

pydantic model dgbowl_schemas.yadg.dataschema_6_0.filetype.Example

Config:

extra: str = forbid

Validators:

pydantic model Parameters

Config:

extra: str = allow

field parameters: Parameters [Optional]

field filetype: Literal['example'] [Required]

Schema

The output schema is only defined for the tomato.json filetype.

xarray.DataTree:
  coords:
    uts:              !!float      # The current timestamp
  data_vars:
    {{ param_keys }}  (None)       # All parameter key/value pairs

Metadata

No metadata is returned.

Code author: Peter Kraus

yadg.extractors.example.extract(*, fn: str, parameters: BaseModel, **kwargs: dict) → DataTree