comparison m-toolbox/html_help/help/ug/additional_progs_content.html @ 0:f0afece42f48

Import.
author Daniele Nicolodi <nicolodi@science.unitn.it>
date Wed, 23 Nov 2011 19:22:13 +0100
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:f0afece42f48
1 <p>
2 Some features of the LTPDA Toolbox require additional 3rd-party software to be installed. These are listed below.
3 </p>
4 <p>
5 <hr>
6 <h2>Graphviz</h2>
7
8 <p>In order to use the commands listed below, the <a href="matlab:web('http://www.graphviz.org/')">Graphviz</a> package must be installed.</p>
9
10 <p>
11 <table cellspacing="0" class="body" cellpadding="4" border="2">
12 <colgroup>
13 <col width="37%"/>
14 <col width="63%"/>
15 </colgroup>
16 <thead>
17 <tr valign="top">
18 <th bgcolor="#B2B2B2">Method</th>
19 <th bgcolor="#B2B2B2">Description</th>
20 </tr>
21 </thead>
22 <tbody>
23
24 <!-- history/dotview -->
25 <tr valign="top">
26 <td bgcolor="#F2F2F2">
27 <p><tt>history/dotview</tt></p>
28 </td>
29 <td bgcolor="#F2F2F2">
30 <p>Convert a history object to a tree-diagram using the DOT interpreter.</p>
31 </td>
32 </tr>
33
34 <!-- ssm/dotview -->
35 <tr valign="top">
36 <td bgcolor="#F2F2F2">
37 <p><tt>ssm/dotview</tt></p>
38 </td>
39 <td bgcolor="#F2F2F2">
40 <p>Convert the statespace model object to a block-diagram using the DOT interpreter.</p>
41 </td>
42 </tr>
43
44 <!-- report -->
45 <tr valign="top">
46 <td bgcolor="#F2F2F2">
47 <p><tt>report</tt></p>
48 </td>
49 <td bgcolor="#F2F2F2">
50 <p>Generates a HTML report about the input objects which includes a DOT block-diagram of the history.</p>
51 </td>
52 </tr>
53
54 </tbody>
55 </table>
56 </p>
57
58 <p>The following installation guidelines can be used for different platforms</p>
59 <ul>
60 <li><p><a href="#windows"/>Installation Guide for Windows</p></li>
61 <li><p><a href="#mac"/>Installation Guide for Mac OS X</p></li>
62 <li><p><a href="#linux"/>Installation Guide for Linux</p></li>
63 </ul>
64
65 <h3><a name="windows"/> Windows </h3>
66
67 <p>
68 <ol>
69 <li><p>Download the relevant package from Downloads section of <a href="matlab:web('http://www.graphviz.org/')">www.graphviz.org</a>.</p></li>
70 <li><p>Install the package by following the relevant instructions.</p></li>
71 <li><p>Set the two relevant preferences with your LTPDA Preferences Panel</p></li>
72 <ol>
73 <li>For this start the LTPDApres<br />
74 <br />
75 <table cellspacing="0" class="note" summary="Note" cellpadding="5" border="1">
76 <tr width="90%">
77 <td>>> LTPDAprefs
78 </td>
79 </tr>
80 </table>
81 <br />
82 </li>
83 <li>or press the "LTPDA Preferences" button on the LTPDA Launch Bay<br />
84 <br></br>
85 <img src="images/LTPDAlauncher.png" alt="Interpolate" border="0"></img>
86 <br />
87 <br />
88 </li>
89 <li style="margin-top:1ex">Select on your LTPDA Preferences Panel the category "External Programs"<br />
90 <br />
91 <img src="images/LTPDAprefs_ExtProg.png" alt="Interpolate" border="0"></img> <br />
92 <br />
93 </li>
94 <li style="margin-top:1ex">Set the path to the 'dot.exe' binary in the editable text field "DOT binary". If you perform the default installation, this should be something like:
95 <br>'c:\Program Files\Graphviz2.20\bin\dot.exe';</br>
96 </li>
97 <li>Define in the editable text field "DOT format" the graphics format to output. See <a href="matlab:web('http://www.graphviz.org/doc/info/output.html')">formats</a> for available formats. To view the final graphics file you must have a suitable viewer for that graphics format installed on the system. For example, to output as PDF
98 </li>
99 </ol>
100 </ol>
101 </p>
102
103 <h3><a name="mac"/> Mac OS X </h3>
104 <p>
105 <ol>
106 <li>Choose from:</li>
107 <ol>
108 <li> From graphviz:</li>
109 <ul>
110 <li>Download the relevant package from Downloads section of <a href="matlab:web('http://www.graphviz.org/')">www.graphviz.org</a>.</li>
111 <li>Install the package by following the relevant instructions.</li>
112 </ul>
113 <li> From Fink:</li>
114 <ul>
115 <li> If you use the fink package manager, in a terminal: <tt>> fink install graphviz</tt></li>
116 </ul>
117 </ol>
118 <li>Set the two relevant preferences with your LTPDA Preferences Panel.</li>
119 <ol>
120 <li>Start the LTPDA Preferences Panel. For this follow the step 3.1 or 3.2 of the window installation.</li>
121 <li>Set the path to the 'dot' binary in the editable text field "DOT binary". If you perform the default installation from fink, this should be something like:
122 <br>'/sw/bin/dot'</br>
123 </li>
124 <li>Define in the editable text field "DOT format" the graphics format to output. See <a href="matlab:web('http://www.graphviz.org/doc/info/output.html')">formats</a> for available formats. To view the final graphics file you must have a suitable viewer for that graphics format installed on the system. For example, to output as PDF
125 </li>
126 </ol>
127 </ol>
128 </p>
129
130 <h3><a name="linux"/> Linux </h3>
131
132 <p>
133 <ol>
134 <li>Choose from:</li>
135 <ol>
136 <li> From graphviz:</li>
137 <ul>
138 <li>Download the relevant package from Downloads section of <a href="matlab:web('http://www.graphviz.org/')">www.graphviz.org</a>.</li>
139 <li>Install the package by following the relevant instructions.</li>
140 </ul>
141 <li> From terminal (Ubuntu):</li>
142 <ul>
143 <li>Please type in a terminal: <tt>>sudo apt-get install graphviz</tt></li>
144 </ul>
145 <li> From graphical package manager like <b>YaSt, Synaptic, Adept, ...</b></li>
146 <ul>
147 <li>Start your graphical package manager</li>
148 <li>Search for the <tt>>graphviz</tt> package</li>
149 <li>Select the package and all depending packes and install these packages.</li>
150 </ul>
151 </ol>
152 <li>Set the two relevant preferences with your LTPDA Preferences Panel.</li>
153 <ol>
154 <li>Start the LTPDA Preferences Panel. For this follow the step 3.1 or 3.2 of the window installation.</li>
155 <li>Set the path to the 'dot' binary in the editable text field "DOT binary". If you perform the default installation from the terminal, this should be something like:
156 <br>'/usr/bin/dot';</br>
157 <br>even 'dot' without the path should work</br>
158 </li>
159 <li>Define in the editable text field "DOT format" the graphics format to output. See <a href="matlab:web('http://www.graphviz.org/doc/info/output.html')">formats</a> for available formats. To view the final graphics file you must have a suitable viewer for that graphics format installed on the system. For example, to output as PDF
160 </li>
161 </ol>
162 <li>Define a programm in MATLAB which opens the file.</li>
163 <ol>
164 <li>The default programm to open a pdf file is the Acrobat Reader</li>
165 <li>Define another program under File -> Preferences -> Help -> PDF Reader</li>
166 </ol>
167 </ol>
168 </p>
169 </p>
170