Mercurial > hg > ltpda
diff m-toolbox/html_help/help/ug/setup.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/setup.html Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,151 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" + "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd"> + +<html lang="en"> +<head> + <meta name="generator" content= + "HTML Tidy for Mac OS X (vers 1st December 2004), see www.w3.org"> + <meta http-equiv="Content-Type" content= + "text/html; charset=us-ascii"> + + <title>Setting-up MATLAB (LTPDA Toolbox)</title> + <link rel="stylesheet" href="docstyle.css" type="text/css"> + <meta name="generator" content="DocBook XSL Stylesheets V1.52.2"> + <meta name="description" content= + "Presents an overview of the features, system requirements, and starting the toolbox."> + </head> + +<body> + <a name="top_of_page" id="top_of_page"></a> + + <p style="font-size:1px;"> </p> + + <table class="nav" summary="Navigation aid" border="0" width= + "100%" cellpadding="0" cellspacing="0"> + <tr> + <td valign="baseline"><b>LTPDA Toolbox</b></td><td><a href="../helptoc.html">contents</a></td> + + <td valign="baseline" align="right"><a href= + "sysreqts.html"><img src="b_prev.gif" border="0" align= + "bottom" alt="System Requirements"></a> <a href= + "additional_progs.html"><img src="b_next.gif" border="0" align= + "bottom" alt="Additional 3rd-party software"></a></td> + </tr> + </table> + + <h1 class="title"><a name="f3-12899" id="f3-12899"></a>Setting-up MATLAB</h1> + <hr> + + <p> + +<p>Setting up MATLAB to work properly with the LTPDA Toolbox requires a few steps:</p> + +<ul> + <li> + <p><a href="setup.html#path">Add the LTPDA Toolbox to the MATLAB path</a></p> + </li> + <li> + <p><a href="setup.html#startup">Starting LTPDA Toolbox</a></p> + </li> + <li> + <p><a href="setup.html#prefs">Edit the LTPDA Preferences</a></p> + </li> +</ul> + +<a name="path" id= "path"></a> +<h3 class="title">Add the LTPDA Toolbox to the MATLAB path</h3> + +<p> + After downloading and un-compressing the LTPDA Toolbox, you should add the + directory <tt>ltpda_toolbox</tt> to your MATLAB path. To do this: + <ul> + <li> File -> Set Path... </li> + <li> Choose "Add with Subfolders" and browse to the location of <tt>ltpda_toolbox</tt> </li> + <li> "Save" your new path. MATLAB may require you to save your new <tt>pathdef.m</tt> to a + new location in the case that you don't have write access to the default location. For more + details read the documentation on "pathdef" (<tt>>> doc pathdef</tt>). </li> + </ul> +</p> + +<a name="ltpdastartup" id= "ltpdastartup"></a> + +<a name="startup" id= "startup"></a> +<h3 class="title">Starting LTPDA Toolbox</h3> + +<p> + To start using the LTPDA Toolbox, execute the following command on the MATLAB terminal: + <div class="fragment"> + <pre> + ltpda_startup </pre> + </div> + This should launch the LTPDA Launchbay, and you should see the LTPDA logo on the MATLAB terminal. + When you run this for the first time, you will also be presented with the LTPDA Preferences GUI from + where you can edit the preferences for the toolbox (see below). +</p> +<p> + If everything has gone well, you should be able to run a set of built-in tests by doing: + <div class="fragment"> + <pre> + run_tests +</pre> + </div> + This will run about 100 test scripts. These test scripts can be found in <tt>$ltpda_toolbox/examples</tt> + and serve as useful example scripts. +</p> +<p> + In order to automatically start the LTPDA Toolbox + when MATLAB starts up, add the command <tt>ltpda_startup</tt> to your own <tt>startup.m</tt> + file. See <tt>>> doc startup</tt> for more details on installing and editing your own <tt>startup.m</tt> file. +</p> + +<a name="prefs" id= "prefs"></a> +<h3 class="title">Edit the LTPDA Preferences</h3> + + <p> + The LTPDA Toolbox comes with a default set of starting preferences. These may need + to be edited for your particular system (though most of the defaults should be fine). + To edit the preferences, you first need to have the LTPDA toolbox installed as described + above, then run the command + <div class="fragment"><pre> + LTPDAprefs + </pre></div> + or click on the "LTPDA Preferences" button on the launchbay. You should see the following GUI: + </p> + <p> + <img src="images/LTPDAprefs.png" alt="LTPDA Preferences GUI" border="0"> </p> +<p> + Edit all the preferences you want and then click apply to save the preferences. These new preferences + will be used each time you start LTPDA. + </p> + + +</p> + + + + </p> + + <br> + <br> + <table class="nav" summary="Navigation aid" border="0" width= + "100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td align="left" width="20"><a href="sysreqts.html"><img src= + "b_prev.gif" border="0" align="bottom" alt= + "System Requirements"></a> </td> + + <td align="left">System Requirements</td> + + <td> </td> + + <td align="right">Additional 3rd-party software</td> + + <td align="right" width="20"><a href= + "additional_progs.html"><img src="b_next.gif" border="0" align= + "bottom" alt="Additional 3rd-party software"></a></td> + </tr> + </table><br> + + <p class="copy">©LTP Team</p> +</body> +</html>