hydroflows.methods.dummy.combine_dummy_events#

“Dummy methods for testing and user documentation.

pydantic model hydroflows.methods.dummy.combine_dummy_events.CombineDummyEventsInput[source]#

Input files for the CombineDummyEvents method.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Fields:
field model_out_ncs: _check_path_has_wildcard)] [Required]#

Model output netcdf files to be combined. This argument expects either a path with a wildcard or a list of paths.

model_post_init(context: Any, /) → None#

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

  • self – The BaseModel instance.

  • context – The context.

pydantic model hydroflows.methods.dummy.combine_dummy_events.CombineDummyEventsOutput[source]#

Output files for the CombineDummyEvents method.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Fields:
field combined_out_nc: Path [Required]#

Combined model output netcdf file

model_post_init(context: Any, /) → None#

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

  • self – The BaseModel instance.

  • context – The context.

pydantic model hydroflows.methods.dummy.combine_dummy_events.CombineDummyEventsParams[source]#

Parameters for the CombineDummyEvents method.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Fields:
field output_dir: Path | None = None#

Output directory

model_post_init(context: Any, /) → None#

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

  • self – The BaseModel instance.

  • context – The context.

class hydroflows.methods.dummy.combine_dummy_events.CombineDummyEvents(model_out_ncs: ~typing.Annotated[~typing.List[~pathlib.Path], ~pydantic.functional_validators.BeforeValidator(func=~hydroflows._typing.<lambda>, json_schema_input_type=PydanticUndefined)] | ~pathlib.Annotated[~pathlib.Path, ~pydantic.functional_validators.AfterValidator(func=~hydroflows._typing._check_path_has_wildcard)], output_dir: ~pathlib.Path | None = None, **params)[source]#

Create a CombineDummyEvents instance.

Parameters:

  • model_out_ncs (List[Path] | WildcardPath) – Model output netcdf files to be combined. This argument expects either a path with a wildcard or a list of paths.

  • output_dir (Path, optional) – The output directory, by default None

  • **params – Additional parameters to pass to the CombineDummyEvents Params instance. See CombineDummyEvents