precice-adapter-schema 0.4.1__tar.gz

precice_adapter_schema-0.4.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright 2026 Felix Neubauer, Frédéric Simonis, The preCICE developers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

precice_adapter_schema-0.4.1/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: precice-adapter-schema
+Version: 0.4.1
+Summary: Validation utility for preCICE adapter configurations
+Author-email: preCICE developers <info@precice.org>
+Project-URL: Homepage, https://github.com/precice/adapter-schema
+Project-URL: Repository, https://github.com/precice/adapter-schema
+Keywords: preCICE,adapter,validation,schema
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jsonschema>=4.0.0
+Requires-Dist: importlib-resources>=5.0.0; python_version < "3.9"
+Dynamic: license-file
+
+# preCICE Adapter Schema
+
+Here the adapter configuration schema is stored, together with validation utility.
+
+A schema ...
+
+- defines how a configuration file looks like (thus replaces any explicit documentation).
+- enables interoperability (through standardization).
+- simplifies auto-generation.
+- enables tooling support (e.g. IDEs or GUIs).
+- enables automatic LLM-based conversion from and to other configuration languages.
+- ...
+
+## Installation
+
+Install the package using pip:
+
+```bash
+pip install preciceadapterschema
+```
+
+For development, install in editable mode:
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+The `preciceadapterschema` package provides a `validate` function to validate preCICE adapter configurations against the JSON schema.
+
+```python
+import preciceadapterschema
+
+# Your configuration data
+config_data = {
+}
+
+# Validate the configuration
+try:
+    preciceadapterschema.validate(config_data)
+    print("Configuration is valid!")
+except Exception as e:
+    print(f"Validation failed: {e}")
+```
+
+The schema file (`precice_adapter_config.schema.json`) is included in the package and loaded automatically by the `validate` function.
+
+## Configuring preCICE Adapters
+
+We recommend using [MetaConfigurator](https://metaconfigurator.org/?schema=https://github.com/precice/adapter-schema/blob/main/preciceadapterschema/precice_adapter_config.schema.json&settings=https://github.com/precice/adapter-schema/blob/main/metaconfigurator_settings.json) to create and edit preCICE adapter configurations. It provides a user-friendly interface and ensures that your configurations are always valid according to the schema.
+
+## Development
+
+### Running Tests
+
+Run tests using unittest:
+
+```bash
+python -m unittest discover -s tests -v
+```

precice_adapter_schema-0.4.1/README.md

@@ -0,0 +1,61 @@
+# preCICE Adapter Schema
+
+Here the adapter configuration schema is stored, together with validation utility.
+
+A schema ...
+
+- defines how a configuration file looks like (thus replaces any explicit documentation).
+- enables interoperability (through standardization).
+- simplifies auto-generation.
+- enables tooling support (e.g. IDEs or GUIs).
+- enables automatic LLM-based conversion from and to other configuration languages.
+- ...
+
+## Installation
+
+Install the package using pip:
+
+```bash
+pip install preciceadapterschema
+```
+
+For development, install in editable mode:
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+The `preciceadapterschema` package provides a `validate` function to validate preCICE adapter configurations against the JSON schema.
+
+```python
+import preciceadapterschema
+
+# Your configuration data
+config_data = {
+}
+
+# Validate the configuration
+try:
+    preciceadapterschema.validate(config_data)
+    print("Configuration is valid!")
+except Exception as e:
+    print(f"Validation failed: {e}")
+```
+
+The schema file (`precice_adapter_config.schema.json`) is included in the package and loaded automatically by the `validate` function.
+
+## Configuring preCICE Adapters
+
+We recommend using [MetaConfigurator](https://metaconfigurator.org/?schema=https://github.com/precice/adapter-schema/blob/main/preciceadapterschema/precice_adapter_config.schema.json&settings=https://github.com/precice/adapter-schema/blob/main/metaconfigurator_settings.json) to create and edit preCICE adapter configurations. It provides a user-friendly interface and ensures that your configurations are always valid according to the schema.
+
+## Development
+
+### Running Tests
+
+Run tests using unittest:
+
+```bash
+python -m unittest discover -s tests -v
+```

precice_adapter_schema-0.4.1/precice_adapter_schema.egg-info/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: precice-adapter-schema
+Version: 0.4.1
+Summary: Validation utility for preCICE adapter configurations
+Author-email: preCICE developers <info@precice.org>
+Project-URL: Homepage, https://github.com/precice/adapter-schema
+Project-URL: Repository, https://github.com/precice/adapter-schema
+Keywords: preCICE,adapter,validation,schema
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jsonschema>=4.0.0
+Requires-Dist: importlib-resources>=5.0.0; python_version < "3.9"
+Dynamic: license-file
+
+# preCICE Adapter Schema
+
+Here the adapter configuration schema is stored, together with validation utility.
+
+A schema ...
+
+- defines how a configuration file looks like (thus replaces any explicit documentation).
+- enables interoperability (through standardization).
+- simplifies auto-generation.
+- enables tooling support (e.g. IDEs or GUIs).
+- enables automatic LLM-based conversion from and to other configuration languages.
+- ...
+
+## Installation
+
+Install the package using pip:
+
+```bash
+pip install preciceadapterschema
+```
+
+For development, install in editable mode:
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+The `preciceadapterschema` package provides a `validate` function to validate preCICE adapter configurations against the JSON schema.
+
+```python
+import preciceadapterschema
+
+# Your configuration data
+config_data = {
+}
+
+# Validate the configuration
+try:
+    preciceadapterschema.validate(config_data)
+    print("Configuration is valid!")
+except Exception as e:
+    print(f"Validation failed: {e}")
+```
+
+The schema file (`precice_adapter_config.schema.json`) is included in the package and loaded automatically by the `validate` function.
+
+## Configuring preCICE Adapters
+
+We recommend using [MetaConfigurator](https://metaconfigurator.org/?schema=https://github.com/precice/adapter-schema/blob/main/preciceadapterschema/precice_adapter_config.schema.json&settings=https://github.com/precice/adapter-schema/blob/main/metaconfigurator_settings.json) to create and edit preCICE adapter configurations. It provides a user-friendly interface and ensures that your configurations are always valid according to the schema.
+
+## Development
+
+### Running Tests
+
+Run tests using unittest:
+
+```bash
+python -m unittest discover -s tests -v
+```

precice_adapter_schema-0.4.1/precice_adapter_schema.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+precice_adapter_schema.egg-info/PKG-INFO
+precice_adapter_schema.egg-info/SOURCES.txt
+precice_adapter_schema.egg-info/dependency_links.txt
+precice_adapter_schema.egg-info/requires.txt
+precice_adapter_schema.egg-info/top_level.txt
+preciceadapterschema/__init__.py
+preciceadapterschema/precice_adapter_config.schema.json
+preciceadapterschema/validate.py
+tests/test_validate.py

precice_adapter_schema-0.4.1/precice_adapter_schema.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

precice_adapter_schema-0.4.1/precice_adapter_schema.egg-info/requires.txt

@@ -0,0 +1,4 @@
+jsonschema>=4.0.0
+
+[:python_version < "3.9"]
+importlib-resources>=5.0.0

precice_adapter_schema-0.4.1/precice_adapter_schema.egg-info/top_level.txt

@@ -0,0 +1 @@
+preciceadapterschema

precice_adapter_schema-0.4.1/preciceadapterschema/__init__.py

@@ -0,0 +1,3 @@
+from preciceadapterschema.validate import validate
+
+__all__ = ["validate"]

precice_adapter_schema-0.4.1/preciceadapterschema/precice_adapter_config.schema.json

@@ -0,0 +1,211 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/precice/adapter-schema/releases/download/v0.4/precice_adapter_config_schema.json",
+  "type": "object",
+  "metaConfigurator": {
+    "aiExportFormats": {
+      "OpenFOAM": {
+        "url": "https://github.com/precice/adapter-schema/blob/main/export-formats/open-foam-example",
+        "description": "Export as an OpenFOAM preCICE Adapter Configuration."
+      },
+      "ISSM": {
+        "url": "https://github.com/precice/adapter-schema/blob/main/export-formats/issm-example.yaml",
+        "description": "Export as an ISSM preCICE Adapter Configuration in YAML."
+      }
+    }
+  },
+  "title": "preCICE Adapter Configuration Schema",
+  "description": "A JSON schema for configurations of adapters and tools within the preCICE ecosystem. Use the schema for validation and LLM-based auto-conversion to other configuration languages (e.g., OpenFOAM dictionary or YAML). The schema is developed as part of the preECO standardization, see https://precice.discourse.group/t/shape-the-future-of-the-precice-ecosystem-the-preeco-project/2019.",
+  "properties": {
+    "participant_name": {
+      "type": "string",
+      "description": "Name of the participant.",
+      "default": "Fluid",
+      "examples": [
+        "Fluid",
+        "Solid",
+        "Fluid-Left"
+      ],
+      "minLength": 1,
+      "pattern": "^[A-Z][a-zA-Z0-9-]*$"
+    },
+    "precice_config_file_path": {
+      "type": "string",
+      "description": "Path to the preCICE configuration file relative to the current working directory of the coupled solver.",
+      "default": "../precice-config.xml",
+      "minLength": 1,
+      "pattern": "^/?(?:\\.\\./)*([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*/)*[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\\.xml$"
+    },
+    "interfaces": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "mesh_name": {
+            "type": "string",
+            "description": "Name of the mesh associated with this interface.",
+            "default": "Fluid-Mesh",
+            "examples": [
+              "Fluid-Mesh",
+              "Solid-Mesh",
+              "Fluid-Upstream-Mesh",
+              "Fluid-Upstream-Mesh-Centers",
+              "Fluid-Upstream-Mesh-Nodes"
+            ],
+            "minLength": 6,
+            "pattern": "^[A-Z][a-zA-Z0-9]*(?:-[A-Z][a-zA-Z0-9]*)*-Mesh(?:-[A-Z][a-zA-Z0-9]*)*$"
+          },
+          "patches": {
+            "type": "array",
+            "description": "List of mesh or geometry patches (boundary or volume) to locate the interface.",
+            "items": {
+              "type": "string",
+              "minLength": 1
+            },
+            "minItems": 1
+          },
+          "location": {
+            "type": "string",
+            "description": "Further specification of mesh locations",
+            "minLength": 1,
+            "examples": [
+              "faceCenters",
+              "volumeCenters",
+              "faceNodes",
+              "nodes"
+            ]
+          },
+          "write_data": {
+            "type": "array",
+            "description": "List of data fields to be written to this mesh.",
+            "items": {
+              "$ref": "#/$defs/precice_data"
+            }
+          },
+          "read_data": {
+            "type": "array",
+            "description": "List of data fields to be read from this mesh.",
+            "items": {
+              "$ref": "#/$defs/precice_data"
+            }
+          },
+          "is_received": {
+            "type": "boolean",
+            "description": "Whether mesh is received from another participant for (direct) API access or not (i.e. provided)."
+          }
+        },
+        "required": [
+          "mesh_name"
+        ],
+        "if": {
+          "properties": {
+            "is_received": {
+              "const": true
+            }
+          }
+        },
+        "then": {
+          "not": {
+            "required": [
+              "location"
+            ]
+          }
+        }
+      },
+      "minItems": 1
+    }
+  },
+  "required": [
+    "participant_name",
+    "precice_config_file_path",
+    "interfaces"
+  ],
+  "additionalProperties": {
+    "title": "Solver settings",
+    "description": "Optional solver specific settings. We recommend calling the main object after the solver, e.g. 'mbdyn'",
+    "type": "object",
+    "examples": [
+      "mbdyn",
+      "issm",
+      "code_aster",
+      "tau"
+    ],
+    "additionalProperties": {
+      "title": "Solver parameter",
+      "oneOf": [
+        {
+          "title": "String property",
+          "description": "An optional string setting, such as the location of the solver configuration file.",
+          "type": "string",
+          "examples": [
+            "root_path",
+            "model_name",
+            "input_file_path",
+            "output_file_path"
+          ]
+        },
+        {
+          "title": "Number property",
+          "description": "An optional number setting, such as the write interval of the solver.",
+          "type": "number",
+          "examples": [
+            "write-interval",
+            "delay"
+          ]
+        }
+      ]
+    }
+  },
+  "$defs": {
+    "precice_data": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Name of the data as specified in the preCICE configuration.",
+          "default": "Force",
+          "examples": [
+            "Force",
+            "Displacement",
+            "Velocity",
+            "Temperature",
+            "Heat-Flux",
+            "Force1",
+            "Force-Left",
+            "Heat-Transfer-Coefficient",
+            "Sink-Temperature"
+          ],
+          "minLength": 1,
+          "pattern": "^[A-Z][a-zA-Z0-9]*(?:-[A-Za-z0-9]+)*$"
+        },
+        "solver_name": {
+          "type": "string",
+          "description": "Name of the data as used by the solver (optional).",
+          "examples": [
+            "temp",
+            "T"
+          ],
+          "minLength": 1
+        },
+        "operation": {
+          "type": "string",
+          "description": "Operation applied by the adapter on the data (optional).",
+          "examples": [
+            "value",
+            "gradient"
+          ],
+          "minLength": 1
+        },
+        "flip-normal": {
+          "type": "boolean",
+          "title": "Use a non-standard assumption for the direction of fluxes.",
+          "description": "Flip the direction of the normal vector for flux-type fields. Default assumption: written fields face outwards, read fields face inwards.",
+          "default": false
+        }
+      },
+      "required": [
+        "name"
+      ]
+    }
+  }
+}

precice_adapter_schema-0.4.1/preciceadapterschema/validate.py

@@ -0,0 +1,35 @@
+"""
+preCICE Adapter Schema Validation Package
+
+This package provides validation functionality for preCICE adapter configurations.
+"""
+
+import json
+import jsonschema
+from functools import cache
+from importlib.resources import files
+
+
+@cache
+def _load_schema():
+    """Load and cache the JSON schema."""
+    schema_text = files("preciceadapterschema").joinpath("precice_adapter_config.schema.json").read_text()
+    return json.loads(schema_text)
+
+
+def validate(instance):
+    """
+    Validate instance data against the preCICE adapter configuration schema.
+
+    Args:
+        instance: The configuration data to validate (dict or JSON-compatible object)
+
+    Raises:
+        jsonschema.exceptions.ValidationError: If the instance is invalid
+        jsonschema.exceptions.SchemaError: If the schema itself is invalid
+    """
+    schema = _load_schema()
+    jsonschema.validate(instance=instance, schema=schema)
+
+
+__all__ = ['validate']

precice_adapter_schema-0.4.1/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["setuptools>=45", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "precice-adapter-schema"
+version = "v0.4.1"
+description = "Validation utility for preCICE adapter configurations"
+readme = "README.md"
+requires-python = ">=3.10"
+authors = [
+    {name = "preCICE developers", email = "info@precice.org"}
+]
+keywords = ["preCICE", "adapter", "validation", "schema"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "jsonschema>=4.0.0",
+    "importlib-resources>=5.0.0; python_version < '3.9'",
+]
+
+[project.urls]
+Homepage = "https://github.com/precice/adapter-schema"
+Repository = "https://github.com/precice/adapter-schema"
+
+[tool.setuptools]
+packages = ["preciceadapterschema"]
+
+[tool.setuptools.package-data]
+preciceadapterschema = ["*.json"]
+
+[tool.setuptools-git-versioning]
+enabled = true

precice_adapter_schema-0.4.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

precice_adapter_schema-0.4.1/tests/test_validate.py

@@ -0,0 +1,74 @@
+"""
+Tests for the preciceadapterschema package.
+"""
+
+import unittest
+import json
+import os
+
+try:
+    from importlib.resources import files
+except ImportError:
+    from importlib_resources import files
+
+import preciceadapterschema
+
+
+class TestValidateFunction(unittest.TestCase):
+    """Tests for the validate function."""
+
+    def test_schema_file_accessible_via_importlib(self):
+        """Test that the schema file is accessible via importlib.resources."""
+        try:
+            schema_text = files("preciceadapterschema").joinpath("precice_adapter_config.schema.json").read_text()
+            schema = json.loads(schema_text)
+            self.assertIsInstance(schema, dict, "Schema should be a dictionary")
+        except Exception as e:
+            self.fail(f"Failed to load schema via importlib.resources: {e}")
+
+
+    def test_schema_for_valid_config(self):
+        """Test that the validation function succeeds for a valid config."""
+        valid_config_path = os.path.join(os.path.dirname(__file__), "configs", "valid_config.json")
+        with open(valid_config_path, "r") as f:
+            valid_config = json.load(f)
+        try:
+            preciceadapterschema.validate(valid_config)
+        except Exception as e:
+            self.fail(f"Validation failed for valid config: {e}")
+
+
+
+    def test_schema_for_empty_config(self):
+        """Test that the validation function fails for an empty config.
+        As the schema requires certain fields, an empty config is invalid and should raise an exception."""
+        empty_config_path = os.path.join(os.path.dirname(__file__), "configs", "empty_config.json")
+        with open(empty_config_path, "r") as f:
+            empty_config = json.load(f)
+        try:
+            preciceadapterschema.validate(empty_config)
+            # If we reach this point, the validation did not raise an exception as expected
+            self.fail("Validation did not fail for empty config as expected")
+        except Exception as e:
+            # We expect an exception, so this is a success case
+            pass
+
+
+    def test_schema_for_invalid_config(self):
+        """Test that the validation function fails for a invalid config."""
+        invalid_config_path = os.path.join(os.path.dirname(__file__), "configs", "invalid_config.json")
+        with open(invalid_config_path, "r") as f:
+            invalid_config = json.load(f)
+        try:
+            preciceadapterschema.validate(invalid_config)
+            # If we reach this point, the validation did not raise an exception as expected
+            self.fail("Validation did not fail for invalid config as expected")
+        except Exception as e:
+            # We expect an exception, so this is a success case
+            pass
+
+
+
+
+if __name__ == '__main__':
+    unittest.main()