source: html/ckbs/index.htm @ 81

Last change on this file since 81 was 81, checked in by bradbell, 12 years ago

[html/ckbs] fix one yyyymmdd reference that was in code font (now italic)

File size: 10.2 KB
Line 
1<html><head>
2<title>ckbs-0.20100228.0: A Constrained Kalman-Bucy Smoother</title>
3<meta name="description" id="description" content="ckbs-0.20100228.0: A Constrained Kalman-Bucy Smoother">
4<meta name="keywords" id="keywords" content=" ">
5<style type='text/css'>
6body { color : black }
7body { background-color : white }
8A:link { color : blue }
9A:visited { color : purple }
10A:active { color : purple }
11</style>
12<script type='text/javascript' language='JavaScript' src='_ckbs_htm.js'>
13</script>
14</head>
15<body>
16<table><tr>
17<td>
18<select onchange='choose_across0(this)'>
19<option>Index-&gt;</option>
20<option>contents</option>
21<option>reference</option>
22<option>index</option>
23<option>search</option>
24<option>external</option>
25</select>
26</td>
27<td>Previous</td><td><a href="_contents.htm" target="_top">Next</a>
28</td><td>
29<select onchange='choose_up0(this)'>
30<option>Up-&gt;</option>
31<option>ckbs</option>
32</select>
33</td>
34<td>
35<select onchange='choose_down0(this)'>
36<option>ckbs-&gt;</option>
37<option>license</option>
38<option>ckbs_nonlinear</option>
39<option>ckbs_affine</option>
40<option>utility</option>
41<option>all_ok.m</option>
42<option>whatsnew</option>
43</select>
44</td>
45<td>
46<select onchange='choose_current0(this)'>
47<option>Headings-&gt;</option>
48<option>MathML</option>
49<option>System Requirements</option>
50<option>Download</option>
51<option>---..Using Subversion</option>
52<option>---..Release Tarballs</option>
53<option>Test Install</option>
54<option>Documentation</option>
55<option>Contents</option>
56</select>
57</td>
58</tr></table><br>
59<code>
60<span style='white-space: nowrap'>&nbsp;\newcommand{\T}{{\rm&nbsp;T}}</span></code>
61
62<code>
63<span style='white-space: nowrap'>&nbsp;\newcommand{\R}{{\bf&nbsp;R}}</span></code>
64
65
66
67
68
69<center><b><big><big>ckbs-0.20100228.0: A Constrained Kalman-Bucy Smoother</big></big></b></center>
70<br>
71<b><big><a name="MathML" id="MathML">MathML</a></big></b>
72<br>
73This documentation is in XHTML + MathML.
74If you have trouble viewing it in your browser see
75Viewing MathML on the web page
76<code><span style='white-space: nowrap'><br>
77&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></code>
78        <a href="http://www.seanet.com/~bradbell/packages.htm" target="_top"><span style='white-space: nowrap'>http://www.seanet.com/~bradbell/packages.htm</span></a>
79
80
81<br>
82<br>
83<b><big><a name="System Requirements" id="System Requirements">System Requirements</a></big></b>
84<br>
85This constrained Kalman-Bucy smoother runs under both the
86<a href="http://www.mathworks.com/" target="_top"><span style='white-space: nowrap'>Matlab&#174;</span></a>
87
88and
89<a href="http://www.gnu.org/software/octave/" target="_top"><span style='white-space: nowrap'>Octave</span></a>
90
91While it will work under MS windows,
92these download instructions are for the Unix operating system.
93
94<br>
95<br>
96<b><big><a name="Download" id="Download">Download</a></big></b>
97
98
99<br>
100<br>
101<b><a name="Download.Using Subversion" id="Download.Using Subversion">Using Subversion</a></b>
102<br>
103If you have subversion, you can download a copy of the most recent
104version of ckbs with the command
105
106<code><font color="blue"><span style='white-space: nowrap'><br>
107&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;web=&quot;https://projects.coin-or.org/svn/CoinBazaar/projects/ckbs&quot;<br>
108&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;svn&nbsp;checkout&nbsp;$web/trunk&nbsp;ckbs-0.20100228.0<br>
109</span></font></code>
110You can download a previous release of ckbs with the command
111
112<code><font color="blue"><span style='white-space: nowrap'><br>
113&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;svn&nbsp;checkout&nbsp;$web/releases/0.</span></font><i><font color="black"><span style='white-space: nowrap'>yyyymmdd</span></font></i><font color="blue"><span style='white-space: nowrap'>.</span></font><i><font color="black"><span style='white-space: nowrap'>r</span></font></i><font color="blue"><span style='white-space: nowrap'>&nbsp;ckbs-0.</span></font><i><font color="black"><span style='white-space: nowrap'>yyyymmdd</span></font></i><font color="blue"><span style='white-space: nowrap'>.</span></font><i><font color="black"><span style='white-space: nowrap'>r</span></font></i><font color="blue"><span style='white-space: nowrap'><br>
114</span></font></code>
115where
116<code><i><font color="black"><span style='white-space: nowrap'>yyyy</span></font></i></code>
117 is the year,
118
119<code><i><font color="black"><span style='white-space: nowrap'>mm</span></font></i></code>
120 is the month,
121
122<code><i><font color="black"><span style='white-space: nowrap'>dd</span></font></i></code>
123 is the day,
124and
125<code><i><font color="black"><span style='white-space: nowrap'>r</span></font></i></code>
126 is the release number for the release you want.
127In either case, this creates the directory
128
129<code><font color="blue"><span style='white-space: nowrap'>ckbs-0.</span></font><i><font color="black"><span style='white-space: nowrap'>yyyymmdd</span></font></i><font color="blue"><span style='white-space: nowrap'>.</span></font><i><font color="black"><span style='white-space: nowrap'>r</span></font></i></code>
130.
131<code><span style='white-space: nowrap'><br>
132<br>
133</span></code>The release number (
134<code><i><font color="black"><span style='white-space: nowrap'>r</span></font></i></code>
135 above)
136starts at zero and is incremented for bug fixes.
137The date (
138<code><i><font color="black"><span style='white-space: nowrap'>yyyymmdd</span></font></i></code>
139 above)
140is incremented with feature changes which are discussed by date
141in the <a href="whatsnew.htm" target="_top"><span style='white-space: nowrap'>whatsnew</span></a>
142 section of this documentation
143
144<br>
145<br>
146<b><a name="Download.Release Tarballs" id="Download.Release Tarballs">Release Tarballs</a></b>
147<br>
148If you do not have subversion you can download the tarball
149
150<code><font color="blue"><span style='white-space: nowrap'>ckbs-0.</span></font><i><font color="black"><span style='white-space: nowrap'>yyyymmdd</span></font></i><font color="blue"><span style='white-space: nowrap'>.</span></font><i><font color="black"><span style='white-space: nowrap'>r</span></font></i><font color="blue"><span style='white-space: nowrap'>.tgz</span></font></code>
151 from the release download directory
152<code><font color='blue'><pre style='display:inline'> 
153        http://www.coin-or.org/download/source/CoinBazaar
154</pre></font></code>
155
156You can extract the files from the tarball using the command
157
158<code><font color="blue"><span style='white-space: nowrap'><br>
159&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;tar&nbsp;-xvzf&nbsp;ckbs-0.</span></font><i><font color="black"><span style='white-space: nowrap'>yyyymmdd</span></font></i><font color="blue"><span style='white-space: nowrap'>.</span></font><i><font color="black"><span style='white-space: nowrap'>r</span></font></i><font color="blue"><span style='white-space: nowrap'>.tgz<br>
160</span></font></code>
161This will create the directory
162
163<code><font color="blue"><span style='white-space: nowrap'>ckbs-0.</span></font><i><font color="black"><span style='white-space: nowrap'>yyyymmdd</span></font></i><font color="blue"><span style='white-space: nowrap'>.</span></font><i><font color="black"><span style='white-space: nowrap'>r</span></font></i></code>
164.
165
166<br>
167<br>
168<b><big><a name="Test Install" id="Test Install">Test Install</a></big></b>
169<br>
170Using Matlab&#174; or Octave, to change into the directory
171
172<code><font color="blue"><span style='white-space: nowrap'><br>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ckbs-0.</span></font><i><font color="black"><span style='white-space: nowrap'>yyyymmdd</span></font></i><font color="blue"><span style='white-space: nowrap'>.</span></font><i><font color="black"><span style='white-space: nowrap'>r</span></font></i><font color="blue"><span style='white-space: nowrap'>/test<br>
174</span></font></code>
175and run the program <code><font color="blue">all_ok.m</font></code>.
176It will print the test results for all the components of <code><font color="blue">ckbs</font></code>.
177
178<br>
179<br>
180<b><big><a name="Documentation" id="Documentation">Documentation</a></big></b>
181<br>
182A copy of the documentation for your version of ckbs can
183be built by executing the command
184<code><font color='blue'><pre style='display:inline'> 
185        ./build_doc.sh
186</pre></font></code>
187
188in the
189<code><font color="blue"><span style='white-space: nowrap'>ckbs-0.</span></font><i><font color="black"><span style='white-space: nowrap'>yyyymmdd</span></font></i><font color="blue"><span style='white-space: nowrap'>.</span></font><i><font color="black"><span style='white-space: nowrap'>r</span></font></i></code>
190 directory.
191You can then view the documentation by loading the file
192
193<code><font color="blue"><span style='white-space: nowrap'><br>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ckbs-0.</span></font><i><font color="black"><span style='white-space: nowrap'>yyyymmdd</span></font></i><font color="blue"><span style='white-space: nowrap'>.</span></font><i><font color="black"><span style='white-space: nowrap'>r</span></font></i><font color="blue"><span style='white-space: nowrap'>/doc/ckbs.xml<br>
195</span></font></code>
196into your browser.
197
198<br>
199<br>
200<b><big><a name="Contents" id="Contents">Contents</a></big></b>
201<br>
202<table>
203<tr><td><a href="_contents.htm" target="_top">_contents</a></td><td>Table&nbsp;of&nbsp;Contents</td></tr><tr><td><a href="license.htm" target="_top">license</a></td><td>Your&nbsp;License&nbsp;to&nbsp;use&nbsp;the&nbsp;ckbs&nbsp;Software</td></tr><tr><td><a href="ckbs_nonlinear.htm" target="_top">ckbs_nonlinear</a></td><td>The&nbsp;Nonlinear&nbsp;Constrained&nbsp;Kalman-Bucy&nbsp;Smoother</td></tr><tr><td><a href="ckbs_affine.htm" target="_top">ckbs_affine</a></td><td>Constrained&nbsp;Affine&nbsp;Kalman&nbsp;Bucy&nbsp;Smoother</td></tr><tr><td><a href="utility.htm" target="_top">utility</a></td><td>ckbs&nbsp;Utility&nbsp;Functions</td></tr><tr><td><a href="all_ok.m.htm" target="_top">all_ok.m</a></td><td>Run&nbsp;All&nbsp;Correctness&nbsp;Tests</td></tr><tr><td><a href="whatsnew.htm" target="_top">whatsnew</a></td><td>Changes&nbsp;and&nbsp;Additions&nbsp;to&nbsp;ckbs</td></tr><tr><td><a href="_reference.htm" target="_top">_reference</a></td><td>Alphabetic&nbsp;Listing&nbsp;of&nbsp;Cross&nbsp;Reference&nbsp;Tags</td></tr><tr><td><a href="_index.htm" target="_top">_index</a></td><td>Keyword&nbsp;Index</td></tr><tr><td><a href="_search.htm" target="_top">_search</a></td><td>Search&nbsp;This&nbsp;Web&nbsp;Site</td></tr><tr><td><a href="_external.htm" target="_top">_external</a></td><td>External&nbsp;Internet&nbsp;References</td></tr></table>
204<hr>Input File: ckbs.omh
205
206</body>
207</html>
Note: See TracBrowser for help on using the repository browser.