# preCICE Config-Visualizer GUI
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.
This GUI offers an interactive way to quickly inspect, explore and study preCICE configuration files.
## Installation options
Install directly from PyPi using [pipx](https://pipx.pypa.io/stable/) or via pip:
```
pipx install precice-config-visualizer-gui
```
## Usage
```
precice-config-visualizer-gui [CONFIG-FILE]
```
You can launch the GUI directly from the command line.
Passing the path to a configuration file is optional.
All further adjustments are made directly in the GUI.
## System integration
Until existing tools provide an automatic way to integrate applications into the system, this has to be done manually.
For pipx users, run the following command [which downloads this file](https://gist.githubusercontent.com/fsimonis/a08c3771abf808b0534d658bcb563f90/raw/10717f5b2afbf2d3c05ecb9f5c7eeaae4bbe868a/org.precice.configvisualizer.desktop)
```console
mkdir -p ~/.local/share/applications && wget -O ~/.local/share/applications/org.precice.configvisualizer.desktop https://gist.githubusercontent.com/fsimonis/a08c3771abf808b0534d658bcb563f90/raw/10717f5b2afbf2d3c05ecb9f5c7eeaae4bbe868a/org.precice.configvisualizer.desktop
```
You may have to logout and login for your desktop environment to detect the file.
Now you can open XML files directly with the config-visualizer and see the application in your launcher.
Raw data
{
"_id": null,
"home_page": null,
"name": "precice-config-visualizer-gui",
"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, interactive, configuration, visualization",
"author": null,
"author_email": "The preCICE Developers <info@precice.org>",
"download_url": "https://files.pythonhosted.org/packages/01/e8/df9f81c7b1f4490414c4510c66ad0151360ee4c9c0d7898deb3cd03fe467/precice_config_visualizer_gui-0.2.0.tar.gz",
"platform": null,
"description": "# preCICE Config-Visualizer GUI\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.\nThis GUI offers an interactive way to quickly inspect, explore and study preCICE configuration files.\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-gui\n```\n\n## Usage\n\n```\nprecice-config-visualizer-gui [CONFIG-FILE]\n```\n\nYou can launch the GUI directly from the command line.\nPassing the path to a configuration file is optional.\nAll further adjustments are made directly in the GUI.\n\n## System integration\n\nUntil existing tools provide an automatic way to integrate applications into the system, this has to be done manually.\n\nFor pipx users, run the following command [which downloads this file](https://gist.githubusercontent.com/fsimonis/a08c3771abf808b0534d658bcb563f90/raw/10717f5b2afbf2d3c05ecb9f5c7eeaae4bbe868a/org.precice.configvisualizer.desktop)\n\n```console\nmkdir -p ~/.local/share/applications && wget -O ~/.local/share/applications/org.precice.configvisualizer.desktop https://gist.githubusercontent.com/fsimonis/a08c3771abf808b0534d658bcb563f90/raw/10717f5b2afbf2d3c05ecb9f5c7eeaae4bbe868a/org.precice.configvisualizer.desktop\n```\n\nYou may have to logout and login for your desktop environment to detect the file.\nNow you can open XML files directly with the config-visualizer and see the application in your launcher.\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "A GUI tool for visualizing a preCICE configuration file as a dot file.",
"version": "0.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/precice/config-visualizer-gui/issues",
"Documentation": "https://precice.org/tooling-config-visualization.html",
"Homepage": "https://precice.org",
"Repository": "https://github.com/precice/config-visualizer-gui.git"
},
"split_keywords": [
"precice",
" dot",
" graphviz",
" xml",
" interactive",
" configuration",
" visualization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f2b3bdcdf3371505822f51e4ccf81eb7f9634f88cb974b96de437c1f75e00909",
"md5": "f059511b615d603356ed2fa0d594114f",
"sha256": "1857a94e57f764846f8467a1dd718e5fdacc797a942a5b41b44a5b25e9e41a43"
},
"downloads": -1,
"filename": "precice_config_visualizer_gui-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f059511b615d603356ed2fa0d594114f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 23973,
"upload_time": "2024-09-03T10:13:10",
"upload_time_iso_8601": "2024-09-03T10:13:10.936668Z",
"url": "https://files.pythonhosted.org/packages/f2/b3/bdcdf3371505822f51e4ccf81eb7f9634f88cb974b96de437c1f75e00909/precice_config_visualizer_gui-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "01e8df9f81c7b1f4490414c4510c66ad0151360ee4c9c0d7898deb3cd03fe467",
"md5": "fe5700d218f63fb4291284e24ccfbbc4",
"sha256": "bd77aaa1b025ae1220cd0d17bc795b401a2c7b441f961e028d5e530626980cab"
},
"downloads": -1,
"filename": "precice_config_visualizer_gui-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "fe5700d218f63fb4291284e24ccfbbc4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 22506,
"upload_time": "2024-09-03T10:13:12",
"upload_time_iso_8601": "2024-09-03T10:13:12.414888Z",
"url": "https://files.pythonhosted.org/packages/01/e8/df9f81c7b1f4490414c4510c66ad0151360ee4c9c0d7898deb3cd03fe467/precice_config_visualizer_gui-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-03 10:13:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "precice",
"github_project": "config-visualizer-gui",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "precice-config-visualizer-gui"
}
JSON
