hydroflows.methods.dummy.postprocess_dummy_event#

Dummy methods for testing and user documentation.

pydantic model hydroflows.methods.dummy.postprocess_dummy_event.PostprocessDummyEventInput[source]#

Input files for the PostprocessDummyEvent 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_nc: Path [Required]#

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.postprocess_dummy_event.PostprocessDummyEventOutput[source]#

Output files for the PostprocessDummyEvent 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 postprocessed_nc: Path [Required]#

Postprocessed 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.postprocess_dummy_event.PostprocessDummyEventParams[source]#

Parameters for the PostprocessDummyEvent 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 event_name: str [Required]#

The event name

field output_dir: Path [Required]#

The 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.postprocess_dummy_event.PostprocessDummyEvent(model_nc: Path, output_dir: Path, event_name: str | None = None)[source]#

Postprocess a dummy event.

Parameters:

  • model_nc (Path) – Model output netcdf file

  • output_dir (Path) – The output directory

  • event_name (str, optional) – The event name, by default None