From 71c91dccba0fbadead9bd98308fb0e00efa60530 Mon Sep 17 00:00:00 2001 From: Daniel Weindl Date: Mon, 28 Jul 2025 08:56:02 +0200 Subject: [PATCH 1/2] Add `id` field I think it would often be convenient to have some ID for a given PEtab problem and I would like to add such a field to the yaml schema. Previously, we usually used the model ID in such situations. However, often we have multiple problems based on the same model but different datasets, and this doesn't work well in the case of multiple models. Not sure whether it should be mandatory or optional. I think, I'd go for optional. --- doc/v2/_static/petab_schema_v2.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/v2/_static/petab_schema_v2.yaml b/doc/v2/_static/petab_schema_v2.yaml index c0e315f2..2fd1be8c 100644 --- a/doc/v2/_static/petab_schema_v2.yaml +++ b/doc/v2/_static/petab_schema_v2.yaml @@ -14,6 +14,11 @@ properties: description: Version of the PEtab format + id: + type: string + description: Identifier of the PEtab problem. + pattern: "^[a-zA-Z_]\\w*$" + parameter_files: type: array description: | From fd92e34a85dd450e4b24b12ab33a6c055c6c91c2 Mon Sep 17 00:00:00 2001 From: Daniel Weindl Date: Wed, 24 Sep 2025 09:25:59 +0200 Subject: [PATCH 2/2] description --- doc/v2/_static/petab_schema_v2.yaml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/v2/_static/petab_schema_v2.yaml b/doc/v2/_static/petab_schema_v2.yaml index 2fd1be8c..1e6497af 100644 --- a/doc/v2/_static/petab_schema_v2.yaml +++ b/doc/v2/_static/petab_schema_v2.yaml @@ -16,7 +16,10 @@ properties: id: type: string - description: Identifier of the PEtab problem. + description: | + Identifier of the PEtab problem. + + This is optional and has no effect on the PEtab problem itself. pattern: "^[a-zA-Z_]\\w*$" parameter_files: