Mercurial > hg > ltpda
diff 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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/m-toolbox/html_help/help/ug/additional_progs_content.html Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,170 @@ +<p> + Some features of the LTPDA Toolbox require additional 3rd-party software to be installed. These are listed below. +</p> +<p> + <hr> + <h2>Graphviz</h2> + + <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> + + <p> + <table cellspacing="0" class="body" cellpadding="4" border="2"> + <colgroup> + <col width="37%"/> + <col width="63%"/> + </colgroup> + <thead> + <tr valign="top"> + <th bgcolor="#B2B2B2">Method</th> + <th bgcolor="#B2B2B2">Description</th> + </tr> + </thead> + <tbody> + + <!-- history/dotview --> + <tr valign="top"> + <td bgcolor="#F2F2F2"> + <p><tt>history/dotview</tt></p> + </td> + <td bgcolor="#F2F2F2"> + <p>Convert a history object to a tree-diagram using the DOT interpreter.</p> + </td> + </tr> + + <!-- ssm/dotview --> + <tr valign="top"> + <td bgcolor="#F2F2F2"> + <p><tt>ssm/dotview</tt></p> + </td> + <td bgcolor="#F2F2F2"> + <p>Convert the statespace model object to a block-diagram using the DOT interpreter.</p> + </td> + </tr> + + <!-- report --> + <tr valign="top"> + <td bgcolor="#F2F2F2"> + <p><tt>report</tt></p> + </td> + <td bgcolor="#F2F2F2"> + <p>Generates a HTML report about the input objects which includes a DOT block-diagram of the history.</p> + </td> + </tr> + + </tbody> + </table> + </p> + + <p>The following installation guidelines can be used for different platforms</p> + <ul> + <li><p><a href="#windows"/>Installation Guide for Windows</p></li> + <li><p><a href="#mac"/>Installation Guide for Mac OS X</p></li> + <li><p><a href="#linux"/>Installation Guide for Linux</p></li> + </ul> + + <h3><a name="windows"/> Windows </h3> + + <p> + <ol> + <li><p>Download the relevant package from Downloads section of <a href="matlab:web('http://www.graphviz.org/')">www.graphviz.org</a>.</p></li> + <li><p>Install the package by following the relevant instructions.</p></li> + <li><p>Set the two relevant preferences with your LTPDA Preferences Panel</p></li> + <ol> + <li>For this start the LTPDApres<br /> + <br /> + <table cellspacing="0" class="note" summary="Note" cellpadding="5" border="1"> + <tr width="90%"> + <td>>> LTPDAprefs + </td> + </tr> + </table> + <br /> + </li> + <li>or press the "LTPDA Preferences" button on the LTPDA Launch Bay<br /> + <br></br> + <img src="images/LTPDAlauncher.png" alt="Interpolate" border="0"></img> + <br /> + <br /> + </li> + <li style="margin-top:1ex">Select on your LTPDA Preferences Panel the category "External Programs"<br /> + <br /> + <img src="images/LTPDAprefs_ExtProg.png" alt="Interpolate" border="0"></img> <br /> + <br /> + </li> + <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: + <br>'c:\Program Files\Graphviz2.20\bin\dot.exe';</br> + </li> + <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 + </li> + </ol> + </ol> + </p> + + <h3><a name="mac"/> Mac OS X </h3> + <p> + <ol> + <li>Choose from:</li> + <ol> + <li> From graphviz:</li> + <ul> + <li>Download the relevant package from Downloads section of <a href="matlab:web('http://www.graphviz.org/')">www.graphviz.org</a>.</li> + <li>Install the package by following the relevant instructions.</li> + </ul> + <li> From Fink:</li> + <ul> + <li> If you use the fink package manager, in a terminal: <tt>> fink install graphviz</tt></li> + </ul> + </ol> + <li>Set the two relevant preferences with your LTPDA Preferences Panel.</li> + <ol> + <li>Start the LTPDA Preferences Panel. For this follow the step 3.1 or 3.2 of the window installation.</li> + <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: + <br>'/sw/bin/dot'</br> + </li> + <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 + </li> + </ol> + </ol> + </p> + + <h3><a name="linux"/> Linux </h3> + + <p> + <ol> + <li>Choose from:</li> + <ol> + <li> From graphviz:</li> + <ul> + <li>Download the relevant package from Downloads section of <a href="matlab:web('http://www.graphviz.org/')">www.graphviz.org</a>.</li> + <li>Install the package by following the relevant instructions.</li> + </ul> + <li> From terminal (Ubuntu):</li> + <ul> + <li>Please type in a terminal: <tt>>sudo apt-get install graphviz</tt></li> + </ul> + <li> From graphical package manager like <b>YaSt, Synaptic, Adept, ...</b></li> + <ul> + <li>Start your graphical package manager</li> + <li>Search for the <tt>>graphviz</tt> package</li> + <li>Select the package and all depending packes and install these packages.</li> + </ul> + </ol> + <li>Set the two relevant preferences with your LTPDA Preferences Panel.</li> + <ol> + <li>Start the LTPDA Preferences Panel. For this follow the step 3.1 or 3.2 of the window installation.</li> + <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: + <br>'/usr/bin/dot';</br> + <br>even 'dot' without the path should work</br> + </li> + <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 + </li> + </ol> + <li>Define a programm in MATLAB which opens the file.</li> + <ol> + <li>The default programm to open a pdf file is the Acrobat Reader</li> + <li>Define another program under File -> Preferences -> Help -> PDF Reader</li> + </ol> + </ol> + </p> + </p> +