Support arrow input.

core/test/run_models.jl

@@ -66,6 +66,14 @@ end
     end
 end
 
+@testset "basic arrow model" begin
+    toml_path = normpath(@__DIR__, "../../generated_testmodels/basic_arrow/ribasim.toml")
+    @test ispath(toml_path)
+    model = Ribasim.run(toml_path)
+    @test model isa Ribasim.Model
+    @test successful_retcode(model)
+end
+
 @testset "basic transient model" begin
     toml_path =
         normpath(@__DIR__, "../../generated_testmodels/basic_transient/ribasim.toml")

python/ribasim/ribasim/input_base.py

@@ -114,6 +114,18 @@ def check_filepath(cls, value: Any) -> Any:
         else:
             return value
 
+    def set_filepath(self, filepath: Path) -> None:
+        """Set the filepath of this instance.
+
+        Args:
+            filepath (Path): The filepath to set.
+        """
+        # Disable assignment validation, which would
+        # otherwise trigger check_filepath() and _load() again.
+        self.model_config["validate_assignment"] = False
+        self.filepath = filepath
+        self.model_config["validate_assignment"] = True
+
     @abstractmethod
     def _save(self, directory: DirectoryPath) -> None:
         """Save this instance to disk.
@@ -209,7 +221,10 @@ def _save(
     ) -> None:
         # TODO directory could be used to save an arrow file
         db_path = context_file_loading.get().get("database")
-        if self.df is not None and db_path is not None:
+        if self.df is not None and self.filepath is not None:
+            self.sort(sort_keys)
+            self._write_arrow(self.filepath, directory)
+        elif self.df is not None and db_path is not None:
             self.sort(sort_keys)
             self._write_table(db_path)
 
@@ -233,6 +248,17 @@ def _write_table(self, temp_path: Path) -> None:
                     cursor.execute(sql, (table, "attributes", table))
                 connection.commit()
 
+    def _write_arrow(self, filepath: Path, directory: Path) -> None:
+        """Write the contents of the input to a an arrow file."""
+        if self.df is not None:  # double check to make mypy happy
+            path = directory / filepath  # TODO: Handle relative dir?
+            path.parent.mkdir(parents=True, exist_ok=True)
+            self.df.to_feather(
+                path,
+                compression="zstd",
+                compression_level=6,
+            )
+
     @classmethod
     def _from_db(cls, path: FilePath, table: str) -> pd.DataFrame | None:
         with connect(path) as connection:

python/ribasim_testmodels/ribasim_testmodels/__init__.py

@@ -13,6 +13,7 @@
 )
 from ribasim_testmodels.backwater import backwater_model
 from ribasim_testmodels.basic import (
+    basic_arrow_model,
     basic_model,
     basic_transient_model,
     outlet_model,
@@ -50,6 +51,7 @@
 __all__ = [
     "backwater_model",
     "basic_model",
+    "basic_arrow_model",
     "basic_transient_model",
     "bucket_model",
     "pump_discrete_control_model",

python/ribasim_testmodels/ribasim_testmodels/basic.py

@@ -211,6 +211,12 @@ def basic_model() -> ribasim.Model:
     return model
 
 
+def basic_arrow_model() -> ribasim.Model:
+    model = basic_model()
+    model.basin.profile.set_filepath("input/profile.arrow")
+    return model
+
+
 def basic_transient_model() -> ribasim.Model:
     """Update the basic model with transient forcing"""