source: trunk/doc/manuals/html/one/index.html @ 12

Last change on this file since 12 was 12, checked in by pinsard, 15 years ago

add matlab startup
File size: 15.6 KB
Line 
1<?xml version="1.0" encoding="utf-8" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6<meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
7<title>IRCAAM manuals</title>
8<style type="text/css">
9
10/*
11:Author: David Goodger (goodger@python.org)
12:Id: $Id: html4css1.css 5631 2008-08-24 13:01:23Z goodger $
13:Copyright: This stylesheet has been placed in the public domain.
14
15Default cascading style sheet for the HTML output of Docutils.
16
17See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
18customize this style sheet.
19*/
20
21/* used to remove borders from tables and images */
22.borderless, table.borderless td, table.borderless th {
23  border: 0 }
24
25table.borderless td, table.borderless th {
26  /* Override padding for "table.docutils td" with "! important".
27     The right padding separates the table cells. */
28  padding: 0 0.5em 0 0 ! important }
29
30.first {
31  /* Override more specific margin styles with "! important". */
32  margin-top: 0 ! important }
33
34.last, .with-subtitle {
35  margin-bottom: 0 ! important }
36
37.hidden {
38  display: none }
39
40a.toc-backref {
41  text-decoration: none ;
42  color: black }
43
44blockquote.epigraph {
45  margin: 2em 5em ; }
46
47dl.docutils dd {
48  margin-bottom: 0.5em }
49
50/* Uncomment (and remove this text!) to get bold-faced definition list terms
51dl.docutils dt {
52  font-weight: bold }
53*/
54
55div.abstract {
56  margin: 2em 5em }
57
58div.abstract p.topic-title {
59  font-weight: bold ;
60  text-align: center }
61
62div.admonition, div.attention, div.caution, div.danger, div.error,
63div.hint, div.important, div.note, div.tip, div.warning {
64  margin: 2em ;
65  border: medium outset ;
66  padding: 1em }
67
68div.admonition p.admonition-title, div.hint p.admonition-title,
69div.important p.admonition-title, div.note p.admonition-title,
70div.tip p.admonition-title {
71  font-weight: bold ;
72  font-family: sans-serif }
73
74div.attention p.admonition-title, div.caution p.admonition-title,
75div.danger p.admonition-title, div.error p.admonition-title,
76div.warning p.admonition-title {
77  color: red ;
78  font-weight: bold ;
79  font-family: sans-serif }
80
81/* Uncomment (and remove this text!) to get reduced vertical space in
82   compound paragraphs.
83div.compound .compound-first, div.compound .compound-middle {
84  margin-bottom: 0.5em }
85
86div.compound .compound-last, div.compound .compound-middle {
87  margin-top: 0.5em }
88*/
89
90div.dedication {
91  margin: 2em 5em ;
92  text-align: center ;
93  font-style: italic }
94
95div.dedication p.topic-title {
96  font-weight: bold ;
97  font-style: normal }
98
99div.figure {
100  margin-left: 2em ;
101  margin-right: 2em }
102
103div.footer, div.header {
104  clear: both;
105  font-size: smaller }
106
107div.line-block {
108  display: block ;
109  margin-top: 1em ;
110  margin-bottom: 1em }
111
112div.line-block div.line-block {
113  margin-top: 0 ;
114  margin-bottom: 0 ;
115  margin-left: 1.5em }
116
117div.sidebar {
118  margin: 0 0 0.5em 1em ;
119  border: medium outset ;
120  padding: 1em ;
121  background-color: #ffffee ;
122  width: 40% ;
123  float: right ;
124  clear: right }
125
126div.sidebar p.rubric {
127  font-family: sans-serif ;
128  font-size: medium }
129
130div.system-messages {
131  margin: 5em }
132
133div.system-messages h1 {
134  color: red }
135
136div.system-message {
137  border: medium outset ;
138  padding: 1em }
139
140div.system-message p.system-message-title {
141  color: red ;
142  font-weight: bold }
143
144div.topic {
145  margin: 2em }
146
147h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
148h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
149  margin-top: 0.4em }
150
151h1.title {
152  text-align: center }
153
154h2.subtitle {
155  text-align: center }
156
157hr.docutils {
158  width: 75% }
159
160img.align-left {
161  clear: left }
162
163img.align-right {
164  clear: right }
165
166ol.simple, ul.simple {
167  margin-bottom: 1em }
168
169ol.arabic {
170  list-style: decimal }
171
172ol.loweralpha {
173  list-style: lower-alpha }
174
175ol.upperalpha {
176  list-style: upper-alpha }
177
178ol.lowerroman {
179  list-style: lower-roman }
180
181ol.upperroman {
182  list-style: upper-roman }
183
184p.attribution {
185  text-align: right ;
186  margin-left: 50% }
187
188p.caption {
189  font-style: italic }
190
191p.credits {
192  font-style: italic ;
193  font-size: smaller }
194
195p.label {
196  white-space: nowrap }
197
198p.rubric {
199  font-weight: bold ;
200  font-size: larger ;
201  color: maroon ;
202  text-align: center }
203
204p.sidebar-title {
205  font-family: sans-serif ;
206  font-weight: bold ;
207  font-size: larger }
208
209p.sidebar-subtitle {
210  font-family: sans-serif ;
211  font-weight: bold }
212
213p.topic-title {
214  font-weight: bold }
215
216pre.address {
217  margin-bottom: 0 ;
218  margin-top: 0 ;
219  font: inherit }
220
221pre.literal-block, pre.doctest-block {
222  margin-left: 2em ;
223  margin-right: 2em }
224
225span.classifier {
226  font-family: sans-serif ;
227  font-style: oblique }
228
229span.classifier-delimiter {
230  font-family: sans-serif ;
231  font-weight: bold }
232
233span.interpreted {
234  font-family: sans-serif }
235
236span.option {
237  white-space: nowrap }
238
239span.pre {
240  white-space: pre }
241
242span.problematic {
243  color: red }
244
245span.section-subtitle {
246  /* font-size relative to parent (h1..h6 element) */
247  font-size: 80% }
248
249table.citation {
250  border-left: solid 1px gray;
251  margin-left: 1px }
252
253table.docinfo {
254  margin: 2em 4em }
255
256table.docutils {
257  margin-top: 0.5em ;
258  margin-bottom: 0.5em }
259
260table.footnote {
261  border-left: solid 1px black;
262  margin-left: 1px }
263
264table.docutils td, table.docutils th,
265table.docinfo td, table.docinfo th {
266  padding-left: 0.5em ;
267  padding-right: 0.5em ;
268  vertical-align: top }
269
270table.docutils th.field-name, table.docinfo th.docinfo-name {
271  font-weight: bold ;
272  text-align: left ;
273  white-space: nowrap ;
274  padding-left: 0 }
275
276h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
277h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
278  font-size: 100% }
279
280ul.auto-toc {
281  list-style-type: none }
282
283</style>
284</head>
285<body>
286<div class="document" id="ircaam-manuals">
287<h1 class="title">IRCAAM manuals</h1>
288
289<div class="section" id="shell-scripts">
290<h1>Shell scripts</h1>
291<p><a class="reference internal" href="#ircaam-profile-sh">ircaam_profile.sh</a></p>
292<p><a class="reference internal" href="#dlogd-sh">dlogd.sh</a></p>
293<p><a class="reference internal" href="#elogd-sh">elogd.sh</a></p>
294<p><a class="reference internal" href="#plogd-sh">plogd.sh</a></p>
295<p><a class="reference internal" href="#tlogd-sh">tlogd.sh</a></p>
296</div>
297<div class="section" id="matlab-scripts">
298<h1>MATLAB scripts</h1>
299<p><a class="reference internal" href="#ircaam-startup-m">ircaam_startup.m</a></p>
300</div>
301<div class="section" id="id1">
302<span id="ircaam-profile-sh"></span><h1>ircaam_profile.sh</h1>
303<div class="section" id="name">
304<h2>NAME</h2>
305<p>ircaam_profile.sh - define IRCAAM environnement</p>
306</div>
307<div class="section" id="synopsys">
308<h2>SYNOPSYS</h2>
309<p>Online usage</p>
310<pre class="literal-block">
311$ . ./ircaam_profile.sh -d directory -i indir -o outdir -t tempdir
312</pre>
313<p>In ${HOME}/.profile, add the following line</p>
314<pre class="literal-block">
315. ircaam_profile.sh -d directory  -i indir -o outdir -t tempdir
316</pre>
317</div>
318<div class="section" id="description">
319<h2>DESCRIPTION</h2>
320<p>define IRCAAM environnement</p>
321<p>${IRCAAM} is the base directory of tools.</p>
322<p>${IRCAAM_LOG} is the directory where log files  will be written.</p>
323<p>${IRCAAM_ID} is the directory where input files must be.</p>
324<p>${IRCAAM_OD} is the directory where output files will be written.</p>
325<p>MANPATH++</p>
326</div>
327<div class="section" id="see-also">
328<h2>SEE ALSO</h2>
329<p>for matlab/octave environment :</p>
330<p><a class="reference internal" href="#ircaam-startup-m">ircaam_startup.m</a></p>
331</div>
332<div class="section" id="examples">
333<h2>EXAMPLES</h2>
334<p>For fplod, on aedon.locean-ipsl.upmc.fr:</p>
335<pre class="literal-block">
336$ cd /usr/home/fplod/incas/ircaam/ircaam_ws/src/
337$ . ./ircaam_profile.sh \
338  -d $(pwd) \
339  -i /usr/temp/${LOGNAME}/ircaam_d/ \
340  -o /usr/temp/${LOGNAME}/ircaam_d/ \
341  -t /usr/temp/${LOGNAME}/log/
342</pre>
343<p>For fplod on zeus.locean-ipsl.umpc.fr:</p>
344<pre class="literal-block">
345$ cd ${HOME}/incas/ircaam/ircaam_ws/src/
346$ . ./ircaam_profile.sh \
347  -d $(pwd) \
348  -i /usr/temp/${LOGNAME}/ircaam_d/ \
349  -o /usr/temp/${LOGNAME}/ircaam_d/ \
350  -t /usr/temp/${LOGNAME}/log/
351</pre>
352</div>
353<div class="section" id="files">
354<h2>FILES</h2>
355<div class="section" id="original-location">
356<h3>original location</h3>
357<p>/usr/home/fplod/incas/ircaam/ircaam_ws/src/ircaam_profile.sh sur aedon.locean-ipsl.upmc.fr</p>
358</div>
359</div>
360<div class="section" id="todo">
361<h2>TODO</h2>
362</div>
363<div class="section" id="evolutions">
364<h2>EVOLUTIONS</h2>
365<p>++ option bavarde</p>
366<p>++ machine dependant</p>
367<p>++ besoin de posix</p>
368<p>++ pas de MANPATH defini par défaut sur zeus</p>
369<p>++ climserv</p>
370<p>$Id: ircaam_profile.sh 7 2008-12-12 10:39:06Z pinsard $</p>
371<ul class="simple">
372<li>fplod 2008-08-14T12:28:16Z aedon.locean-ipsl.upmc.fr (Darwin)</li>
373</ul>
374<blockquote>
375<ul class="simple">
376<li>move all *.sh and *.pro files to src/</li>
377</ul>
378</blockquote>
379<ul class="simple">
380<li>fplod 2008-07-21T10:58:47Z aedon.locean-ipsl.upmc.fr (Darwin)<ul>
381<li>creation</li>
382</ul>
383</li>
384</ul>
385</div>
386</div>
387<div class="section" id="id2">
388<span id="dlogd-sh"></span><h1>dlogd.sh</h1>
389<div class="section" id="id3">
390<h2>NAME</h2>
391<p>dlogd.sh - prompt for destruction of the most recent release of ${IRCAAM_LOG}/action.log.YYYY-MM-DDTHH:MM:SSZ</p>
392</div>
393<div class="section" id="synopsis">
394<h2>SYNOPSIS</h2>
395<pre class="literal-block">
396$ dlogd.sh action
397</pre>
398</div>
399<div class="section" id="id4">
400<h2>DESCRIPTION</h2>
401<p><tt class="docutils literal"><span class="pre">dlogd.sh</span></tt> prompt for destruction of the most recent release of ${IRCAAM_LOG}/action.log.YYYY-MM-DDTHH:MM:SSZ.</p>
402</div>
403<div class="section" id="id5">
404<h2>SEE ALSO</h2>
405<p><a class="reference internal" href="#ircaam-profile-sh">ircaam_profile.sh</a></p>
406<p><a class="reference internal" href="#elogd-sh">elogd.sh</a></p>
407<p><a class="reference internal" href="#plogd-sh">plogd.sh</a></p>
408<p><a class="reference internal" href="#tlogd-sh">tlogd.sh</a></p>
409</div>
410<div class="section" id="id6">
411<h2>FILES</h2>
412<div class="section" id="id7">
413<h3>original location</h3>
414<p>/usr/home/fplod/incas/ircaam/ircaam_ws/src/dlogd.sh sur cerbere.locean-ipsl.upmc.fr</p>
415</div>
416</div>
417<div class="section" id="id8">
418<h2>EVOLUTIONS</h2>
419<p>$Id: dlogd.sh 2 2008-12-03 15:56:27Z pinsard $</p>
420<ul class="simple">
421<li>fplod 2006-02-20T16:44:33Z aedon.lodyc.jussieu.fr (Darwin)<ul>
422<li>posix</li>
423</ul>
424</li>
425</ul>
426</div>
427</div>
428<div class="section" id="id9">
429<span id="elogd-sh"></span><h1>elogd.sh</h1>
430<div class="section" id="id10">
431<h2>NAME</h2>
432<p>elogd.sh - edit the most recent ${IRCAAM_LOG}/action.log.YYYY-MM-DDTHH:MM:SSZ</p>
433</div>
434<div class="section" id="id11">
435<h2>SYNOPSIS</h2>
436<pre class="literal-block">
437$ elogd.sh action
438</pre>
439</div>
440<div class="section" id="id12">
441<h2>DESCRIPTION</h2>
442<p><tt class="docutils literal"><span class="pre">elogd.sh</span></tt> launch ${EDITOR} on the most recent release of ${IRCAAM_LOG}/action.log.YYYY-MM-DDTHH:MM:SSZ.</p>
443</div>
444<div class="section" id="id13">
445<h2>SEE ALSO</h2>
446<p><a class="reference internal" href="#ircaam-profile-sh">ircaam_profile.sh</a></p>
447<p><a class="reference internal" href="#dlogd-sh">dlogd.sh</a></p>
448<p><a class="reference internal" href="#plogd-sh">plogd.sh</a></p>
449<p><a class="reference internal" href="#tlogd-sh">tlogd.sh</a></p>
450</div>
451<div class="section" id="id14">
452<h2>FILES</h2>
453<div class="section" id="id15">
454<h3>original location</h3>
455<p>/usr/home/fplod/incas/ircaam/ircaam_ws/src/elogd.sh sur cerbere.locean-ipsl.upmc.fr</p>
456</div>
457</div>
458<div class="section" id="id16">
459<h2>EVOLUTIONS</h2>
460<p>$Id: elogd.sh 2 2008-12-03 15:56:27Z pinsard $</p>
461<ul class="simple">
462<li>fplod 2006-02-20T16:38:30Z aedon.lodyc.jussieu.fr (Darwin)<ul>
463<li>posix</li>
464</ul>
465</li>
466</ul>
467</div>
468</div>
469<div class="section" id="id17">
470<span id="plogd-sh"></span><h1>plogd.sh</h1>
471<div class="section" id="id18">
472<h2>NAME</h2>
473<p>plogd.sh - prints the most recent release of ${IRCAAM_LOG}/action.log.YYYY-MM-DDTHH:MM:SSZ</p>
474</div>
475<div class="section" id="id19">
476<h2>SYNOPSIS</h2>
477<pre class="literal-block">
478$ plogd.sh action
479</pre>
480</div>
481<div class="section" id="id20">
482<h2>DESCRIPTION</h2>
483<p><tt class="docutils literal"><span class="pre">plogd.sh</span></tt> prints the most recent release of ${IRCAAM_LOG}/action.log.YYYY-MM-DDTHH:MM:SSZ.</p>
484<p>It uses a2ps application.</p>
485<p>Print is one on the default printer.</p>
486</div>
487<div class="section" id="id21">
488<h2>SEE ALSO</h2>
489<p><a class="reference internal" href="#ircaam-profile-sh">ircaam_profile.sh</a></p>
490<p><a class="reference internal" href="#dlogd-sh">dlogd.sh</a></p>
491<p><a class="reference internal" href="#elogd-sh">elogd.sh</a></p>
492<p><a class="reference internal" href="#tlogd-sh">tlogd.sh</a></p>
493</div>
494<div class="section" id="id22">
495<h2>FILES</h2>
496<div class="section" id="id23">
497<h3>original location</h3>
498<p>/usr/home/fplod/incas/ircaam/ircaam_ws/src/plogd.sh sur cerbere.locean-ipsl.upmc.fr</p>
499</div>
500</div>
501<div class="section" id="id24">
502<h2>EVOLUTIONS</h2>
503<p>$Id: plogd.sh 7 2008-12-12 10:39:06Z pinsard $</p>
504<ul class="simple">
505<li>fplod 2006-02-20T16:15:35Z aedon.lodyc.jussieu.fr (Darwin)<ul>
506<li>posix</li>
507</ul>
508</li>
509</ul>
510</div>
511</div>
512<div class="section" id="id25">
513<span id="tlogd-sh"></span><h1>tlogd.sh</h1>
514<div class="section" id="id26">
515<h2>NAME</h2>
516<p>tlogd.sh -  shows the most recent release of ${IRCAAM_LOG}/action.log.YYYY-MM-DDTHH:MM:SSZ</p>
517</div>
518<div class="section" id="id27">
519<h2>SYNOPSIS</h2>
520<pre class="literal-block">
521$ tlogd.sh action
522</pre>
523</div>
524<div class="section" id="id28">
525<h2>DESCRIPTION</h2>
526<p><tt class="docutils literal"><span class="pre">tlogd.sh</span></tt> shows the most recent release of ${IRCAAM_LOG}/action.log.YYYY-MM-DDTHH:MM:SSZ.</p>
527</div>
528<div class="section" id="id29">
529<h2>SEE ALSO</h2>
530<p><a class="reference internal" href="#ircaam-profile-sh">ircaam_profile.sh</a></p>
531<p><a class="reference internal" href="#dlogd-sh">dlogd.sh</a></p>
532<p><a class="reference internal" href="#elogd-sh">elogd.sh</a></p>
533<p><a class="reference internal" href="#plogd-sh">plogd.sh</a></p>
534</div>
535<div class="section" id="id30">
536<h2>FILES</h2>
537<div class="section" id="id31">
538<h3>original location</h3>
539<p>/usr/home/fplod/incas/ircaam/ircaam_ws/src/tlogd.sh sur cerbere.locean-ipsl.upmc.fr</p>
540</div>
541</div>
542<div class="section" id="id32">
543<h2>EVOLUTIONS</h2>
544<p>$Id: tlogd.sh 7 2008-12-12 10:39:06Z pinsard $</p>
545<ul class="simple">
546<li>fplod 2008-11-26T10:13:13Z aedon.locean-ipsl.upmc.fr (Darwin)<ul>
547<li>replace PROJECT_LOG by IRCAAM_LOG</li>
548</ul>
549</li>
550<li>fplod 2008-03-18T09:15:57Z ajax.locean-ipsl.upmc.fr (Linux)<ul>
551<li>replace FORVAN_LOG by PROJECT_LOG</li>
552</ul>
553</li>
554<li>fplod 2006-02-20T16:08:33Z aedon.lodyc.jussieu.fr (Darwin)<ul>
555<li>posix</li>
556</ul>
557</li>
558</ul>
559</div>
560</div>
561<div class="section" id="id33">
562<span id="ircaam-startup-m"></span><h1>ircaam_startup.m</h1>
563<div class="section" id="module">
564<h2>module</h2>
565<p>initialisation of matlab/octave environment for IRCAAM project</p>
566</div>
567<div class="section" id="id34">
568<h2>DESCRIPTION</h2>
569<dl class="docutils">
570<dt>Define :</dt>
571<dd><ul class="first last simple">
572<li>path for matlab/octave commands used in IRCAAM project</li>
573<li>IO directories</li>
574</ul>
575</dd>
576</dl>
577<p>This file can be either run classicaly when currect directory
578is ${IRCAAM} :
579..</p>
580<blockquote>
581&gt;&gt; ircaam_startup</blockquote>
582<p>If linked or copy to ${HOME}/startup.m, it will be automaticaly
583run by matlab at start.</p>
584</div>
585<div class="section" id="id35">
586<h2>SEE ALSO</h2>
587<p><a class="reference internal" href="#ircaam-profile-sh">ircaam_profile.sh</a></p>
588</div>
589<div class="section" id="id36">
590<h2>EVOLUTIONS</h2>
591<p>$Id$</p>
592<ul class="simple">
593<li>fplod 2008-12-22T09:38:20Z zeus.locean-ipsl.upmc.fr (Linux)<ul>
594<li>creation</li>
595</ul>
596</li>
597</ul>
598</div>
599<div class="section" id="id37">
600<h2>TODO</h2>
601</div>
602</div>
603</div>
604</body>
605</html>
Note: See TracBrowser for help on using the repository browser.