chore: update README and validation script

Author: mstimberg

simtools/README.md

@@ -3,28 +3,28 @@ ignored. (It is a file with information that was gathered previously and is now
 replaced by the  individual files. As soon as all the information is
 transferred, the file will be deleted.)
 
-The file for each simulator should have a name that is the same as the name of
-the simulator, avoiding spaces. Each file is a `YAML` file with the following
+The file for each simulator should have a name that is the same as the (short) name
+of the simulator, replacing spaces with hyphens. Each file is a `YAML` file with the following
 structure (additional fields not mentioned below will be ignored; the values
-shown below are obviously example values):
+shown below are obviously example values) – the file shown here should be named `Simulator-Name.yaml`:
 
 ```yaml
-- name: Simulator Name
-- features: frontend, simulator
-- operating_system: Linux, MacOS
-- biological_level: Population Model, Single-Compartment (Simple) Model, Single-Compartment (Complex) Model, Multi-Compartment Model
-- processing_support: Single Machine, Cluster, Supercomputer, GPU
-- interface_language: Python
-- model_description_language: NeuroML/LEMS
-- summary: This simulator is very good.
-- urls:
-    homepage: https://example.com
-    email: contact@example.com
-- relations:
-      - name: Another simulator
-        description: exports to
-      - name: Yet another simulator
-        description: imports from
+name: Simulator Name
+features: frontend, simulator
+operating_system: Linux, MacOS
+biological_level: Population Model, Single-Compartment (Simple) Model, Single-Compartment (Complex) Model, Multi-Compartment Model
+processing_support: Single Machine, Cluster, Supercomputer, GPU
+interface_language: Python
+model_description_language: NeuroML/LEMS
+summary: This simulator is very good.
+urls:
+  homepage: https://example.com
+  email: contact@example.com
+relations:
+    - name: Another simulator
+      description: exports to
+    - name: Yet another simulator
+      description: imports from
 ```
 The fields `features`, `operating_system`, `biological_level`,
 `processing_support`, `interface_language`, and `model_description_language`
@@ -33,14 +33,13 @@ are comma-separated strings (i.e. not yaml lists).
 The `features` fields should contain one or more of the following values: `frontend` (for
 interfaces to simulation engines), `simulator` (for simulation engines), `standard`
 (for interoperability standards, APIs, etc.), or `tool` (for a general tool).
-Only tools that are simulators should contain the `biological_level` and
-`processing_support` fields.
+Only tools that are simulators should contain the `biological_level` field.
 
 The `urls` field contains entries that will be displayed as button labels. The
-following names are recognized: `documentation`, `installation`, `tutorial`,
+following names are recognized: `homepage`, `documentation`, `installation`, `tutorial`,
 `examples`, `email`, `chat`, `forum`, `issue tracker`, `source`, `download`.
 The `email` field  should refer to  an email address (which will be converted
-into a `mailto:` link), all other  fields should give a full URL.
+into a `mailto:` link), all other fields should give a full URL.
 
 Relations are a relationships between tools. The mentioned `name` needs to
 match the `name` of another simulator in the directory. The `description` of

tests/validate_data.py

@@ -14,71 +14,55 @@
 import yaml
 
 
-def get_field(data, field):
-    for item in data:
-        if field in item:
-            return item[field]
-    return None
+class SimselectSchema(Schema):
+    def validate(self, data, _is_simselect_schema=True):
+        data = super().validate(data, _is_simselect_schema=False)
+        if _is_simselect_schema and not "simulator" in data["features"]:
+            if "biological_level" in data:
+                raise SchemaError("biological_level is only valid for simulators")
+        return data
 
 
-data_schema = Schema(
-    [
-        {
-            "name": str,
-        },
-        {
-            Optional("short_name"): str,
-        },
-        {
-            "features": And(
-                str,
-                lambda s: all(
-                    ss.strip()
-                    in ["frontend", "simulator", "standard", "tool", "library", "API"]
-                    for ss in s.split(",")
-                ),
-                error="features must be a comma-separated list of 'frontend', 'simulator', 'standard', 'tool', 'library', 'API'",
+data_schema = SimselectSchema(
+    {
+        "name": str,
+        Optional("short_name"): str,
+        "features": And(
+            str,
+            lambda s: all(
+                ss.strip()
+                in ["frontend", "simulator", "standard", "tool", "library", "API"]
+                for ss in s.split(",")
             ),
+            error="features must be a comma-separated list of 'frontend', 'simulator', 'standard', 'tool', 'library', 'API'",
+        ),
+        "operating_system": Or(str, None),
+        Optional("biological_level"): Or(str, None),
+        Optional("processing_support"): Or(str, None),
+        "interface_language": Or(str, None),
+        "summary": str,
+        Optional("model_description_language"): Or(str, None),
+        Optional("urls"): {
+            Or(
+                "homepage",
+                "documentation",
+                "installation",
+                "tutorial",
+                "examples",
+                "email",
+                "chat",
+                "forum",
+                "issue tracker",
+                "source",
+                "download",
+            ): (
+                lambda url: isinstance(url, str)
+                and url.startswith("http")
+                or "@" in url
+            )
         },
-        {"operating_system": Or(str, None)},
-        {
-            "biological_level": Or(str, None),
-        },
-        {
-            "processing_support": Or(str, None),
-        },
-        {
-            "interface_language": Or(str, None),
-        },
-        {
-            "summary": str,
-        },
-        {
-            Optional("model_description_language"): Or(str, None),
-        },
-        {
-            Optional("urls"): {
-                Or(
-                    "homepage",
-                    "documentation",
-                    "installation",
-                    "tutorial",
-                    "examples",
-                    "email",
-                    "chat",
-                    "forum",
-                    "issue tracker",
-                    "source",
-                    "download",
-                ): (
-                    lambda url: isinstance(url, str)
-                    and url.startswith("http")
-                    or "@" in url
-                )
-            }
-        },
-        {Optional("relations"): [{"name": str, "description": str}]},
-    ]
+        Optional("relations"): [{"name": str, "description": str}],
+    }
 )
 
 data_files = Path(Path(__file__).parent / ".." / "simtools")
@@ -99,7 +83,7 @@ def get_field(data, field):
             errors.append(datafile.name)
             print(f"!! {e}")
             print(f"!! {datafile} is invalid.")
-        expected_name = get_field(text, "short_name") or get_field(text, "name")
+        expected_name = text.get("short_name") or text.get("name")
         expected_name = expected_name.replace(" ", "-") + ".yaml"
         if datafile.name != expected_name:
             errors.append(datafile.name)