Add model version to simulationresult

Author: lars-petter-hauge

backend/alembic/versions/60afa15c63a4_added_model_version_to_simulation.py

@@ -0,0 +1,33 @@
+"""Added model_version to simulation
+
+Revision ID: 60afa15c63a4
+Revises: c35588effcc4
+Create Date: 2025-11-18 10:43:26.687119
+
+"""
+
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = "60afa15c63a4"
+down_revision: Union[str, Sequence[str], None] = "c35588effcc4"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    """Upgrade schema."""
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column("results", sa.Column("model_version", sa.String(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    """Downgrade schema."""
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("results", "model_version")
+    # ### end Alembic commands ###

backend/src/acidwatch_api/database.py

@@ -55,6 +55,7 @@ class Result(Base):
     __tablename__ = "results"
 
     simulation_id: Mapped[UUID] = mapped_column(ForeignKey("simulations.id"))
+    model_version: Mapped[str | None]
     concentrations: Mapped[dict[str, float]] = mapped_column(JSON)
     panels: Mapped[list[Any]] = mapped_column(JSON)
     python_exception: Mapped[BaseException | None] = mapped_column(PickleType)

backend/src/acidwatch_api/models/base.py

@@ -274,6 +274,8 @@ def __init_subclass__(cls) -> None:
 
     model_id: Annotated[str, Doc("Unique model identifier")]
 
+    model_version: Annotated[str, Doc("Model version (can be set during run function)")]
+
     display_name: Annotated[
         str, Doc("User-friendly model name which is displayed in the frontend")
     ]

backend/src/acidwatch_api/models/datamodel.py

@@ -28,6 +28,7 @@ class ModelInput(RunRequest):
 class RunResponse(_BaseModel):
     status: Literal["done", "pending"]
     model_input: ModelInput
+    model_version: str | None = None
     final_concentrations: dict[str, int | float] = Field(default_factory=dict)
     panels: Iterable[AnyPanel] = ()
 

backend/src/acidwatch_api/models/example_adapter.py

@@ -24,6 +24,14 @@ class ExampleAdapter(BaseAdapter):
 
     model_id = "example"
 
+    # if a model is based on a python package one would typically do:
+    # model_version = package_name.__version__
+    #
+    # It's also possible to modify this during the run function.
+    # It will be used to provide meta information of any content returned
+    # in the run function
+    model_version = "1.0.0"
+
     # Every model requires a human-readable model name. This text will be
     # displayed in the frontend.
     display_name = "Example"

backend/src/acidwatch_api/routes/models.py

@@ -83,6 +83,7 @@ async def _run_adapter(
 
         result_obj = db.Result(
             simulation_id=simulation_id,
+            model_version=adapter.model_version,
             concentrations=concs,
             panels=[p.model_dump(mode="json", by_alias=True) for p in panels],
             python_exception=None,
@@ -174,6 +175,7 @@ def get_result_for_simulation(
 
     return RunResponse(
         status="done",
+        model_version=result.model_version,
         model_input=model_input,
         final_concentrations=result.concentrations,
         panels=result.panels,

backend/tests/test_models_endpoints.py

@@ -41,6 +41,7 @@ def test_get_models(client):
 
 class DummyAdapter(base.BaseAdapter):
     model_id = "dummy"
+    model_version = "0.0.0"
     display_name = "Dummy Model"
     description = ""
     category = "Primary"
@@ -80,6 +81,7 @@ def test_run_test_model(client, dummy_model):
 
     assert response.json() == {
         "status": "done",
+        "modelVersion": dummy_model.model_version,
         "modelInput": {
             "modelId": dummy_model.model_id,
             "parameters": {},
@@ -125,6 +127,7 @@ def test_dummy_model_only_valid_substances_are_present(
         response = client.get(f"/simulations/{simulation_id}/result")
         assert response.json() == {
             "status": "done",
+            "modelVersion": dummy_model.model_version,
             "modelInput": {
                 "modelId": dummy_model.model_id,
                 "concentrations": concentrations,
@@ -300,6 +303,7 @@ async def run(self):
 
         assert response.json() == {
             "status": "done",
+            "modelVersion": dummy_model.model_version,
             "modelInput": {
                 "modelId": dummy_model.model_id,
                 "concentrations": {},

frontend/src/dto/SimulationResults.tsx

@@ -34,5 +34,6 @@ export const SimulationResults = z.object({
     modelInput: ModelInput,
     finalConcentrations: z.record(z.string(), z.number()),
     panels: z.array(Panel),
+    modelVersion: z.string(),
 });
 export type SimulationResults = z.infer<typeof SimulationResults>;