source: projects/ckbs/stable/0.20100228/doc/ckbs.htm @ 92

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

[ckbs/trunk] Change download instructions

ckbs.omh: move from here to ckbs.omh.
ckbs.omh: move to here from omh/ckbs.omh and change download instructions.

The changes in doc/* were automatically transferred from ckbs.omh.
_ckbs_xml.js:
ckbs.htm:
ckbs.xml:
index.htm:
_external.htm:
_printable.htm:
index.xml:
_external.xml:
_ckbs_htm.js:
_printable.xml:
copy_doc.sh:
build_doc.sh:

File size: 11.8 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>---..Release Tarballs</option>
52<option>---..Using Subversion</option>
53<option>---..Latest Version</option>
54<option>Test Install</option>
55<option>Documentation</option>
56<option>Contents</option>
57</select>
58</td>
59</tr></table><br>
60<code>
61<span style='white-space: nowrap'>&nbsp;\newcommand{\T}{{\rm&nbsp;T}}</span></code>
62
63<code>
64<span style='white-space: nowrap'>&nbsp;\newcommand{\R}{{\bf&nbsp;R}}</span></code>
65
66
67
68
69
70<center><b><big><big>ckbs-0.20100228.0: A Constrained Kalman-Bucy Smoother</big></big></b></center>
71<br>
72<b><big><a name="MathML" id="MathML">MathML</a></big></b>
73<br>
74This documentation is in XHTML + MathML.
75If you have trouble viewing it in your browser see
76Viewing MathML on the web page
77<code><span style='white-space: nowrap'><br>
78&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></code>
79        <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>
80
81
82<br>
83<br>
84<b><big><a name="System Requirements" id="System Requirements">System Requirements</a></big></b>
85<br>
86This constrained Kalman-Bucy smoother runs under both the
87<a href="http://www.mathworks.com/" target="_top"><span style='white-space: nowrap'>Matlab&#174;</span></a>
88
89and
90<a href="http://www.gnu.org/software/octave/" target="_top"><span style='white-space: nowrap'>Octave</span></a>
91
92While it will work under MS windows,
93these download instructions are for the Unix operating system.
94
95<br>
96<br>
97<b><big><a name="Download" id="Download">Download</a></big></b>
98
99
100<br>
101<br>
102<b><a name="Download.Release Tarballs" id="Download.Release Tarballs">Release Tarballs</a></b>
103<br>
104You can download a tarball release of ckbs from the directory
105<code><span style='white-space: nowrap'><br>
106&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></code>
107<a href="http://www.coin-or.org/download/source/CoinBazaar" target="_top"><span style='white-space: nowrap'>http://www.coin-or.org/download/source/CoinBazaar</span></a>
108
109<code><span style='white-space: nowrap'><br>
110</span></code>Theses releases are named
111
112<code><font color="blue"><span style='white-space: nowrap'><br>
113&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'>.</span></font><i><font color="black"><span style='white-space: nowrap'>ext</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,
124
125<code><i><font color="black"><span style='white-space: nowrap'>r</span></font></i></code>
126 is the release number,
127and
128<code><i><font color="black"><span style='white-space: nowrap'>ext</span></font></i></code>
129 is <code><font color="blue">tgz</font></code> or <code><font color="blue">zip</font></code>.
130<code><span style='white-space: nowrap'><br>
131<br>
132</span></code>If
133<code><i><font color="black"><span style='white-space: nowrap'>ext</span></font></i></code>
134 is <code><font color="blue">tgz</font></code> the command
135
136<code><font color="blue"><span style='white-space: nowrap'><br>
137&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>
138</span></font></code>
139will create the
140<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>
141 directory.
142<code><span style='white-space: nowrap'><br>
143<br>
144</span></code>If
145<code><i><font color="black"><span style='white-space: nowrap'>ext</span></font></i></code>
146 is <code><font color="blue">zip</font></code> the command
147
148<code><font color="blue"><span style='white-space: nowrap'><br>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unzip&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'>.zip<br>
150</span></font></code>
151will create the
152<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>
153 directory.
154
155<br>
156<br>
157<b><a name="Download.Using Subversion" id="Download.Using Subversion">Using Subversion</a></b>
158<br>
159For each release listed in the
160<a href="http://www.coin-or.org/download/source/CoinBazaar" target="_top"><span style='white-space: nowrap'>download&nbsp;directory</span></a>
161
162you can use subversion to download the release with the commands
163
164<code><font color="blue"><span style='white-space: nowrap'><br>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;web=&quot;https://projects.coin-or.org/svn/CoinBazaar/projects/ckbs&quot;<br>
166&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>
167</span></font></code>
168This will create the
169<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>
170 directory.
171
172<br>
173<br>
174<b><a name="Download.Latest Version" id="Download.Latest Version">Latest Version</a></b>
175<br>
176You can download the most recent version of ckbs (called the trunk)
177using the commands
178
179<code><font color="blue"><span style='white-space: nowrap'><br>
180&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;web=&quot;https://projects.coin-or.org/svn/CoinBazaar/projects/ckbs&quot;<br>
181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;svn&nbsp;checkout&nbsp;$web/trunk&nbsp;ckbs-0.20100228.0<br>
182</span></font></code>
183This will create the <code><font color="blue">ckbs-0.20100228.0</font></code> directory.
184
185<br>
186<br>
187<b><big><a name="Test Install" id="Test Install">Test Install</a></big></b>
188<br>
189Using Matlab&#174; or Octave, to change into the directory
190
191<code><font color="blue"><span style='white-space: nowrap'><br>
192&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>
193</span></font></code>
194and run the program <code><font color="blue">all_ok.m</font></code>.
195It will print the test results for all the components of <code><font color="blue">ckbs</font></code>.
196
197<br>
198<br>
199<b><big><a name="Documentation" id="Documentation">Documentation</a></big></b>
200<br>
201If you download a release, a copy of the documentation for the release
202can be found be viewed in your browser by opening the file
203
204<code><font color="blue"><span style='white-space: nowrap'><br>
205&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>
206<br>
207</span></font></code>
208If you download the latest version (the trunk),
209a copy of the documentation for this version can
210be built by executing the commands
211<code><font color='blue'><pre style='display:inline'> 
212        cd ckbs-0.20100228.0
213        ./build_doc.sh
214</pre></font></code>
215
216You can then view the documentation in your browser by opening the file
217
218<code><font color="blue"><span style='white-space: nowrap'><br>
219&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ckbs-0.20100228.0/doc/ckbs.xml<br>
220</span></font></code>
221<br>
222<b><big><a name="Contents" id="Contents">Contents</a></big></b>
223<br>
224<table>
225<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>
226<hr>Input File: ckbs.omh
227
228</body>
229</html>
Note: See TracBrowser for help on using the repository browser.