hydroflows.methods.sfincs.sfincs_build#

Build a SFINCS model from scratch using hydromt_sfincs.

class hydroflows.methods.sfincs.sfincs_build.SfincsBuild(region: ~pathlib.Path, config: ~pathlib.Path = PosixPath('/home/runner/work/HydroFlows/HydroFlows/hydroflows/cfg/sfincs_build.yml'), catalog_path: ~pathlib.Path | None = None, predefined_catalogs: ~typing.Annotated[list[str], ~pydantic.functional_validators.BeforeValidator(func=~hydroflows._typing.<lambda>, json_schema_input_type=PydanticUndefined)] | None = None, sfincs_root: ~pathlib.Path = PosixPath('models/sfincs'), subgrid_output: bool = False, src_points_output: bool = False, **params)[source]#

Build a SFINCS model from scratch using hydromt_sfincs.

Parameters:

  • region (Path) – The file path to the geometry file that defines the region of interest for constructing a SFINCS model.

  • config (Path) – The path to the configuration file (.yml) that defines the settings to build a SFINCS model. In this file the different model components that are required by the hydromt_sfincs.sfincs.SfincsModel are listed.

  • catalog_path (Optional[Path], optional) – The path to the data catalog file (.yml) that contains the data sources specified in the config file. If None (default), a predefined data catalog should be provided.

  • predefined_catalogs (Optional[ListOfStr], optional) – A list containing the predefined data catalog names.

  • sfincs_root (Path) – The path to the root directory where the SFINCS model will be created, by default “models/sfincs”.

  • subgrid_output (bool, optional) – Determines whether the sfincs subgrid depth output should exist, by default False. In case it is set to True, the setup_subgrid method should be included in the config file.

  • src_points_output (bool, optional) – Determines whether the sfincs river source points should exist, by default False.

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

See also

sfincs_build Input sfincs_build Output sfincs_build Params hydromt_sfincs.SfincsModel

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

Input parameters for the SfincsBuild 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 catalog_path: Annotated[Path, AfterValidator(func=filedir_validator)] | None = None#

The file path to the data catalog. This is a file in yml format, which should contain the data sources specified in the config file.

field config: Path = PosixPath('/home/runner/work/HydroFlows/HydroFlows/hydroflows/cfg/sfincs_build.yml')#

The path to the configuration file (.yml) that defines the settings to build a SFINCS model. In this file the different model components that are required by the hydromt_sfincs.SfincsModel are listed. Every component defines the setting for each hydromt_sfincs setup methods. For more information see hydromt_sfincs method documentation.

field 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.

pydantic model hydroflows.methods.sfincs.sfincs_build.Output[source]#

Output parameters for the SfincsBuild 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: Annotated[Path, AfterValidator(func=filedir_validator)] [Required]#

The path to the SFINCS configuration (inp) file.

field sfincs_region: Path [Required]#

The path to the derived SFINCS region GeoJSON file.

field sfincs_src_points: Path | None = None#

The path to the derived river source points GeoJSON file.

field sfincs_subgrid_dep: Path | None = None#

The path to the derived SFINCS subgrid depth geotiff 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.sfincs.sfincs_build.Params[source]#

Parameters for the SfincsBuild.

See also

hydromt_sfincs.SfincsModel

For more details on the SfincsModel used in hydromt_sfincs.

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 plot_fig: bool = True#

Determines whether to plot a figure with the derived SFINCS base maps.

field predefined_catalogs: <lambda>, json_schema_input_type=PydanticUndefined)] | None = None#

List of predefined data catalogs containing the data sources specified in the config file.

field sfincs_root: Path [Required]#

The path to the root directory where the SFINCS model will be created.

field src_points_output: bool = False#

Determines whether the sfincs river source points should exist.

field subgrid_output: bool = False#

Determines whether the sfincs subgrid depth output should exist.

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.