Source code for hydroflows.methods.flood_adapt.prep_sfincs_models

"""Prepare a SFINCS model for usage in FloodAdapt."""

import shutil
from pathlib import Path

from hydromt_sfincs import SfincsModel

from hydroflows.workflow.method import Method
from hydroflows.workflow.method_parameters import Parameters

__all__ = ["PrepSfincsModels", "Input", "Output", "Params"]




class Input(Parameters):
    """Input parameters for the :py:class:`PrepSfincsModels` method."""

    sfincs_inp: Path
    """
    The file path to the SFINCS base model config file.
    """





class Output(Parameters):
    """Output parameters for the :py:class:`PrepSfincsModels` method."""

    sfincs_out_inp: Path
    """The path to the copied sfincs model configuration."""





class Params(Parameters):
    """Parameters for the :py:class:`PrepSfincsModels` method."""

    output_dir: Path = Path("flood_adapt_builder")
    """
    The directory where the output files will be saved.
    """





class PrepSfincsModels(Method):
    """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
    --------
    :py:class:`SetupFloodAdapt Input <hydroflows.methods.flood_adapt.sprep_sfincs_models.Input>`
    :py:class:`SetupFloodAdapt Input <hydroflows.methods.flood_adapt.prep_sfincs_models.Output>`
    :py:class:`SetupFloodAdapt Input <hydroflows.methods.flood_adapt.prep_sfincs_models.Params>`
    """

    name: str = "prep_sfincs_models"

    _test_kwargs = dict(sfincs_inp=Path("models", "sfincs", "sfincs.inp").as_posix())

    def __init__(
        self,
        sfincs_inp: Path,
        output_dir: Path = "flood_adapt_builder",
    ):
        self.input: Input = Input(
            sfincs_inp=sfincs_inp,
        )
        self.params: Params = Params(output_dir=output_dir)

        self.output: Output = Output(
            sfincs_out_inp=Path(
                self.params.output_dir, self.input.sfincs_inp.parent.stem, "sfincs.inp"
            ),
        )

    def _run(self):
        """Run the PrepSfincsModels method."""
        # Get all sfincs models and prepare and copy sfincs model
        sfincs_model = Path(self.params.output_dir, self.input.sfincs_inp.parent.stem)
        shutil.copytree(
            Path(self.input.sfincs_inp.parent),
            sfincs_model,
            dirs_exist_ok=True,
            ignore=lambda d, c: set(
                filter(
                    lambda x: (Path(d) / x).is_dir() and x not in {"gis", "subgrid"}, c
                )
            ),
        )
        sm = SfincsModel(
            root=sfincs_model,
            mode="r",
        )

        if "bndfile" not in sm.config:
            sm.setup_waterlevel_bnd_from_mask(1e9)
            sm.write_forcing()
            Path(sfincs_model, sm.config.pop("bzsfile")).unlink()

        # Remove discharge
        if "disfile" in sm.config:
            Path(sfincs_model, sm.config.pop("disfile")).unlink()
            sm.write_config()