{"id":29430272,"url":"https://github.com/precice/config-check","last_synced_at":"2025-07-12T17:06:24.683Z","repository":{"id":300197759,"uuid":"1005474040","full_name":"precice/config-check","owner":"precice","description":"Python tool that checks a preCICE configuration file for logical errors.","archived":false,"fork":false,"pushed_at":"2025-07-01T11:41:09.000Z","size":514,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-01T12:33:52.692Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/precice.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"custom":"https://precice.org/community-support-precice"}},"created_at":"2025-06-20T09:31:55.000Z","updated_at":"2025-07-01T11:41:13.000Z","dependencies_parsed_at":"2025-06-20T11:35:26.356Z","dependency_job_id":null,"html_url":"https://github.com/precice/config-check","commit_stats":null,"previous_names":["precice/config-check"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/precice/config-check","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/precice%2Fconfig-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/precice%2Fconfig-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/precice%2Fconfig-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/precice%2Fconfig-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/precice","download_url":"https://codeload.github.com/precice/config-check/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/precice%2Fconfig-check/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265024860,"owners_count":23699621,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-12T17:06:23.033Z","updated_at":"2025-07-12T17:06:24.675Z","avatar_url":"https://github.com/precice.png","language":"Python","funding_links":["https://precice.org/community-support-precice"],"categories":[],"sub_categories":[],"readme":"# preCICE Config Checker\n\nA library that checks a preCICE configuration file for logical errors.\n\n**How does this differ from [precice-tools check](https://precice.org/tooling-builtin.html)?** This checker only checks the\nconfiguration for logical errors.\n\n\u003e [!NOTE]\n\u003e This checker assumes that `precice-tools check` has already been executed without an error on the configuration file.\u003cbr\u003e\n\u003e Otherwise, the behavior of this checker is undefined.\n\n## Requirements\n\n- Python 3.10\n- Pip\n- Git for cloning the repository\n- [precice-config-graph Library](https://github.com/precice/config-graph). This will be installed during the Installation step below.\n\n## Installation\n\n1. Clone this repository:\n```bash\ngit clone https://github.com/precice/config-check\ncd config-check\n```\n2. Create a new Python Virtual Environment (optional, but recommended):\n```bash\npython -m venv venv\nsource venv/bin/activate  # On Windows, use `venv\\Scripts\\activate`\n```\n3. Install required dependencies:\n```bash\npip install .\n```\nYou need to force re-install the `precice_config_graph`-dependency on new versions, since it is downloaded directly from GitHub. To do so, run:\n```bash\npip install --ignore-installed .\n```\n\n## Project Structure\n\n```\nconfig-check\n├── .github, .idea, etc…\n│\n├── docs                       # Documentation on rules and the inner workings of this checker\n│   └── ...\n│\n├── preciceconfigcheck         # Main library files\n│   ├── rules                  # All rules that are checked by this utility\n│   │   ├── ...\n│   │   └── examples           # Exemplary implementations of rules to test output format\n│   │       └── ...\n│   │\n│   ├── tests                  # Configuration files to test rules\n│   │   └── ...\n│   │\n│   ├── cli.py                 # Main entrypoint for this checker\n│   ├── color.py               # Definition of colors for CLI output\n│   ├── rule.py                # Class of a rule and logic to check all rules\n│   ├── rules_processing.py    # Processes rules and handles output\n│   ├── rules_utils.py         # Utility functions for rules\n│   ├── severity.py            # Enum for specifying severity of output\n│   └── violation.py           # Class of a violation\n│\n│\n├── .gitignore, LICENSE, README.md\n│\n├── pyproject.toml             # Project configuration (dependencies etc.)\n└── shell.nix                  # Dependencies for anyone using NixOS / the nix-package manager. Should be replaced by a flake in the future.\n```\n\n## Checking a preCICE config\n\nTo check a preCICE configuration file for logical errors, run the following within the root of this repository:\n\n```bash\npython -m preciceconfigcheck.cli \"path/to/precice-config.xml\"\n```\n\nIf you want more information about the checks that were performed and their results, use\n\n```bash\npython -m preciceconfigcheck.cli \"path/to/precice-config.xml\" --debug\n```\n\n## Suggesting new Rules\n\nWe are always open to suggestions for new rules.\nWhen encountering a logical error that does not already get reviewed by our checker,\nplease create a new issue on our [GitHub repository](https://github.com/precice/config-check) and:\n\n- Check that the problem is not already under development (marked with `TODO` in [docs/Rules.md](https://github.com/precice/config-check/blob/main/docs/Rules.md))\n- Explain the problem:\n    - What exactly is the problem?\n    - Why is it a problem?\n    - Are there cases when this setup is valid?\n    - Please also provide a `precice-config.xml`file with the error you described and one with a fix of how it should be\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprecice%2Fconfig-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprecice%2Fconfig-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprecice%2Fconfig-check/lists"}