# preCICE Config-Visualizer
The `config-visualizer` is a tool meant to help visualize and debug precice configuration xml files. This tool produces a dot file as output, which visualizes the various participants, communicators and meshes defined in the configuration file and the movement of data between them.
## Installation options
Install directly from PyPi using [pipx](https://pipx.pypa.io/stable/) or via pip:
```
pipx install precice-config-visualizer
```
To also install [the GUI](https://pypi.org/project/precice-config-visualizer-gui/), run:
```
pipx install 'precice-config-visualizer[gui]'
```
## Usage
```
precice-config-visualizer --help
precice-config-visualizer [OPTIONS] [-o OUTFILE] [<CONFIG-FILE>]
```
The command line version of the tool transforms the XML configuration file into a dot graph and either outputs it to the terminal or writes it to a file.
If the extension of the output file is `.png`, `.pdf`, `.svg`, or `.jpg`, then the tool will render the output using `graghviz`.
The dot output is especially useful if the output needs to be altered for various reasons.
To edit the dot version of the graph, displaying it using a dot viewer such as [xdot](https://pypi.org/project/xdot/) can be helpful.
The tool reads from stdin if no configuration file is given as an argument and the output is printed to stdout if no output filename if specified using the `-o` option.
To generate `graph.dot` from `precice-config.xml` use:
```
precice-config-visualizer precice-config.xml > graph.dot
precice-config-visualizer -o graph.dot precice-config.xml
```
To generate an image from `precice-config.xml` use:
```
precice-config-visualizer -o graph.png precice-config.xml
precice-config-visualizer -o graph.pdf precice-config.xml
precice-config-visualizer -o graph.svg precice-config.xml
```
To modify the dot graph from `precice-config.xml` yourself use:
```
precice-config-visualizer precice-config.xml > graph.dot
# Edit graph.dot here
dot -Tpdf -o graph.pdf graph.dot
```
Further options can be used to control the output appearance. Some information can be turned off or merged.
For a full list of options, run:
```
precice-config-visualizer --help
```
Raw data
{
"_id": null,
"home_page": null,
"name": "precice-config-visualizer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Fr\u00e9d\u00e9ric Simonis <frederic.simonis@ipvs.uni-stuttgart.de>",
"keywords": "preCICE, dot, graphviz, XML, configuration, visualization",
"author": null,
"author_email": "The preCICE Developers <info@precice.org>",
"download_url": "https://files.pythonhosted.org/packages/39/f3/a4004ea627edf808643efc191d40354068c8dc4747c9080b8610d558a6c8/precice_config_visualizer-1.1.3.tar.gz",
"platform": null,
"description": "# preCICE Config-Visualizer\n\nThe `config-visualizer` is a tool meant to help visualize and debug precice configuration xml files. This tool produces a dot file as output, which visualizes the various participants, communicators and meshes defined in the configuration file and the movement of data between them.\n\n## Installation options\n\nInstall directly from PyPi using [pipx](https://pipx.pypa.io/stable/) or via pip:\n\n```\npipx install precice-config-visualizer\n```\n\nTo also install [the GUI](https://pypi.org/project/precice-config-visualizer-gui/), run:\n\n```\npipx install 'precice-config-visualizer[gui]'\n```\n\n## Usage\n\n```\nprecice-config-visualizer --help\nprecice-config-visualizer [OPTIONS] [-o OUTFILE] [<CONFIG-FILE>]\n```\n\nThe command line version of the tool transforms the XML configuration file into a dot graph and either outputs it to the terminal or writes it to a file.\nIf the extension of the output file is `.png`, `.pdf`, `.svg`, or `.jpg`, then the tool will render the output using `graghviz`.\nThe dot output is especially useful if the output needs to be altered for various reasons.\nTo edit the dot version of the graph, displaying it using a dot viewer such as [xdot](https://pypi.org/project/xdot/) can be helpful.\n\nThe tool reads from stdin if no configuration file is given as an argument and the output is printed to stdout if no output filename if specified using the `-o` option.\n\nTo generate `graph.dot` from `precice-config.xml` use:\n\n```\nprecice-config-visualizer precice-config.xml > graph.dot\nprecice-config-visualizer -o graph.dot precice-config.xml\n```\n\nTo generate an image from `precice-config.xml` use:\n\n```\nprecice-config-visualizer -o graph.png precice-config.xml\nprecice-config-visualizer -o graph.pdf precice-config.xml\nprecice-config-visualizer -o graph.svg precice-config.xml\n```\n\nTo modify the dot graph from `precice-config.xml` yourself use:\n\n```\nprecice-config-visualizer precice-config.xml > graph.dot\n# Edit graph.dot here\ndot -Tpdf -o graph.pdf graph.dot\n```\n\nFurther options can be used to control the output appearance. Some information can be turned off or merged.\nFor a full list of options, run:\n\n```\nprecice-config-visualizer --help\n```\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "A tool for visualizing a preCICE configuration file as a dot file.",
"version": "1.1.3",
"project_urls": {
"Bug Tracker": "https://github.com/precice/config-visualizer/issues",
"Documentation": "https://precice.org/tooling-config-visualization.html",
"Homepage": "https://precice.org",
"Repository": "https://github.com/precice/config-visualizer.git"
},
"split_keywords": [
"precice",
" dot",
" graphviz",
" xml",
" configuration",
" visualization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5d21d335d7e0c994fe9e8f564f20af34e28b8058b013e89d985e9d19d84f708a",
"md5": "8334c10eaa91a86ca2e146f2542e638d",
"sha256": "ef12cdc47b7cbc289bf71b0f02816e66d5dc2229b7c49682a415e5094ee86995"
},
"downloads": -1,
"filename": "precice_config_visualizer-1.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8334c10eaa91a86ca2e146f2542e638d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 19785,
"upload_time": "2024-04-17T08:44:59",
"upload_time_iso_8601": "2024-04-17T08:44:59.588510Z",
"url": "https://files.pythonhosted.org/packages/5d/21/d335d7e0c994fe9e8f564f20af34e28b8058b013e89d985e9d19d84f708a/precice_config_visualizer-1.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "39f3a4004ea627edf808643efc191d40354068c8dc4747c9080b8610d558a6c8",
"md5": "b4f2ef8ef76145953bbc78c7dbf6390c",
"sha256": "4818312354fe3adf9bf787828f46550bfd88452527b109167002f485f3a878fc"
},
"downloads": -1,
"filename": "precice_config_visualizer-1.1.3.tar.gz",
"has_sig": false,
"md5_digest": "b4f2ef8ef76145953bbc78c7dbf6390c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 19470,
"upload_time": "2024-04-17T08:45:01",
"upload_time_iso_8601": "2024-04-17T08:45:01.896194Z",
"url": "https://files.pythonhosted.org/packages/39/f3/a4004ea627edf808643efc191d40354068c8dc4747c9080b8610d558a6c8/precice_config_visualizer-1.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-17 08:45:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "precice",
"github_project": "config-visualizer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "precice-config-visualizer"
}
JSON
