[](https://github.com/DaanVanVugt/ymmsl-dot/actions?workflow=ci)
[](https://codecov.io/gh/DaanVanVugt/ymmsl-dot)
<!--[](https://ymmsl-dot.readthedocs.io/en/latest/index.html) -->
# yMMSL plotting tool
A tool to visualise yMMSL files using `graphviz` and `ymmsl-python`.
# Examples
Two examples are shown here, a simple one [macro_micro](https://github.com/DaanVanVugt/ymmsl-dot/blob/0.1.2/docs/examples/macro_micro.ymmsl), and a more complex one [complex](https://github.com/DaanVanVugt/ymmsl-dot/blob/0.1.2/docs/examples/complex.ymmsl).
## Default
## Explicit ports, simple arrows, legend (`-p -s -l`)
# Usage (`ymmsl graph --help`)
Usage: ymmsl graph [OPTIONS] YMMSL_FILES...
Plot a graphical representation of the passed yMMSL files.
To help develop or understand about a coupled simulation it may be useful to
view a graphical representation.
If multiple yMMSL files are given, then they will be combined left to right,
i.e. if there are conflicting declarations, the one from the file last given
is used.
Result:
A graph is displayed or saved to disk, containing all the defined
components and the connections between them.
Examples:
ymmsl graph simulation.ymmsl
Options:
-o, --out FILE Output file (default ./output.format)
-f, --fmt [canon|cmap|cmapx|cmapx_np|dia|dot|fig|gd|gd2|gif|hpgl|imap|imap_np|ismap|jpe|jpeg|jpg|mif|mp|pcl|pdf|pic|plain|plain-ext|png|ps|ps2|svg|svgz|vml|vmlz|vrml|vtx|wbmp|xdot|xlib]
Set output format (default svg).
-w, --viewer TEXT Open with specified viewer (try xdg-open)
-v, --verbose Show more info (prints the generated dot
syntax)
-p, --ports Explicitly draw component ports.
-l, --legend Show a legend (only with --ports).
-s, --simple-edges Only indicate conduit direction, not port
types.
--portlabels Never simplify matching port labels along an
edge.
-h, --hide-edge-labels Hide edge labels (as long as the input and
output port match).
--help Show this message and exit.
# Issues and Discussions
As usual for any GitHub-based project, raise an
[issue](https://github.com/DaanVanVugt/ymmsl-dot/issues) if you find any
bug or want to suggest an improvement, or open a
[discussion](https://github.com/DaanVanVugt/ymmsl-dot/discussions) if
you want to discuss.
# Generated documentation
There is a `docs/` folder containing sphinx documentation, but this has not yet been filled completely.
Build it with
```bash
sphinx-build docs html
```
Raw data
{
"_id": null,
"home_page": "https://github.com/DaanVanVugt/ymmsl-dot",
"name": "ymmsl-dot",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7, <4",
"maintainer_email": "",
"keywords": "ymmsl,simulation,graphviz,dot,muscle3,yMMSL,multiscale",
"author": "Daan van Vugt",
"author_email": "dvanvugt@ignitioncomputing.com",
"download_url": "https://files.pythonhosted.org/packages/f7/be/eb0f1a382ed8487a95f3e65ad5442535f44dc2a7ba359902cf91e160fcf3/ymmsl-dot-0.1.2.tar.gz",
"platform": null,
"description": "[](https://github.com/DaanVanVugt/ymmsl-dot/actions?workflow=ci)\n\n[](https://codecov.io/gh/DaanVanVugt/ymmsl-dot)\n\n<!--[](https://ymmsl-dot.readthedocs.io/en/latest/index.html) -->\n\n# yMMSL plotting tool\n\nA tool to visualise yMMSL files using `graphviz` and `ymmsl-python`.\n\n# Examples\nTwo examples are shown here, a simple one [macro_micro](https://github.com/DaanVanVugt/ymmsl-dot/blob/0.1.2/docs/examples/macro_micro.ymmsl), and a more complex one [complex](https://github.com/DaanVanVugt/ymmsl-dot/blob/0.1.2/docs/examples/complex.ymmsl).\n\n## Default\n\n\n## Explicit ports, simple arrows, legend (`-p -s -l`)\n\n\n\n# Usage (`ymmsl graph --help`)\n\n Usage: ymmsl graph [OPTIONS] YMMSL_FILES...\n\n Plot a graphical representation of the passed yMMSL files.\n\n To help develop or understand about a coupled simulation it may be useful to\n view a graphical representation.\n\n If multiple yMMSL files are given, then they will be combined left to right,\n i.e. if there are conflicting declarations, the one from the file last given\n is used.\n\n Result:\n\n A graph is displayed or saved to disk, containing all the defined\n components and the connections between them.\n\n Examples:\n\n ymmsl graph simulation.ymmsl\n\n Options:\n -o, --out FILE Output file (default ./output.format)\n -f, --fmt [canon|cmap|cmapx|cmapx_np|dia|dot|fig|gd|gd2|gif|hpgl|imap|imap_np|ismap|jpe|jpeg|jpg|mif|mp|pcl|pdf|pic|plain|plain-ext|png|ps|ps2|svg|svgz|vml|vmlz|vrml|vtx|wbmp|xdot|xlib]\n Set output format (default svg).\n -w, --viewer TEXT Open with specified viewer (try xdg-open)\n -v, --verbose Show more info (prints the generated dot\n syntax)\n -p, --ports Explicitly draw component ports.\n -l, --legend Show a legend (only with --ports).\n -s, --simple-edges Only indicate conduit direction, not port\n types.\n --portlabels Never simplify matching port labels along an\n edge.\n -h, --hide-edge-labels Hide edge labels (as long as the input and\n output port match).\n --help Show this message and exit.\n\n# Issues and Discussions\n\nAs usual for any GitHub-based project, raise an\n[issue](https://github.com/DaanVanVugt/ymmsl-dot/issues) if you find any\nbug or want to suggest an improvement, or open a\n[discussion](https://github.com/DaanVanVugt/ymmsl-dot/discussions) if\nyou want to discuss.\n\n# Generated documentation\n\nThere is a `docs/` folder containing sphinx documentation, but this has not yet been filled completely.\nBuild it with\n```bash\nsphinx-build docs html\n```\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Visualise yMMSL models with graphviz.",
"version": "0.1.2",
"split_keywords": [
"ymmsl",
"simulation",
"graphviz",
"dot",
"muscle3",
"ymmsl",
"multiscale"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7350947483ed0905eae5bb57368c5fb04aab178daf466421f461cf1f3cd73a92",
"md5": "da1ff778c95ffd9ccd887331577af0d2",
"sha256": "543e64ccec17cb558f7bc543c24b68937b508aa110e9203c23be520bc9b91d7f"
},
"downloads": -1,
"filename": "ymmsl_dot-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "da1ff778c95ffd9ccd887331577af0d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7, <4",
"size": 11845,
"upload_time": "2023-04-21T09:11:23",
"upload_time_iso_8601": "2023-04-21T09:11:23.682854Z",
"url": "https://files.pythonhosted.org/packages/73/50/947483ed0905eae5bb57368c5fb04aab178daf466421f461cf1f3cd73a92/ymmsl_dot-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f7beeb0f1a382ed8487a95f3e65ad5442535f44dc2a7ba359902cf91e160fcf3",
"md5": "65ae5016c20f4a1efb223abb7f0ade30",
"sha256": "c87b089f611aa96bc8e17d959e38c4aab6ff1e528b6a628ff1a545b8f6344d4a"
},
"downloads": -1,
"filename": "ymmsl-dot-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "65ae5016c20f4a1efb223abb7f0ade30",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7, <4",
"size": 15689,
"upload_time": "2023-04-21T09:11:25",
"upload_time_iso_8601": "2023-04-21T09:11:25.195246Z",
"url": "https://files.pythonhosted.org/packages/f7/be/eb0f1a382ed8487a95f3e65ad5442535f44dc2a7ba359902cf91e160fcf3/ymmsl-dot-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-21 09:11:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "DaanVanVugt",
"github_project": "ymmsl-dot",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "ymmsl-dot"
}
JSON
