monkey_wrench.task.chimp module

Module to define Pydantic models for tasks related to CHIMP retrievals.

class monkey_wrench.task.chimp.ChimpTaskBase(*, verbose: bool = False, context: Literal[Context.chimp], action: Action, specifications: type[Model])

Bases: TaskBase

Pydantic base model for all CHIMP related tasks.

context: Literal[Context.chimp]

class monkey_wrench.task.chimp.ChimpRetrieveSpecifications(*, end_datetime: ~typing.Annotated[~pydantic.types.AwareDatetime, ~pydantic.functional_validators.AfterValidator(func=~monkey_wrench.date_time.models._base.<lambda>)] | None = None, start_datetime: ~typing.Annotated[~pydantic.types.AwareDatetime, ~pydantic.functional_validators.AfterValidator(func=~monkey_wrench.date_time.models._base.<lambda>)] | None = None, model_filepath: ~typing.Annotated[~pathlib.Path, ~pydantic.types.PathType(path_type=file), ~pydantic.functional_validators.AfterValidator(func=~monkey_wrench.input_output._types.<lambda>), ~pydantic.functional_validators.AfterValidator(func=~monkey_wrench.input_output._types.ensure_path_does_not_end_with_slash)], parent_output_directory_path: ~typing.Annotated[~pathlib.Path, ~pydantic.types.PathType(path_type=dir), ~pydantic.functional_validators.AfterValidator(func=~monkey_wrench.input_output._types.<lambda>)], datetime_format_string: str = '%Y/%m/%d', reset_child_datetime_directory: bool = False, collection: ~monkey_wrench.query._types.EumetsatCollection | str, device: ~typing.Literal['cpu', 'cuda'] = 'cpu', sequence_length: ~typing.Annotated[int, ~annotated_types.Ge(ge=0)] = 16, temporal_overlap: ~typing.Annotated[int, ~annotated_types.Ge(ge=0)] = 0, tile_size: ~typing.Annotated[int, ~annotated_types.Gt(gt=0)] = 256, verbose: bool = True, strict: bool = False, items: ~typing.Annotated[list[~monkey_wrench.generic._types.ElementType] | set[~monkey_wrench.generic._types.ElementType] | tuple[~monkey_wrench.generic._types.ElementType, ...] | ~monkey_wrench.input_output._models.Reader | ~monkey_wrench.input_output._models.DirectoryVisitor, ~pydantic.functional_validators.AfterValidator(func=~monkey_wrench.input_output._models.validate_items)])

Bases: ChimpRetrieval, DateTimePeriod

Pydantic base model for the specifications of a retrieve task.

items: Annotated[list[ElementType] | set[ElementType] | tuple[ElementType, ...] | Reader | DirectoryVisitor, AfterValidator(func=validate_items)]

The items to perform the retrieval on which will be further filter by the given datetime period.

class monkey_wrench.task.chimp.ChimpRetrieve(*, verbose: bool = False, context: Literal[Context.chimp], action: Literal[Action.retrieve], specifications: ChimpRetrieveSpecifications)

Bases: ChimpTaskBase

Pydantic model for the CHIMP retrieval task.

action: Literal[Action.retrieve]

specifications: ChimpRetrieveSpecifications

perform() → None

Perform CHIMP retrievals.

monkey_wrench.task.chimp.ChimpTask

alias of ChimpRetrieve