A tool for visualizing a preCICE configuration file as a dot file.
Project description
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 or via pip:
pipx install precice-config-visualizer
Usage
The config visualizer can be use via the CLI or the interactive GUI.
GUI
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.
CLI
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 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file precice-config-visualizer-0.3.0.tar.gz
.
File metadata
- Download URL: precice-config-visualizer-0.3.0.tar.gz
- Upload date:
- Size: 25.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5e8f4c7da9b202a1a99e5d292693622305837b60553d8e00dbd967c69f92c130 |
|
MD5 | 4f4f271fef5209acf23b40925e871b1e |
|
BLAKE2b-256 | 22621bafeb7c429d276cb33e6998875124d9ed40db07a4efb7b68ed236f2d078 |
File details
Details for the file precice_config_visualizer-0.3.0-py3-none-any.whl
.
File metadata
- Download URL: precice_config_visualizer-0.3.0-py3-none-any.whl
- Upload date:
- Size: 27.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f016e890194babc71e551dff7b4a29fe46d4b55700aeee853c3bd31d98973cd3 |
|
MD5 | 82ea25f3660eb8651f6e4cd38ecb2142 |
|
BLAKE2b-256 | 6196fc2e60578db6282659c69079ec81e37a578b4734fcb3a5b84ef5b91ff2b8 |