merge changes from base branch

Author: MAfarrag

hydrolib/core/dflowfm/ext/models.py

@@ -97,7 +97,7 @@ def _get_identifier(self, data: dict) -> Optional[str]:
         return data.get("nodeid")
 
     @property
-    def forcing(self) -> ForcingBase:
+    def forcing(self) -> Union[ForcingBase, None]:
         """Retrieves the corresponding forcing data for this boundary.
 
         Returns:
@@ -208,7 +208,7 @@ class MeteoForcingFileType(StrEnum):
     netcdf = "netcdf"
     """str: NetCDF, either with gridded data, or multiple station time series."""
 
-    allowedvaluestext = "Possible values: bcAscii, netcdf, uniform."
+    allowedvaluestext = "Possible values: bcAscii, uniform, uniMagDir, meteoGridEqui, spiderweb, meteoGridCurvi, netcdf."
 
 
 class MeteoInterpolationMethod(StrEnum):
@@ -218,10 +218,10 @@ class MeteoInterpolationMethod(StrEnum):
     """
 
     nearestnb = "nearestNb"
-    linearSpaceTime = "linearSpaceTime"
     """str: Nearest-neighbour interpolation, only with station-data in forcingFileType=netcdf"""
-
-    allowedvaluestext = "Possible values: nearestNb (only with station data in forcingFileType=netcdf ). "
+    linearSpaceTime = "linearSpaceTime"
+    """str: Linear interpolation in space and time."""
+    allowedvaluestext = "Possible values: nearestNb, linearSpaceTime."
 
 
 class Meteo(INIBasedModel):
@@ -286,7 +286,7 @@ def _get_unknown_keyword_error_manager(cls) -> Optional[UnknownKeywordErrorManag
     )
 
     _header: Literal["Meteo"] = "Meteo"
-    quantity: str = Field(alias="QUANTITY")
+    quantity: str = Field(alias="quantity")
     forcingfile: Union[TimModel, ForcingModel, DiskOnlyFileModel] = Field(
         alias="forcingFile"
     )

hydrolib/core/dflowfm/extold/models.py

@@ -18,6 +18,14 @@
 from hydrolib.core.dflowfm.polyfile.models import PolyFile
 from hydrolib.core.dflowfm.tim.models import TimModel
 
+INITIAL_CONDITION_QUANTITIES_VALID_PREFIXES = (
+    "initialtracer",
+    "initialsedfrac",
+    "initialverticalsedfracprofile",
+    "initialverticalsigmasedfracprofile",
+)
+
+
 HEADER = """
  QUANTITY    : waterlevelbnd, velocitybnd, dischargebnd, tangentialvelocitybnd, normalvelocitybnd  filetype=9         method=2,3
              : outflowbnd, neumannbnd, qhbnd, uxuyadvectionvelocitybnd                             filetype=9         method=2,3
@@ -151,7 +159,7 @@ class ExtOldBoundaryQuantity(StrEnum):
     NormalVelocityBnd = "normalvelocitybnd"
     """Normal velocity"""
     TangentialVelocityBnd = "tangentialvelocitybnd"
-    """Tangentional velocity"""
+    """Tangential velocity"""
     QhBnd = "qhbnd"
     """Discharge-water level dependency"""
 
@@ -243,21 +251,55 @@ class ExtOldInitialConditionQuantity(StrEnum):
     Initial Condition quantities:
         initialwaterlevel, initialsalinity, initialsalinitytop, initialtemperature,
         initialverticaltemperatureprofile, initialverticalsalinityprofile, initialvelocityx,
-        initialvelocityy, initialvelocity, initialsalinitytopuse
+        initialvelocityy, initialvelocity
+
+    If there is a missing quantity that is mentioned in the "Accepted quantity names" section of the user manual
+    [Sec.C.5.3](https://content.oss.deltares.nl/delft3dfm1d2d/D-Flow_FM_User_Manual_1D2D.pdf#subsection.C.5.3).
+    and [Sec.D.3](https://content.oss.deltares.nl/delft3dfm1d2d/D-Flow_FM_User_Manual_1D2D.pdf#subsection.D.3).
+    please open and issue in github.
     """
 
     # Initial Condition fields
+    BedLevel = "bedlevel"
+    BedLevel1D = "bedlevel1D"
+    BedLevel2D = "bedlevel2D"
+
     InitialWaterLevel = "initialwaterlevel"
+    InitialWaterLevel1D = "initialwaterlevel1d"
+    InitialWaterLevel2D = "initialwaterlevel2d"
+
     InitialSalinity = "initialsalinity"
     InitialSalinityTop = "initialsalinitytop"
+    InitialSalinityBot = "initialsalinitybot"
+    InitialVerticalSalinityProfile = "initialverticalsalinityprofile"
+
     InitialTemperature = "initialtemperature"
     InitialVerticalTemperatureProfile = "initialverticaltemperatureprofile"
-    InitialVerticalSalinityProfile = "initialverticalsalinityprofile"
 
+    initialUnsaturatedZoneThickness = "initialunsaturatedzonethickness"
     InitialVelocityX = "initialvelocityx"
     InitialVelocityY = "initialvelocityy"
     InitialVelocity = "initialvelocity"
-    InitialSalinityTopUse = "initialsalinitytopuse"
+    InitialWaqBot = "initialwaqbot"
+
+    @classmethod
+    def _missing_(cls, value):
+        """Custom implementation for handling missing values.
+
+        the method parses any missing values and only allows the ones that start with "initialtracer".
+        """
+        # Allow strings starting with "tracer"
+        if isinstance(value, str) and value.startswith(
+            INITIAL_CONDITION_QUANTITIES_VALID_PREFIXES
+        ):
+            new_member = str.__new__(cls, value)
+            new_member._value_ = value
+            return new_member
+        else:
+            raise ValueError(
+                f"{value} is not a valid {cls.__name__} possible quantities are {', '.join(cls.__members__)}, "
+                f"and quantities that start with 'tracer'"
+            )
 
 
 class ExtOldQuantity(StrEnum):
@@ -722,7 +764,7 @@ class ExtOldModel(ParsableFileModel):
     This model is typically referenced under a [FMModel][hydrolib.core.dflowfm.mdu.models.FMModel]`.external_forcing.extforcefile`.
     """
 
-    comment: List[str] = Field(default_factory=lambda: HEADER.splitlines()[1:])
+    comment: List[str] = Field(default=HEADER.splitlines()[1:])
     """List[str]: The comments in the header of the external forcing file."""
     forcing: List[ExtOldForcing] = Field(default_factory=list)
     """List[ExtOldForcing]: The external forcing/QUANTITY blocks in the external forcing file."""

hydrolib/tools/ext_old_to_new/converters.py

@@ -186,9 +186,9 @@ def create_convert_inputs(forcing: ExtOldForcing) -> Dict[str, str]:
     block_data["operand"] = forcing.operand
 
     if hasattr(forcing, "extrapolation"):
-        block_data["extrapolationmethod"] = forcing.extrapolation
-    if hasattr(forcing, "locationtype"):
-        block_data["locationtype"] = forcing.locationtype
+        block_data["extrapolationmethod"] = (
+            "yes" if forcing.extrapolation == 1 else "no"
+        )
 
     return block_data
 
@@ -199,14 +199,14 @@ def __init__(self):
         super().__init__()
 
     def convert(self, forcing: ExtOldForcing) -> InitialField:
-        """Convert an old external forcing block with meteo data to a Meteo
-        forcing block suitable for inclusion in a new external forcings file.
+        """Convert an old external forcing block with Initial condition data to a IinitialField
+        forcing block suitable for inclusion in a new inifieldfile file.
+
 
         This function takes a forcing block from an old external forcings
         file, represented by an instance of ExtOldForcing, and converts it
-        into a Meteo object. The Meteo object is suitable for use in new
-        external forcings files, adhering to the updated format and
-        specifications.
+        into a InitialField object. The InitialField object is suitable for use in new
+        iniFieldFile, adhering to the updated format and specifications.
 
         Args:
             forcing (ExtOldForcing): The contents of a single forcing block
@@ -215,16 +215,16 @@ def convert(self, forcing: ExtOldForcing) -> InitialField:
             required for the conversion process.
 
         Returns:
-            Meteo: A Meteo object that represents the converted forcing
-            block, ready to be included in a new external forcings file. The
-            Meteo object conforms to the new format specifications, ensuring
-            compatibility with updated systems and models.
+            Initial condition field definition, represents an `[Initial]` block in an inifield file.
 
         Raises:
             ValueError: If the forcing block contains a quantity that is not
             supported by the converter, a ValueError is raised. This ensures
             that only compatible forcing blocks are processed, maintaining
             data integrity and preventing errors in the conversion process.
+
+        References:
+            [Sec.D](https://content.oss.deltares.nl/delft3dfm1d2d/D-Flow_FM_User_Manual_1D2D.pdf#subsection.D)
         """
         data = create_convert_inputs(forcing)
         new_block = InitialField(**data)

hydrolib/tools/ext_old_to_new/main_converter.py

@@ -30,7 +30,7 @@ class ExternalForcingConverter:
 
     def __init__(
         self,
-        extold_model: ExtOldModel,
+        extold_model: Union[PathOrStr, ExtOldModel],
         ext_model_path: PathOrStr = None,
         inifield_model_path: PathOrStr = None,
         structure_model_path: PathOrStr = None,
@@ -41,15 +41,14 @@ def __init__(
         old external forcing file, if no paths were given by the user for the new models.
 
         Args:
-            extold_model (ExtOldModel): object with all forcing blocks.
+            extold_model (PathOrStr, ExtOldModel): ExtOldModel or path to the old external forcing file.
             ext_model_path (PathOrStr, optional): Path to the new external forcing file.
             inifield_model_path (PathOrStr, optional): Path to the initial field file.
             structure_model_path (PathOrStr, optional): Path to the structure file.
         """
-        if not isinstance(extold_model, ExtOldModel):
-            raise ValueError(
-                f"Expected an ExtOldModel object, got {type(extold_model)} instead."
-            )
+        if isinstance(extold_model, Path) or isinstance(extold_model, str):
+            extold_model = self._read_old_file(extold_model)
+
         self._extold_model = extold_model
         rdir = extold_model.filepath.parent
 
@@ -128,8 +127,8 @@ def structure_model(self, path: PathOrStr):
             StructureModel, path
         )
 
-    @classmethod
-    def read_old_file(cls, extoldfile: PathOrStr) -> "ExternalForcingConverter":
+    @staticmethod
+    def _read_old_file(extoldfile: PathOrStr) -> ExtOldModel:
         """Read a legacy D-Flow FM external forcings file (.ext) into an
            ExtOldModel object.
 
@@ -149,13 +148,18 @@ def read_old_file(cls, extoldfile: PathOrStr) -> "ExternalForcingConverter":
             ExternalForcingConverter: object with the old external forcing model and new external forcing, initial field
         """
         global _verbose
+        if not isinstance(extoldfile, Path):
+            extoldfile = Path(extoldfile)
+
+        if not extoldfile.exists():
+            raise FileNotFoundError(f"File not found: {extoldfile}")
 
         extold_model = ExtOldModel(extoldfile)
 
         if _verbose:
             print(f"Read {len(extold_model.forcing)} forcing blocks from {extoldfile}.")
 
-        return cls(extold_model)
+        return extold_model
 
     def update(
         self,
@@ -272,15 +276,12 @@ def ext_old_to_new_from_mdu(
 
     workdir = fmmodel._resolved_filepath.parent
     os.chdir(workdir)
-    if fmmodel.external_forcing.extforcefile is None:
-        if _verbose:
-            print(
-                f"mdufile: {mdufile} does not contain an old style external forcing file"
-            )
-            return
-    # Input file:
+    if fmmodel.external_forcing.extforcefile is None and _verbose:
+        print(f"mdufile: {mdufile} does not contain an old style external forcing file")
+        return
+
     extoldfile = fmmodel.external_forcing.extforcefile._resolved_filepath
-    # Output files:
+
     extfile = (
         fmmodel.external_forcing.extforcefilenew._resolved_filepath
         if fmmodel.external_forcing.extforcefilenew
@@ -297,11 +298,14 @@ def ext_old_to_new_from_mdu(
         else workdir / structurefile
     )
 
-    converter = ExternalForcingConverter.read_old_file(extoldfile)
-    # The actual conversion:
-    extold_model, ext_model, inifield_model, structure_model = converter.update(
-        extfile, inifieldfile, structurefile, backup, postfix
+    converter = ExternalForcingConverter(
+        extoldfile, extfile, inifieldfile, structurefile
     )
+
+    # The actual conversion:
+    ext_model, inifield_model, structure_model = converter.update(postfix)
+    converter.save(backup)
+    extold_model = converter.extold_model
     try:
         # And include the new files in the FM model:
         _ = ExtModel(extfile)
@@ -315,7 +319,8 @@ def ext_old_to_new_from_mdu(
             fmmodel.geometry.structurefile[0] = structure_model
 
         # Save the updated FM model:
-        backup_file(fmmodel.filepath, backup)
+        if backup:
+            backup_file(fmmodel.filepath)
         converted_mdufile = construct_filepath_with_postfix(mdufile, postfix)
         fmmodel.filepath = converted_mdufile
         fmmodel.save(recurse=False, exclude_unset=True)
@@ -424,19 +429,19 @@ def main(args=None):
             args.mdufile, **outfiles, backup=backup, postfix=args.postfix
         )
     elif args.extoldfile is not None:
-        converter = ExternalForcingConverter.read_old_file(args.extoldfile)
-        converter.ext_model = outfiles["extfile"]
-        converter.inifield_model = outfiles["inifieldfile"]
-        converter.structure_model = outfiles["structurefile"]
+        converter = ExternalForcingConverter(
+            args.extoldfile,
+            outfiles["extfile"],
+            outfiles["inifieldfile"],
+            outfiles["structurefile"],
+        )
         converter.update(postfix=args.postfix)
         converter.save(backup=backup)
     elif args.dir is not None:
-        ext_old_to_new_dir_recursive(args.dir, backup=backup, postfix=args.postfix)
+        ext_old_to_new_dir_recursive(args.dir, backup=backup)
     else:
         print("Error: no input specified. Use one of --mdufile, --extoldfile or --dir.")
 
-    #     sys.exit(1)
-
     print(_program + ": done")