hydroflows.methods.sfincs.sfincs_region#

Define a SFINCS model region based on hydrological subbasins.

class hydroflows.methods.sfincs.sfincs_region.SfincsRegion(subbasins: Path, aoi: Path, sfincs_region: Path = PosixPath('sfincs_region.geojson'))[source]#

Define a SFINCS model region based on hydrological subbasins.

Parameters:

  • aoi (Path) – The file path the geometry file defining the Area of Interest (AOI).

  • subbasins (Path) – The file path to the geometry file containing hydrological (sub)basins/catchments. Basins intersecting with the Area of Interest (AOI) will be retained.

  • region (Path, optional) – The file path to the derived sfincs region, by default “sfincs_region.geojson”.

See also

SfincsRegion Input SfincsRegion Output

pydantic model hydroflows.methods.sfincs.sfincs_region.Input[source]#

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

The file path the geometry file defining the Area of Interest (AOI). This represents the geographic region for which a flood risk assessment will be conducted. The AOI file can include boundaries such as a city’s administrative limits or any other spatial boundary of interest.

field subbasins: Path [Required]#

The file path to the geometry file containing hydrological (sub)basins/catchments. This file must include a valid coordinate reference system (CRS).

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.sfincs.sfincs_region.Output[source]#

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

The file path to the geometry file that defines the region of interest for constructing a SFINCS model.

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.