wip: soil moisture profile model. commit will be rebased

Author: aaraney

python/ngen_conf/src/ngen/config/init_config/soil_moisture_profile.py

@@ -0,0 +1,168 @@
+from typing import Any, Dict, List, Literal, Union, Optional
+
+from ngen.init_config import serializer_deserializer
+from pydantic import root_validator, Field
+
+# from .value_unit_pair import ListUnitPair
+
+# soil_params.smcmax = 0.439
+# soil_params.b = 5.25
+# soil_params.satpsi = 0.355
+# soil_z = (
+#     0.1,
+#     0.2,
+#     0.3,
+#     0.4,
+#     0.5,
+#     0.6,
+#     0.7,
+#     0.8,
+#     0.9,
+#     1.0,
+#     1.1,
+#     1.2,
+#     1.3,
+#     1.4,
+#     1.5,
+#     1.6,
+#     1.7,
+#     1.8,
+#     1.9,
+#     2.0,
+# )
+# soil_storage_model = conceptual
+# soil_storage_depth = 2.0
+
+# soil_depth_layers="bmi" | "BMI"
+# soil_params.smcmax="bmi" | "BMI"
+# soil_params.b: double > 0
+# soil_params.satpsi: double
+# soil_storage_model="Conceptual" | "conceptual" | "layered" | "Layered" | "topmodel" | "TOPMODEL" | "TopModel"
+# soil_moisture_profile_option="Constant" | "constant" | "Linear" | "linear"
+# soil_storage_depth: double >0
+# water_table_depth: double
+# soil_moisture_fraction_depth: double
+# water_table_based_method: "deficit_based" | "flux_based"
+# verbosity: "high" | "low" | "none"
+
+
+# b_set
+# satpsi_set
+# smcmax_set
+# soil_depth_layers_set
+# soil_moisture_fraction_depth_set
+# soil_moisture_profile_option_set
+# soil_storage_model_depth_set
+# soil_storage_model_set
+# soil_z_set
+# water_table_based_method_set
+# water_table_depth_set
+
+bmi = Literal["BMI", "bmi"]
+soil_storage_model = Literal[
+    "Conceptual", "conceptual", "Layered", "layered", "TopModel", "topmodel", "TOPMODEL"
+]
+soil_moisture_profile_option = Literal["Constant", "constant", "Linear", "linear"]
+water_table_based_method = Literal["deficit_based", "flux_based"]
+
+# soil_z_set
+# soil_depth_layers_set
+# smcmax_set
+# b_set
+# satpsi_set
+# soil_storage_model_set
+# soil_storage_model_depth_set
+# water_table_depth_set
+# water_table_based_method_set
+# soil_moisture_fraction_depth_set
+# soil_moisture_profile_option_set
+
+
+class SoilMoistureProfile(serializer_deserializer.IniSerializerDeserializer):
+    soil_z: List[float]
+
+    # NOTE: can also be provided as list of floats.
+    # Not sure if this is expected to always be provided via bmi
+    # soil_depth_layers: Literal["BMI", "bmi"] = "BMI"
+    soil_depth_layers: Union[List[float], bmi]
+
+    # soil_params.smcmax
+    smcmax: Union[List[float], bmi]
+
+    # soil_params.b
+    # b > 0
+    # https://github.com/NOAA-OWP/SoilMoistureProfiles/blob/832d5a70d632d9978dec40a480e970a6b59720c5/src/soil_moisture_profile.cxx#L169C23-L169C23
+    b: float = Field(gt=0)
+
+    # soil_params.satpsi
+    satpsi: float
+
+    soil_storage_model: soil_storage_model
+    soil_moisture_profile_option: Optional[soil_moisture_profile_option]
+
+    # soil_storage_depth > 0
+    # https://github.com/NOAA-OWP/SoilMoistureProfiles/blob/832d5a70d632d9978dec40a480e970a6b59720c5/src/soil_moisture_profile.cxx#L199
+    soil_storage_depth: Optional[float] = Field(None, gt=0)
+
+    # 6.0 default from:
+    # https://github.com/NOAA-OWP/SoilMoistureProfiles/blob/832d5a70d632d9978dec40a480e970a6b59720c5/src/soil_moisture_profile.cxx#L294
+    # https://github.com/NOAA-OWP/SoilMoistureProfiles/blob/832d5a70d632d9978dec40a480e970a6b59720c5/src/soil_moisture_profile.cxx#L298
+    water_table_depth: float = Field(6.0, gte=0)
+
+    # 0.4 meter default from:
+    # https://github.com/NOAA-OWP/SoilMoistureProfiles/blob/832d5a70d632d9978dec40a480e970a6b59720c5/src/soil_moisture_profile.cxx#L270
+    soil_moisture_fraction_depth: float = 0.4  # in meters
+    water_table_based_method: Optional[water_table_based_method]
+
+    # NOTE: this seems like it is optional. confirm this
+    # NOTE: also not sure if this should be "none" by default
+    verbosity: Optional[Literal["high", "low"]]
+
+    @root_validator(pre=True)
+    @classmethod
+    def _root_validator(cls, values: Dict[str, Any]):
+        # soil_params.<var_name> _are_ supported, but deprecated.
+        soil_params_mapping = (
+            ("soil_params.b", "b"),
+            ("soil_params.satpsi", "satpsi"),
+            ("soil_params.smcmax", "smcmax"),
+        )
+        # map from the deprecated names to the supported names _if_ only the deprecated name is provided
+        for alt, actual in soil_params_mapping:
+            if alt in values and actual not in values:
+                values[actual] = values[alt]
+                # delete is not required, pydantic will ignore the values.
+                # del values[alt]
+        return values
+
+    @root_validator()
+    def _assert_invariants(cls, values: Dict[str, Any]):
+        # https://github.com/NOAA-OWP/SoilMoistureProfiles/blob/832d5a70d632d9978dec40a480e970a6b59720c5/src/soil_moisture_profile.cxx#L273
+        soil_storage_model = values["soil_storage_model"]
+        soil_storage_depth = values.get("soil_storage_depth")
+        if soil_storage_depth is None and soil_storage_model.lower() == "conceptual":
+            raise ValueError(
+                f"'soil_storage_depth' required for 'soil_storage_model': {soil_storage_model!r}"
+            )
+
+        # https://github.com/NOAA-OWP/SoilMoistureProfiles/blob/832d5a70d632d9978dec40a480e970a6b59720c5/src/soil_moisture_profile.cxx#L286
+        smp_opt = values.get("soil_moisture_profile_option")
+        if soil_storage_model.lower() == "layered" and smp_opt is None:
+            raise ValueError(
+                f"'soil_moisture_profile_option' required for 'soil_storage_model': {soil_storage_model!r}"
+            )
+
+        # https://github.com/NOAA-OWP/SoilMoistureProfiles/blob/832d5a70d632d9978dec40a480e970a6b59720c5/src/soil_moisture_profile.cxx#L313
+        wtm = values.get("water_table_based_method")
+        if soil_storage_model.lower() == "topmodel" and wtm is None:
+            raise ValueError(
+                f"'water_table_based_method' required for 'soil_storage_model': {soil_storage_model!r}"
+            )
+
+        return values
+
+    class Config(serializer_deserializer.IniSerializerDeserializer.Config):
+        no_section_headers: bool = True
+        # extra space is not accounted for
+        # TODO: get link
+        space_around_delimiters: bool = False