Give users easier access to container logs

CHANGELOG.md

@@ -8,6 +8,7 @@ Formatted as described on [https://keepachangelog.com](https://keepachangelog.co
 
 ## Added
 
+- `model.logs` property to inspect the logs of a containerized model ([#470](https://github.com/eWaterCycle/ewatercycle/pull/470)).
 - mention remotebmi in docs ([#471](https://github.com/eWaterCycle/ewatercycle/issues/471))
 
 ## [2.4.0] (2024-12-04)

docs/user_guide/03_models_obs_analysis.ipynb

@@ -302,6 +302,19 @@
     "model_instance.initialize(cfg_file)  # for some models, this step can take some time"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "d94ad9b6",
+   "metadata": {},
+   "source": [
+    "Note that if anything goes wrong on the model side during initialization or at any other point in time you can inspect the model's logs. For example, if some input file is missing or corrupt.\n",
+    "In this case you would do:\n",
+    "\n",
+    "```py\n",
+    "print(model_instance.logs)\n",
+    "```"
+   ]
+  },
   {
    "attachments": {},
    "cell_type": "markdown",

src/ewatercycle/base/model.py

@@ -452,6 +452,27 @@
         """Version of the container image."""
         return self.bmi_image.version
 
+    @property
+    def logs(self) -> str:
+        """Return the container logs."""
+        if not hasattr(self, "_bmi"):
+            msg = (
+                "The model has no BMI attached (yet).\n"
+                "Logs will only be available after running `.setup`"
+            )
+            raise ValueError(msg)
+        bmi = self._bmi
+        while hasattr(bmi, "origin"):
+            bmi = bmi.origin  # type: ignore[assignment,unused-ignore]
+
+        if hasattr(bmi, "logs"):
+            return bmi.logs()
+        msg = (
+            "No logs detected, only containerized models are expected to have logs.\n"
+            f"BMI is of unexpected type {type(bmi)}."
+        )
+        raise ValueError(msg)
+
     def _make_bmi_instance(self) -> OptionalDestBmi:
         if self.parameter_set:
             self._additional_input_dirs.append(str(self.parameter_set.directory))