hydroflows.methods.flood_adapt.prep_sfincs_models#

Prepare a SFINCS model for usage in FloodAdapt.

class hydroflows.methods.flood_adapt.prep_sfincs_models.PrepSfincsModels(sfincs_inp: Path, output_dir: Path = 'flood_adapt_builder')[source]#

Prepare a SFINCS model for usage in FloodAdapt.

Parameters:

  • sfincs_inp (Path) – The file path to the SFINCS base model.

  • output_dir (Path, optional) – The folder where the output is stored, by default “flood_adapt_builder”.

  • **params – Additional parameters to pass to the GetERA5Rainfall instance.

See also

SetupFloodAdapt Input SetupFloodAdapt Input SetupFloodAdapt Input

pydantic model hydroflows.methods.flood_adapt.prep_sfincs_models.Input[source]#

Input parameters for the PrepSfincsModels 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 sfincs_inp: Path [Required]#

The file path to the SFINCS base model config 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.flood_adapt.prep_sfincs_models.Output[source]#

Output parameters for the PrepSfincsModels 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 sfincs_out_inp: Path [Required]#

The path to the copied sfincs model configuration.

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.flood_adapt.prep_sfincs_models.Params[source]#

Parameters for the PrepSfincsModels 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 = PosixPath('flood_adapt_builder')#

The directory where the output files will be saved.

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.