My last changes to raw_results handling before the course
[PsN.git] / html / sumo_docs.php
blobd4ff85b5c7d298777230993b24df0b59da66b89d
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <title>PsN :: Documentation :: sumo</title>
5 <!--Adobe(R) LiveMotion(TM) 1.0 Generated JavaScript. Please do not edit. -->
6 <script>
8 <!--
10 function newImage(arg) {
12 if (document.images) {
14 rslt = new Image();
16 rslt.src = arg;
18 return rslt;
24 ImageArray = new Array;
26 var preloadFlag = false;
28 function preloadImages() {
30 if (document.images) {
32 ImageArray[ImageArray.length++] = newImage(/* OWNER('object', 'dflt') *//*URL*/'images/indexhome.jpg');
33 ImageArray[ImageArray.length++] = newImage(/* OWNER('object', 'movr') *//*URL*/'images/indexhomeov.jpg');
34 ImageArray[ImageArray.length++] = newImage(/* OWNER('object1', 'dflt') *//*URL*/'images/indexdocumentation.jpg');
35 ImageArray[ImageArray.length++] = newImage(/* OWNER('object1', 'movr') *//*URL*/'images/indexdocumentationov.jpg');
36 ImageArray[ImageArray.length++] = newImage(/* OWNER('object2', 'dflt') *//*URL*/'images/indexdownload.jpg');
37 ImageArray[ImageArray.length++] = newImage(/* OWNER('object2', 'movr') *//*URL*/'images/indexdownloadov.jpg');
38 ImageArray[ImageArray.length++] = newImage(/* OWNER('object3', 'dflt') *//*URL*/'images/indexbuglist.jpg');
39 ImageArray[ImageArray.length++] = newImage(/* OWNER('object3', 'movr') *//*URL*/'images/indexbuglistov.jpg');
40 ImageArray[ImageArray.length++] = newImage(/* OWNER('object4', 'dflt') *//*URL*/'images/indexmailing_list.jpg');
41 ImageArray[ImageArray.length++] = newImage(/* OWNER('object4', 'movr') *//*URL*/'images/indexmailing_listov.jpg');
42 preloadFlag = true;
45 function changeImages() {
46 if (document.images && (preloadFlag == true)) {
47 for (var i=0; i<changeImages.arguments.length; i+=2) {
48 document[changeImages.arguments[i]].src = changeImages.arguments[i+1];
52 // -->
53 </script><!-- End generated JavaScript. -->
54 <meta http-equiv="Content-Type"
55 content="text/html; charset=ISO-8859-1">
56 <style type="text/css">
57 <!--
58 body,td,th {
59 font-family: Helvetica, Arial, serif;
60 font-size: 12px;
61 color: #000000;
63 body {
64 margin-left: 6px;
65 margin-top: 0px;
66 margin-right: 0px;
67 margin-bottom: 0px;
68 background-image: url(gfx/bg.jpg);
70 .style1 {
71 font-size: 36px;
72 font-weight: bold;
74 .heading1 {
75 font-size: 16px;
76 font-weight: bold;
77 color: #333399;
78 margin-left: 40px;
80 a:link {
81 color: #656D9C;
82 text-decoration: none;
84 a:visited {
85 color: #656D9C;
86 text-decoration: none;
88 a:hover {
89 color: #AF9D49;
90 text-decoration: none;
92 a:active {
93 color: #656D9C;
94 text-decoration: none;
96 .style2 {font-family: "Courier New", Courier, mono}
97 -->
98 </style>
99 <script language="JavaScript" type="text/JavaScript">
100 <!--
101 function MM_reloadPage(init) { //reloads the window if Nav4 resized
102 if (init==true) with (navigator) {if ((appName=="Netscape")&&(parseInt(appVersion)==4)) {
103 document.MM_pgW=innerWidth; document.MM_pgH=innerHeight; onresize=MM_reloadPage; }}
104 else if (innerWidth!=document.MM_pgW || innerHeight!=document.MM_pgH) location.reload();
106 MM_reloadPage(true);
107 //-->
108 </script>
109 <meta content="Pntus Pihlgren" name="author">
110 </head>
111 <body onload="preloadImages();"
112 style="background-color: rgb(255, 255, 255);">
113 <!-- The table is not formatted nicely because some browsers cannot join images in table cells if there are any hard carriage returns in a TD. -->
114 <div id="Layer1"
115 style="position: absolute; left: 335px; top: 42px; width: 388px; height: 43px; z-index: 1; font-size: x-small;">
116 <div class="style1" align="right"><span style="font-family: monospace;">sumo</span><br>
117 </div>
118 </div>
119 <div id="Layer2"
120 style="position: absolute; left: 226px; top: 188px; width: 497px; height: 431px; z-index: 2;">
121 <div align="justify">
123 <h3 class="heading1">Synopsis</h3>
124 <span class="style2">sumo.pl [ -h | -? ] [ -help ]<br>
125 [ -debug='integer' ]<br>
126 [ -debug_package='string' ]<br>
127 [ -debug_subroutine='string' ]<br>
128 outputfile(s)</span
130 <h3 class="heading1">Description</h3>
132 Sumo is short for SUmmarize Output. And it does exactly that. It
133 gathers some usefull information from NONMEM ouputfiles and prints a
134 summary to screen.
136 <h3 class="heading1">Options</h3>
138 The following options are valid:
139 <p class="style2">
140 -h | -?
142 Print a list of options.
144 <p class="style2">
145 -help
147 Print this, longer, help message.
149 <p class="style2">
150 -debug='integer'
152 Default value is: 0
154 This is mainly for developers who whish to debug PsN. By default
155 'integer' is zero but you can try setting it to '1' and you might
156 get some helpfull warnings. If you run in to problems that require
157 support, you might be told to crank this number up and send the
158 output to us.
160 <p class="style2">
161 -debug_package='string'
163 Default value is: empty string
165 If use together with '-debug' it is possible to choose which part
166 of PsN you want to see debug messages from. Again this is mostly
167 for developers.
169 <p class="style2">
170 -debug_subroutine='string'
171 <p>
172 Default value is: empty string
174 With this option it is possible to specify, with even finer
175 granularity, which part of PsN you want to see debug messages
176 from. This is definitly only for developers.
177 <h3 class="heading1">Output</h3>
179 Sumo will print termination message, objective function value and a
180 table of thetas and omegas.<p>
182 Output could look like this:<p>
184 <pre>
185 0MINIMIZATION SUCCESSFUL
186 NO. OF FUNCTION EVALUATIONS USED: 111
187 NO. OF SIG. DIGITS IN FINAL EST.: 4.3
189 Objective function value: 742.051
191 THETA OMEGA SIGMA
192 TH1 0.00555 (0.0712) OM1 0.497 (0.632) SI1 0.1281 (0.207)
193 TH2 1.34 (0.0596) OM2 0.3768 (0.246)
194 </pre>
196 <h3 class="heading1">Examples</h3>
198 Get summary from an output file:
199 <p class="style2">
200 $ sumo.pl output.lst
201 </div>
202 <p align="justify">&nbsp;</p>
203 </div>
204 <table border="0" cellpadding="0" cellspacing="0" width="780">
205 <tbody>
206 <tr>
207 <td height="600" width="780">
208 <table border="0" cellpadding="0" cellspacing="0" width="780">
209 <tbody>
210 <tr>
211 <td colspan="7" height="201" width="780"><img
212 src="images/indexpane1_1_.jpg" name="" alt="" border="0" height="201"
213 width="780"></td>
214 </tr>
215 <tr>
216 <td height="46" width="26"><img
217 src="images/indexpane1_2_.jpg" name="" alt="" border="0" height="46"
218 width="26"></td>
219 <td height="46" width="73"><a href="index.php"
220 onmouseover="changeImages(/*CMP*/ 'object', /*URL*/ 'images/indexhomeov.jpg'); return true;"
221 onmouseout="changeImages(/*CMP*/ 'object', /*URL*/ 'images/indexhome.jpg'); return true;"><img
222 src="images/indexhome.jpg" name="object" alt="Home" border="0"
223 height="46" width="73"></a></td>
224 <td height="46" width="11"><img
225 src="images/indexpane3_2_.jpg" name="" alt="" border="0" height="46"
226 width="11"></td>
227 <td height="46" width="25"><img
228 src="images/indexpane4_2_.jpg" name="" alt="" border="0" height="46"
229 width="25"></td>
230 <td height="46" width="15"><img
231 src="images/indexpane5_2_.jpg" name="" alt="" border="0" height="46"
232 width="15"></td>
233 <td height="46" width="40"><img
234 src="images/indexpane6_2_.jpg" name="" alt="" border="0" height="46"
235 width="40"></td>
236 <td height="46" width="590"><img
237 src="images/indexpane7_2_.jpg" name="" alt="" border="0" height="46"
238 width="590"></td>
239 </tr>
240 <tr>
241 <td colspan="7" height="7" width="780"><img
242 src="images/indexpane1_3_.jpg" name="" alt="" border="0" height="7"
243 width="780"></td>
244 </tr>
245 <tr>
246 <td height="46" width="26"><img
247 src="images/indexpane1_4_.jpg" name="" alt="" border="0" height="46"
248 width="26"></td>
249 <td colspan="5" height="46" width="164"><a href="docs.php"
250 onmouseover="changeImages(/*CMP*/ 'object1', /*URL*/ 'images/indexdocumentationov.jpg'); return true;"
251 onmouseout="changeImages(/*CMP*/ 'object1', /*URL*/ 'images/indexdocumentation.jpg'); return true;"><img
252 src="images/indexdocumentation.jpg" name="object1" alt="Documentation"
253 border="0" height="46" width="164"></a></td>
254 <td height="46" width="590"><img
255 src="images/indexpane7_4_.jpg" name="" alt="" border="0" height="46"
256 width="590"></td>
257 </tr>
258 <tr>
259 <td colspan="7" height="7" width="780"><img
260 src="images/indexpane1_5_.jpg" name="" alt="" border="0" height="7"
261 width="780"></td>
262 </tr>
263 <tr>
264 <td height="46" width="26"><img
265 src="images/indexpane1_6_.jpg" name="" alt="" border="0" height="46"
266 width="26"></td>
267 <td colspan="3" height="46" width="109"><a
268 href="download.php"
269 onmouseover="changeImages(/*CMP*/ 'object2', /*URL*/ 'images/indexdownloadov.jpg'); return true;"
270 onmouseout="changeImages(/*CMP*/ 'object2', /*URL*/ 'images/indexdownload.jpg'); return true;"><img
271 src="images/indexdownload.jpg" name="object2" alt="Download" border="0"
272 height="46" width="109"></a></td>
273 <td colspan="3" height="46" width="645"><img
274 src="images/indexpane5_6_.jpg" name="" alt="" border="0" height="46"
275 width="645"></td>
276 </tr>
277 <tr>
278 <td colspan="7" height="7" width="780"><img
279 src="images/indexpane1_7_.jpg" name="" alt="" border="0" height="7"
280 width="780"></td>
281 </tr>
282 <tr>
283 <td height="46" width="26"><img
284 src="images/indexpane1_8_.jpg" name="" alt="" border="0" height="46"
285 width="26"></td>
286 <td colspan="2" height="46" width="84"><a href="buglist.php"
287 onmouseover="changeImages(/*CMP*/ 'object3', /*URL*/ 'images/indexbuglistov.jpg'); return true;"
288 onmouseout="changeImages(/*CMP*/ 'object3', /*URL*/ 'images/indexbuglist.jpg'); return true;"><img
289 src="images/indexbuglist.jpg" name="object3" alt="Buglist" border="0"
290 height="46" width="84"></a></td>
291 <td colspan="4" height="46" width="670"><img
292 src="images/indexpane4_8_.jpg" name="" alt="" border="0" height="46"
293 width="670"></td>
294 </tr>
295 <tr>
296 <td colspan="7" height="7" width="780"><img
297 src="images/indexpane1_9_.jpg" name="" alt="" border="0" height="7"
298 width="780"></td>
299 </tr>
300 <tr>
301 <td height="46" width="26"><img
302 src="images/indexpane1_10_.jpg" name="" alt="" border="0" height="46"
303 width="26"></td>
304 <td colspan="4" height="46" width="124"><a href="list.php"
305 onmouseover="changeImages(/*CMP*/ 'object4', /*URL*/ 'images/indexmailing_listov.jpg'); return true;"
306 onmouseout="changeImages(/*CMP*/ 'object4', /*URL*/ 'images/indexmailing_list.jpg'); return true;"><img
307 src="images/indexmailing_list.jpg" name="object4" alt="Mailing List"
308 border="0" height="46" width="124"></a></td>
309 <td colspan="2" height="46" width="630"><img
310 src="images/indexpane6_10_.jpg" name="" alt="" border="0" height="46"
311 width="630"></td>
312 </tr>
313 <tr>
314 <td colspan="7" height="141" width="780"><img
315 src="images/indexpane1_11_.jpg" name="" alt="" border="0" height="141"
316 width="780"></td>
317 </tr>
318 </tbody>
319 </table>
320 </td>
321 </tr>
322 <tr>
323 <td><img src="images/is_single_pixel_gif.gif" alt="" height="1"
324 width="780"></td>
325 </tr>
326 </tbody>
327 </table>
328 <!--Adobe(R) LiveMotion(TM) DataMap1.0 DO NOT EDIT
329 end DataMap -->
330 </body>
331 </html>