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