source: projects/ckbs/trunk/omh/ckbs.omh @ 69

Last change on this file since 69 was 69, checked in by bradbell, 11 years ago

[ckbs/trunk] Improve helper shell scripts.

svn_status.sh: remove some more work files from svn status list.
whatsnew.omh: fix cross reference link to ckbs (which changed).
ckbs.omh: Change download instrutions so will work with Coin automation.
copy_doc.sh: automatically bring ckbs web documentation up to date.
new_stable.sh: script to help create a new stable version.
build_doc.sh: exit if warnings or errors occur in documentation.

File size: 3.3 KB
Line 
1# -------------------------------------------------------------------
2# ckbs: Constrained Kalman-Bucy Smoother Program: Copyright (C) 2006
3# Authors: Bradlely Bell:        bradbell at washington dot edu
4#          Gianluigi Pillonetto: giapi at dei dot unipd dot it
5# License: GNU General Public License Version 2
6# -------------------------------------------------------------------
7$begin ckbs$$
8$dollar @$$
9$rmark !$$
10$spell
11        Tarballs
12        yyyymmdd
13        yyyy mm dd
14        www http https
15        coin-or.org/svn/CoinBazaar
16        tarball
17        tgz
18        xvzf
19        cygwin
20        ckbs
21        Matlab
22        xml
23$$
24
25$path%..%.m%$$
26$path%..%.omh%$$
27
28$latex \newcommand{\T}{{\rm T}}$$
29$latex \newcommand{\R}{{\bf R}}$$
30
31
32$navigate%
33        Across%Index%
34        Prev%Previous%
35        Next%Next%
36        Up%Up%
37        Down_up_3%_up_3%
38        Down_up_2%_up_2%
39        Down_up_1%_up_1%
40        Down_up_0%_up_0%
41        Current%Headings
42%$$
43
44$section ckbs-0.20100228.0: A Constrained Kalman-Bucy Smoother$$
45
46$head MathML$$
47This documentation is in XHTML + MathML.
48If you have trouble viewing it in your browser see
49Viewing MathML on the web page
50$pre
51        $$
52        $href%
53                http://www.seanet.com/~bradbell/packages.htm
54        %$$
55
56$head System Requirements$$
57This constrained Kalman-Bucy smoother runs under both the
58$href%
59        http://www.mathworks.com/%
60        Matlab!
61%$$
62and
63$href%
64        http://www.gnu.org/software/octave/%
65        Octave
66%$$
67While it will work under MS windows,
68these download instructions are for the Unix operating system.
69
70$head Download$$
71
72$subhead Using Subversion$$
73If you have subversion, you can download a copy of the most recent
74version of ckbs with the command
75$codei%
76        web="https://projects.coin-or.org/svn/CoinBazaar/projects/ckbs"
77        svn checkout @web/trunk ckbs-0.20100228.0
78%$$
79You can download a previous release of ckbs with the command
80$codei%
81        svn checkout @web/releases/0.%yyyymmdd%.%r% ckbs-0.%yyyymmdd%.%r%
82%$$
83where $icode yyyy$$ is the year,
84$icode mm$$ is the month,
85$icode dd$$ is the day,
86and $icode r$$ is the release number for the release you want.
87In either case, this creates the directory
88$codei%ckbs-0.%yyyymmdd%.%r%$$.
89$pre
90
91$$
92The release number ($icode r$$ above)
93starts at zero and is incremented for bug fixes.
94The date ($icode yyyymmdd$$ above)
95is incremented with feature changes which are discussed by date
96in the $cref/whatsnew/$$ section of this documentation
97
98$subhead Release Tarballs$$
99If you do not have subversion you can download the tarball
100$codei%ckbs-0.%yyyymmdd%.%r%.tgz%$$ from the release download directory
101$codep
102        http://www.coin-or.org/download/source/CoinBazaar
103$$
104You can extract the files from the tarball using the command
105$codei%
106        tar -xvzf ckbs-0.%yyyymmdd%.%r%.tgz
107%$$
108This will create the directory
109$codei%ckbs-0.%yyyymmdd%.%r%$$.
110
111$head Test Install$$
112Using Matlab! or Octave, to change into the directory
113$codei%
114        ckbs-0.%yyyymmdd%.%r%/test
115%$$
116and run the program $code all_ok.m$$.
117It will print the test results for all the components of $code ckbs$$.
118
119$head Documentation$$
120A copy of the documentation for your version of ckbs can
121be built by executing the command
122$codep
123        ./build_doc.sh
124$$
125in the $code ckbs-0.%yyyymmdd%.%r%$$ directory.
126You can then view the documentation by loading the file
127$codei%
128        ckbs-0.%yyyymmdd%.%r%/doc/ckbs.xml
129%$$
130into your browser.
131
132$childtable%
133        omh/license.omh%
134        src/ckbs_nonlinear.m%
135        src/ckbs_affine.m%
136        omh/utility.omh%
137        test/all_ok.m%
138        omh/whatsnew.omh
139%$$
140
141
142$end
Note: See TracBrowser for help on using the repository browser.