1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
================
Visualizations
================
Installation
============
To create state machine graphs you must install `automat` with the graphing dependencies.
.. code-block:: bash
pip install automat[visualize]
To generate images, you will also need to install `Graphviz
<https://graphviz.org>`_ for your platform, such as with ``brew install
graphviz`` on macOS or ``apt install graphviz`` on Ubuntu.
Example
=======
If we put the garage door example from the tutorial into a file called ``garage_door.py``,
You can generate a state machine visualization by running:
.. code-block:: bash
$ automat-visualize garage_door
garage_door.machineFactory ...discovered
garage_door.machineFactory ...wrote image and dot into .automat_visualize
The `dot` file and `png` will be saved in the default output directory, to the
file ``.automat_visualize/garage_door.machineFactory.dot.png`` .
.. image:: _static/garage_door.machineFactory.dot.png
:alt: garage door state machine
``automat-visualize`` help
==========================
.. code-block:: bash
$ automat-visualize -h
usage: /home/tom/Envs/tmp-72fe664d2dc5cbf/bin/automat-visualize
[-h] [--quiet] [--dot-directory DOT_DIRECTORY]
[--image-directory IMAGE_DIRECTORY]
[--image-type {gv,vml,dot_json,imap_np,pov,tiff,pic,canon,jpg,ismap,sgi,webp,gd,json0,ps2,cmapx_np,plain-ext,wbmp,xdot_json,ps,cgimage,ico,gtk,pct,gif,json,fig,xlib,xdot1.2,tif,tk,xdot1.4,svgz,gd2,jpe,psd,xdot,bmp,jpeg,x11,cmapx,jp2,imap,png,tga,pict,plain,eps,vmlz,cmap,exr,svg,pdf,vrml,dot}]
[--view]
fqpn
Visualize automat.MethodicalMachines as graphviz graphs.
positional arguments:
fqpn A Fully Qualified Path name representing where to find
machines.
optional arguments:
-h, --help show this help message and exit
--quiet, -q suppress output
--dot-directory DOT_DIRECTORY, -d DOT_DIRECTORY
Where to write out .dot files.
--image-directory IMAGE_DIRECTORY, -i IMAGE_DIRECTORY
Where to write out image files.
--image-type {gv,vml,dot_json,imap_np,pov,tiff,pic,canon,jpg,ismap,sgi,webp,gd,json0,ps2,cmapx_np,plain-ext,wbmp,xdot_json,ps,cgimage,ico,gtk,pct,gif,json,fig,xlib,xdot1.2,tif,tk,xdot1.4,svgz,gd2,jpe,psd,xdot,bmp,jpeg,x11,cmapx,jp2,imap,png,tga,pict,plain,eps,vmlz,cmap,exr,svg,pdf,vrml,dot}, -t {gv,vml,dot_json,imap_np,pov,tiff,pic,canon,jpg,ismap,sgi,webp,gd,json0,ps2,cmapx_np,plain-ext,wbmp,xdot_json,ps,cgimage,ico,gtk,pct,gif,json,fig,xlib,xdot1.2,tif,tk,xdot1.4,svgz,gd2,jpe,psd,xdot,bmp,jpeg,x11,cmapx,jp2,imap,png,tga,pict,plain,eps,vmlz,cmap,exr,svg,pdf,vrml,dot}
The image format.
--view, -v View rendered graphs with default image viewer
You must have the graphviz tool suite installed. Please visit
http://www.graphviz.org for more information.
|
