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

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

[ckbs/trunk] Docuemntation is now included in the downloaded releases.

ckbs.omh: new download instructions.
new_release.sh: script for create a new release.

File size: 3.6 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$latex \newcommand{\T}{{\rm T}}$$
26$latex \newcommand{\R}{{\bf R}}$$
27
28
29$navigate%
30        Across%Index%
31        Prev%Previous%
32        Next%Next%
33        Up%Up%
34        Down_up_3%_up_3%
35        Down_up_2%_up_2%
36        Down_up_1%_up_1%
37        Down_up_0%_up_0%
38        Current%Headings
39%$$
40
41$section ckbs-0.20100228.0: A Constrained Kalman-Bucy Smoother$$
42
43$head MathML$$
44This documentation is in XHTML + MathML.
45If you have trouble viewing it in your browser see
46Viewing MathML on the web page
47$pre
48        $$
49        $href%
50                http://www.seanet.com/~bradbell/packages.htm
51        %$$
52
53$head System Requirements$$
54This constrained Kalman-Bucy smoother runs under both the
55$href%
56        http://www.mathworks.com/%
57        Matlab!
58%$$
59and
60$href%
61        http://www.gnu.org/software/octave/%
62        Octave
63%$$
64While it will work under MS windows,
65these download instructions are for the Unix operating system.
66
67$head Download$$
68
69$subhead Release Tarballs$$
70You can download a tarball release of ckbs from the directory
71$pre
72        $$
73$href%http://www.coin-or.org/download/source/CoinBazaar%$$
74$pre
75$$
76Theses releases are named
77$codei%
78        ckbs-0.%yyyymmdd%.%r%.%ext%
79%$$
80where $icode yyyy$$ is the year,
81$icode mm$$ is the month,
82$icode dd$$ is the day,
83$icode r$$ is the release number,
84and $icode ext$$ is $code tgz$$ or $code zip$$.
85$pre
86
87$$
88If $icode ext$$ is $code tgz$$ the command
89$codei%
90        tar -xvzf ckbs-0.%yyyymmdd%.%r%.tgz
91%$$
92will create the $codei%ckbs-0.%yyyymmdd%.%r%$$ directory.
93$pre
94
95$$
96If $icode ext$$ is $code zip$$ the command
97$codei%
98        unzip ckbs-0.%yyyymmdd%.%r%.zip
99%$$
100will create the $codei%ckbs-0.%yyyymmdd%.%r%$$ directory.
101
102$subhead Using Subversion$$
103For each release listed in the
104$href%http://www.coin-or.org/download/source/CoinBazaar%download directory%$$
105you can use subversion to download the release with the commands
106$codei%
107        web="https://projects.coin-or.org/svn/CoinBazaar/projects/ckbs"
108        svn checkout @web/releases/0.%yyyymmdd%.%r% ckbs-0.%yyyymmdd%.%r%
109%$$
110This will create the $codei%ckbs-0.%yyyymmdd%.%r%$$ directory.
111
112$subhead Latest Version$$
113You can download the most recent version of ckbs (called the trunk)
114using the commands
115$codei%
116        web="https://projects.coin-or.org/svn/CoinBazaar/projects/ckbs"
117        svn checkout @web/trunk ckbs-0.20100228.0
118%$$
119This will create the $code ckbs-0.20100228.0$$ directory.
120
121$head Test Install$$
122Using Matlab! or Octave, to change into the directory
123$codei%
124        ckbs-0.%yyyymmdd%.%r%/test
125%$$
126and run the program $code all_ok.m$$.
127It will print the test results for all the components of $code ckbs$$.
128
129$head Documentation$$
130If you download a release, a copy of the documentation for the release
131can be found be viewed in your browser by opening the file
132$codei%
133        ckbs-0.%yyyymmdd%.%r%/doc/ckbs.xml
134
135%$$
136If you download the latest version (the trunk),
137a copy of the documentation for this version can
138be built by executing the commands
139$codep
140        cd ckbs-0.20100228.0
141        ./build_doc.sh
142$$
143You can then view the documentation in your browser by opening the file
144$codei%
145        ckbs-0.20100228.0/doc/ckbs.xml
146%$$
147
148$childtable%
149        omh/license.omh%
150        src/ckbs_nonlinear.m%
151        src/ckbs_affine.m%
152        omh/utility.omh%
153        test/all_ok.m%
154        omh/whatsnew.omh
155%$$
156
157
158$end
Note: See TracBrowser for help on using the repository browser.