- Timestamp:
- 11/10/09 14:27:46 (15 years ago)
- Location:
- trunk/SRC/Documentation/xmldoc
- Files:
-
- 5 added
- 2 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/xmldoc/How_to_use_post_it.xml
r157 r159 35 35 http://forge.ipsl.jussieu.fr/post_it/attachment/wiki/WikiStart/How_to_use_post_it.pdf 36 36 37 http://forge.ipsl.jussieu.fr/post_it/wiki/Doc/Chap1, http://forge.ipsl.jussieu.fr/post_it/wiki/Doc/Chap2, http://forge.ipsl.jussieu.fr/post_it/wiki/Doc/Chap3 et38 http://forge.ipsl.jussieu.fr/post_it/wiki/Doc/Chap4 (empty)39 40 figures ?41 42 37 lien sur nino_* box 43 38 44 39 extract of .pro files 40 41 pro files to generate images 42 43 @ should be avoid in filenames (see notes) 44 45 NOTES 46 ===== 47 48 figgif/2L24_SST-SPECTRUM_T_NINO_3_1marobaset412_100y.gif 49 is a renamed copy of 2L24_SST-SPECTRUM_T_NINO_3_1m@t412_100y.gif. 45 50 46 51 EVOLUTIONS … … 50 55 $Id$ 51 56 57 - fplod 20091110T111733Z aedon.locean-ipsl.upmc.fr (Darwin) 58 * revison according to http://forge.ipsl.jussieu.fr/post_it/wiki/Doc/Chap1, http://forge.ipsl.jussieu.fr/post_it/wiki/Doc/Chap2, http://forge.ipsl.jussieu.fr/post_it/wiki/Doc/Chap3 et http://forge.ipsl.jussieu.fr/post_it/wiki/Doc/Chap4 (empty) 59 * add images 60 52 61 - fplod 20091106T162838Z aedon.locean-ipsl.upmc.fr (Darwin) 53 62 54 * going on hand correction of OpenOffice DocBook (strange characters "Â|" 55 63 * going on hand correction of OpenOffice DocBook (strange characters "Â|" 64 octal 240) 56 65 57 66 - fplod 2009-09-29T16:04:19Z aedon.locean-ipsl.upmc.fr (Darwin) 58 67 59 60 68 * creation from 69 /usr/home/mklod/DOC-POST-IT/How_to_use_post_it.odt save as DocBook with OpenOffice and hand correction 61 70 62 71 --> … … 64 73 <title>&project; software for beginners</title> 65 74 <authorgroup> 66 67 68 75 <author><personname><firstname>Michel</firstname> <surname>Kolasinski</surname></personname></author> 76 <author><personname><firstname>Éric</firstname> <surname>Guilyardi</surname></personname> <email>Eric.Guilyardi_at_locean-ipsl.upmc.fr</email></author> 77 <author><personname><firstname>Françoise</firstname> <surname>Pinsard</surname></personname> <email>Francoise.Pinsard_at_locean-ipsl.upmc.fr</email></author> 69 78 </authorgroup> 70 71 72 73 74 75 79 <keywordset> 80 <keyword>&project;</keyword> 81 <keyword>SAXO</keyword> 82 <keyword>IDL</keyword> 83 </keywordset> 84 <pubdate>$Id$</pubdate> 76 85 77 86 </info> 78 87 <chapter> 79 88 <title>General introduction</title> 80 89 <para><application>&project;</application> has been developped in <application>IDL</application> by <person><personname><firstname>Éric</firstname> <surname>Guilyardi</surname></personname></person>. 81 90 It uses <application>SAXO</application> routines which has been developped by <person><personname><firstname>Sébastien</firstname> <surname>Masson</surname></personname></person> 82 91 <footnote> … … 85 94 </para> 86 95 </footnote>. 87 <application>&project;</application> may help visualise and analyse ++netcdfdata outputs from models automaticly without knowing properly the <application>SAXO</application> routines.96 <application>&project;</application> may help visualise and analyse NetCDF data outputs from models automaticly without knowing properly the <application>SAXO</application> routines. 88 97 However we recommend the user to have some notions of <application>IDL</application> to use this software. 89 A good way to do this is also to read the <application>SAXO</application> documentation on <link xl:href="http://forge.ipsl.jussieu.fr/saxo/"/> 90 98 A good way to do this is also to read the <application>SAXO</application> documentation on <link xl:href="http://forge.ipsl.jussieu.fr/saxo/"/>. 99 </para> 91 100 <sect1> 92 101 <title>Directories and files</title> 93 94 95 96 97 98 99 <para><filename class="directory">SAXO</filename> (which can be a link to <person><personname><firstname>Sébastien</firstname> <surname>Masson</surname></personname></person>'s directory <filename class="directory">/usr/home/smasson/SAXO_DIR/SRC/</filename> if you have an account in LOCEAN or once again dowload the sources through <application>svn</application>).</para>100 101 102 <para>You should create two directories in your home directory : 103 <orderedlist> <!-- ++ variablelist--> 104 <listitem> 105 <para><filename class="directory">POST_IT</filename> (where to download the sources through <application>svn</application>)</para> 106 </listitem> 107 <listitem> 108 <para><filename class="directory">SAXO</filename> (which can be a link to <person><personname><firstname>Sébastien</firstname> <surname>Masson</surname></personname></person>'s directory <filename class="directory">/usr/home/smasson/SAXO_DIR/SRC/</filename> if you have an account in LOCEAN or once again download the sources through <application>svn</application>).</para> 109 </listitem> 110 </orderedlist> 102 111 </para> 103 112 <para><application>&project;</application> has a new structure since it has been managed by a <application>svn</application> server. 104 113 The <filename class="directory">POST_IT</filename> directory contains 7 main directories : 105 106 </para> 107 114 <filename class="directory">config</filename>, <filename class="directory">doc</filename>, <filename class="directory">grids</filename>, <filename class="directory">out</filename>, <filename class="directory">procs</filename>, <filename class="directory">tools</filename> and <filename class="directory">usr</filename>. 115 </para> 116 <para>The main files which the user will have to change are : 108 117 <screen> 109 118 <prompt>$</prompt> <userinput>ls POST_IT/usr/</userinput> 110 119 <computeroutput> 111 ++ résultat du ls ++lien de POST_IT/usr ++ pourqoui de lien 120 total 248 121 -rw-r--r-- 1 fplod lodyc 5568 Nov 4 17:48 correl.pro 122 lrwxrwxrwx 1 fplod lodyc 8 Nov 4 17:48 i.pro -> init.pro 123 -rw-r--r-- 1 fplod lodyc 2968 Nov 4 17:48 init.pro 124 lrwxrwxrwx 1 fplod lodyc 5 Nov 4 17:48 p -> p.pro 125 -rw-r--r-- 1 fplod lodyc 45 Nov 4 17:48 p.pro 126 -rw-r--r-- 1 fplod lodyc 9445 Nov 4 17:48 plt_def.pro 127 -rw-r--r-- 1 fplod lodyc 59351 Nov 4 17:48 post_it.pro 128 -rw-r--r-- 1 fplod lodyc 46866 Nov 4 17:48 post_it2.pro 129 lrwxrwxrwx 1 fplod lodyc 18 Nov 4 17:48 r.pro -> ../procs/reset.pro 112 130 </computeroutput> 113 131 </screen> … … 116 134 <sect1> 117 135 <title>Launch <application>IDL</application> and use <application>&project;</application></title> 118 119 136 <itemizedlist> 137 <listitem> 120 138 <para>Parametrize the <filename>init.pro</filename> file (the path variable where to find <application>&project;</application> and <application>SAXO</application> directories are mandatory. 121 You can leave the default values on other directories such as homedir)</para>122 123 124 125 139 You can leave the default values on other directories such as <varname>homedir</varname>)</para> 140 </listitem> 141 <listitem> 142 <para>Launch <application>IDL</application> in the <filename class="directory">usr</filename> directory : 143 <screen> 126 144 <prompt>$</prompt> <userinput>idl</userinput> 127 145 <computeroutput> <!-- ++ au moins version 6.4 --> 128 129 130 146 IDL Version 6.2 (linux x86 m32). (c) 2005, Research Systems, Inc. 147 Installation number: 500138. 148 Licensed for use by: CNRS/ IPSL 131 149 </computeroutput> 132 150 </screen> 133 151 </para> 134 </listitem> 135 <listitem> 136 <para>Execute the <filename>init.pro</filename> file in the <application>IDL</application> window (@init or @i if you made a link : ln -s init.pro i) 137 <screen> 152 <para> 153 <envar>IDL_STARTUP should be unset</envar>. <!-- sinon ça marche pas !!--> 154 </para> 155 </listitem> 156 <listitem> 157 <para>Execute the <filename>init.pro</filename> file in the <application>IDL</application> window (<command>@init</command> or <command>@i</command> if you made a link : <command>ln -s init.pro i</command>) 158 <screen> 138 159 <prompt>&promptidl;</prompt> <userinput>@init</userinput> 139 160 <computeroutput> 140 141 % Compiled module: KEEP_COMPATIBILITY. 142 % Compiled module: FIND. 143 % Compiled module: PATH_SEP. 144 ...................... 161 % Compiled module: KEEP_COMPATIBILITY. 162 % Compiled module: FIND. 163 % Compiled module: PATH_SEP. 164 % Compiled module: STRSPLIT. 165 % Compiled module: DEF_MYUNIQUETMPDIR. 166 % Compiled module: FILE_WHICH. 167 % Compiled module: UNIQ. 168 % Compiled module: DIFFERENT. 169 We keep the compatibility with the old version 170 % Compiled module: DEMOMODE_COMPATIBILITY. 171 % Compiled module: COMPUTEGRID. 172 % Compiled module: DOMDEF. 173 % Compiled module: INTER. 174 % Compiled module: CALDAT. 175 % Compiled module: MERGEONLINE_HELP. 176 % Compiled module: ISADIRECTORY. 177 % Compiled module: LCT. 178 % Compiled module: LOADCT. 145 179 </computeroutput> 146 147 </para> 148 </listitem> 149 150 151 152 <prompt>&promptidl;</prompt> <userinput>@ &project;</userinput>180 </screen> 181 </para> 182 </listitem> 183 <listitem> 184 <para>Execute the <filename>post_it.pro</filename> in the <application>IDL</application> window (@p or p if you made a link : ln -s p.pro p) 185 <screen> 186 <prompt>&promptidl;</prompt> <userinput>@post_it</userinput> 153 187 <computeroutput> 154 155 156 157 158 % Compiled module: DECODE_CMD.159 ........................188 % Compiled module: P. 189 % Compiled module: POST_IT. 190 % Compiled module: DEF_WORK. 191 % Compiled module: PLT_DEF. 192 % Compiled module: POST_IT2. 193 % Compiled module: DECODE_CMD. 160 194 </computeroutput> 161 162 </screen> 163 </para> 164 </listitem> 165 </itemizedlist> 195 </screen> 196 </para> 197 </listitem> 198 </itemizedlist> 166 199 </sect1> 167 200 </chapter> … … 170 203 <sect1> 171 204 <title>General description and a first example</title> 172 205 <para><filename>post_it.pro</filename> is the file in which you will work. 173 206 It defines the in line commands 174 207 <footnote> … … 181 214 <para>For instance : 182 215 <screen> 183 cmdline = [ $ 184 ; var on exp grid plt timeave date1 spec disp proj out 185 'sohtc300 1 2L24 T xy 100y 1860 - 1 1 v', $ 186 'lastline 0' ] 187 </screen> 188 </para> 189 <para>This means that you want the <varname>sohtc300</varname> variable to be visualised from a netcdf file called <filename>2L24_100y_1860_*_grid_T.nc</filename> on a 2d plot 'xy'.</para> 190 <para> The result is the following picture. 191 <inlinegraphic fileref="embedded:graphics1" width="17.591cm" depth="12.212cm"/> 192 </para> 193 <para>As a consequence, the names of the netcdf files are standardized and follow this pattern : 194 <filename><replaceable>Experiment</replaceable>_<replaceable>Frequency</replaceable>_<replaceable>Date1</replaceable>_<replaceable>Date2</replaceable>_<replaceable>Grid Type</replaceable>.nc</filename> 216 cmdline = [ $ 217 ; var on exp grid plt timeave date1 spec disp proj out 218 'sohtc300 1 2L24 T xy 100y 1860 - 1 1 v', $ 219 'lastline 0' ] 220 </screen> 221 </para> 222 <para>This means that you want the <varname>sohtc300</varname> variable to be visualised from a NetCDF file called <filename>2L24_100y_1860_*_grid_T.nc</filename> on a 2D plot 'xy'.</para> 223 <para> The result is the following picture (the quality is better in Postscript format than in GIF format below). 224 <mediaobject> 225 <imageobject> 226 <imagedata fileref="figgif/2L24_HTC300_TROP_100y.gif" format="GIF"/> 227 </imageobject> 228 <textobject><phrase>[2L24_HTC300_TROP_100y.gif]</phrase></textobject> 229 </mediaobject> 230 231 </para> 232 <para>As a consequence, the names of the NetCDF files are standardized and follow this pattern : 233 <filename><replaceable>Experiment</replaceable>_<replaceable>Frequency</replaceable>_<replaceable>Date1</replaceable>_<replaceable>Date2</replaceable>_<replaceable>Grid Type</replaceable>.nc</filename> 195 234 </para> 196 235 </sect1> … … 198 237 <title>More details about the variables defined in <filename>post_it.pro</filename></title> 199 238 <itemizedlist> 200 <listitem> 201 <para>Variable <varname>spec_base_list</varname> defines where to find a specific database of files. 202 It should begins with the name of the experiment (here all files beginning with <constant>CMAP_</constant>) 203 <screen> 204 spec_base_list = [ $ 205 CMAP = local:/home2/mkdlod/database/CORREL/', $ 206 ' '] 207 </screen> 208 </para> 209 </listitem> 210 <listitem> 211 <para>Variable <varname>data_base_list</varname> defines also where to find by default all the databases ('ncdf_db'). 212 Il also allows to define generic databases. 239 <listitem> 240 <para>Variable <varname>spec_base_list</varname> defines where to find a specific database of files. 241 It should begins with the name of the experiment (here all files beginning with <constant>CMAP_</constant>). 242 <screen> 243 spec_base_list = [ $ 244 'CMAP = local:/home2/mkdlod/database/CORREL/', $ 245 ' '] 246 </screen> 247 </para> 248 </listitem> 249 <listitem> 250 <para>Variable <varname>data_base_list</varname> defines also where to find by default all the databases (<varname>ncdf_db</varname>). 251 </para> 252 <para> 253 It also allows to define generic databases. 254 </para> 255 <para> 213 256 For instance, <constant>MRI_db</constant> defines all files beginning with <constant>MRI</constant> : it can be <constant>MRI_</constant>, <constant>MRIoCTL</constant>, <constant>MRIo2X</constant> … 214 215 data_base_list =$216 217 218 219 220 </para> 221 222 223 <para>Variable <varname>out_ps</varname> defines where to find the postscriptsfiles generated and puts them in the <filename>iodir</filename> directory224 225 226 227 </para> 228 229 230 <para>Variables <varname>prt_BW</varname>, <varname>prt_col</varname>, <varname>prt_tra</varname> define the unix print command you want to use for printing postscriptsfiles.257 <screen> 258 data_base_list = [ $ 259 'ncdf_db = local:/home2/mkdlod/database/', $ 260 'MRI_db = local:/home2/mkdlod/ERIC-LSCE/database/IPCC/', $ 261 ' '] 262 </screen> 263 </para> 264 </listitem> 265 <listitem> 266 <para>Variable <varname>out_ps</varname> defines where to find the PostScript files generated and puts them in the <filename>iodir</filename> directory 267 <screen> 268 out_ps = homedir+'/Post_out/' 269 </screen> 270 </para> 271 </listitem> 272 <listitem> 273 <para>Variables <varname>prt_BW</varname>, <varname>prt_col</varname>, <varname>prt_tra</varname> define the unix print command you want to use for printing PostScript files. 231 274 This does not work at the moment in my case !!!!!! 232 233 234 235 236 237 </para> 238 239 240 241 <para>Variable <varname>++</varname> :242 243 244 245 </para> 246 247 248 <para>Variable <varname>++</varname> :249 250 251 252 </para> 253 254 255 256 275 <screen> 276 prt_BW = 'lpl' 277 prt_col = 'x4' 278 prt_tra = 'lprdgt' 279 </screen> 280 </para> 281 </listitem> 282 283 <listitem> 284 <para>Variable <varname>lp_opt</varname> : 285 <screen> 286 lp_opt = '' 287 </screen> 288 </para> 289 </listitem> 290 <listitem> 291 <para>Variable <varname>ghost</varname> : 292 <screen> 293 ghost = 'lpg' 294 </screen> 295 </para> 296 </listitem> 297 298 <listitem> 299 <para>Variable <varname>out_all</varname> : if you want to override all the local <varname>out</varname> options (each in line command has a specific <varname>out</varname> option). 257 300 For instance, you visualised 10 plots already and you want to print them all. 258 301 Instead of setting all the individual in line <varname>out</varname> options, you set <varname>out_all</varname> to <constant>ps</constant> once and for all. 259 302 By default, it shoud be set to <constant>-</constant> to avoid to override local <varname>out</varname> options. 260 261 262 263 </para> 264 265 266 267 </para> 268 303 <screen> 304 out_all = '-' 305 </screen> 306 </para> 307 </listitem> 308 <listitem> 309 <para>Variable <varname>other_file</varname> : Instead of using the file <filename>post_it.pro</filename> to read the in line commands, you would like to use another file (<filename>post_it.pro</filename> might be too big). 310 </para> 311 <para>For this purpose, set the variable <varname>other_file</varname> to the name of the other file. 269 312 By default, it is set to <constant>-</constant>, which means <filename>post_it.pro</filename> has to be read. 270 313 Pay attention to the fact that the structure of the other file is bit different from <filename>post_it.pro</filename> since you should only find the <varname>cmdline2</varname> variable (similar to <varname>cmdline</varname> from <filename>post_it.pro</filename>) in it. 271 272 273 274 275 276 277 </para> 278 279 280 281 314 <screen> 315 other_file = 'ipcc' 316 other_file = 'post_it_test' 317 other_file = 'post_it2' 318 other_file = '-' 319 </screen> 320 </para> 321 </listitem> 322 323 <listitem> 324 <para>Variable <varname>cmdline</varname> : In this very long variable, you set the plot you want to see or print. 282 325 Please check the other example below : 283 284 285 ; var on exp grid plt timave date1 spec dispproj out286 'precip 1 2L24 lmdzl xt_pac_eq 1mm 01_1860-1959 12_1860-19592P 1 v', $287 'topl 0 2L24 lmdzl xt_pac_eq 1mm 01_1860-1959 12_1860-19591 1 v', $288 289 290 </para> 291 292 326 <screen> 327 cmdline = [ $ 328 ; var on exp grid plt timave date1 spec disp proj out 329 'precip 1 2L24 lmdzl xt_pac_eq 1mm 01_1860-1959 12_1860-1959 2P 1 v', $ 330 'topl 0 2L24 lmdzl xt_pac_eq 1mm 01_1860-1959 12_1860-1959 1 1 v', $ 331 'lastline 0' ] 332 </screen> 333 </para> 334 335 <para>This in line command allows to see 2 plots on the same window ('Paysage' format). 293 336 These are the seasonnal cycle of precipitation (called precip) and OLR (called topl) for the <constant>2L24</constant> experiment along the equator (<constant>x</constant> -> longitude, <constant>t</constant> -> time). 294 337 The variable is averaged zonally on the box 'pac_eq' which is defined in <filename>domain_boxes.def</filename> file. … … 296 339 The file should contains 12 mean months from January to December and those mean months are carried out on 100 years from 1860 to 1959. 297 340 The result is the following picture. 298 <inlinegraphic fileref="embedded:graphics3" width="13.124cm" depth="20.109cm"/> 299 </para> 341 <mediaobject> 342 <imageobject> 343 <imagedata fileref="figgif/2L24_PRECIP_OLR_XT_PACEQ_1mm_100y.gif" format="GIF"/> 344 </imageobject> 345 <textobject><phrase>[2L24_PRECIP_OLR_XT_PACEQ_1mm_100y.gif]</phrase></textobject> 346 </mediaobject> 347 </para> 300 348 </listitem> 301 349 </itemizedlist> 302 350 <para>At the end of the <filename>post_it.pro</filename> file, the program is launched through the following command : 303 351 <screen> 304 352 <prompt>&promptidl;</prompt> <userinput>def_work, data_base_list, out_ps, cmdline, out_all, other_file, spec_base_list</userinput> 305 353 </screen> 306 </para>307 <para>308 <screen>309 cmdline = [ $310 ; var on exp grid plt timeave date1 spec disp proj out311 'lastline 0' ]312 </screen>313 354 </para> 314 355 </sect1> 315 356 <sect1> 316 357 <title>Usage of command line ?</title> 317 <itemizedlist> 318 <listitem> 319 <para><varname>var</varname> : The name of the field is usually the long_name stored in the netcdf file. 320 If you add '@@' at the beginning, it means that &project; will read <filename>fld_macros.def</filename> to get the right macro to launch (for instance, compute the standard deviation of the sosstsst field through @@sosstdev) 321 <programlisting> 322 ; var : <name> of field 323 ; @@<name> for macro defined in Defaults/fld_macros.def 324 ; <name1>=f(<name2>) for scatter plot y=f(x) or 325 ; <name1>=f(next) to use next line as 'x' (uses time interval of name1) 326 ; <name>@s<sigma> to plot <name> on isopycnal <sigma> 327 '@@sosstdev 1 CDT3 T xyt 1m@t412 187001 196912 1 1 v', $ 328 </programlisting> 329 </para> 330 </listitem> 331 <listitem> 332 <para><varname>on</varname> : If you want to see a plot, set this variable to <constant>1</constant>. 358 <para> 359 <screen> 360 cmdline = [ $ 361 ; var on exp grid plt timave date1 spec disp proj out 362 'lastline 0' ] 363 </screen> 364 </para> 365 <itemizedlist> 366 <listitem> 367 <para><varname>var</varname> : The name of the field is usually the <literal>long_name</literal> stored in the NetCDF file. 368 If you add '@@' at the beginning, it means that &project; will read <filename>fld_macros.def</filename> to get the right macro to launch (for instance, compute the standard deviation of the <varname>sosstsst</varname> field through <command>@@sosstdev</command>) 369 <programlisting> 370 ; var : <name> of field 371 ; @@<name> for macro defined in Defaults/fld_macros.def 372 ; <name1>=f(<name2>) for scatter plot y=f(x) or 373 ; <name1>=f(next) to use next line as 'x' (uses time interval of name1) 374 ; <name>@s<sigma> to plot <name> on isopycnal <sigma> 375 cmdline = [ $ 376 ; var on exp grid plt timave date1 spec disp proj out 377 '@@sosstdev 1 CDT3 T xyt 1m@t412 187001 196912 1 1 v', $ 378 'lastline 0' ] 379 </programlisting> 380 </para> 381 </listitem> 382 <listitem> 383 <para><varname>on</varname> : If you want to see a plot, set this variable to <constant>1</constant>. 333 384 When you want several plots on the same window, you may hide one of these by setting <varname>on</varname> to <constant>2</constant>. 334 385 It will leave a blank space where the plot should have been drawn. 335 <programlisting> 336 ; on : 0/1 (2 = empty window in multi-window plot) 337 '@@sosstdev 1 CDT3 T xyt 1m@t412 187001 196912 2x2 1 v', $ 338 '@@sotoxdev 2 CDT3 U xyt 1m@t412 187001 196912 1 1 v', $ 339 '@@sotoxdev 0 CDT3 U xyt 1m@t412 187001 196912 1 1 v', $ 340 '@@sotoydev 0 CDT3 V xyt 1m@t412 187001 196912 1 1 v', $ 341 </programlisting> 342 </para> 343 </listitem> 344 <listitem> 345 <para><varname>exp</varname> : If you want to make a difference between 2 experiments, you 2 have options. 346 This is the first one. 347 Pay attention to the fact that the 2 files should have the same <varname>var</varname> name, the same 'grid', the same 'timeave', the same 'plt', the same 'date1' … 348 <programlisting> 349 ; exp : name of exp. For difference of 2 exp : <exp1>-<exp2> 350 ; For division of 2 exp : <exp1>/<exp2> 351 'sozotaux 1 CD2-2L24 U xt_pac_eq 1mm 01_1860-1959 12_1860-1959 2P 1 v', $ 352 </programlisting> 353 </para> 354 </listitem> 355 <listitem> 356 <para><varname>grid</varname> : The grid type defines the grids (regular or irregular like the ORCA grid) to read.</para> 357 <para>For instance, &project; will read grids_ncpt62.nc which is stored in <filename>IDL/Defaults/Grids</filename>. 386 <programlisting> 387 ; on : 0/1 (2 = empty window in multi-window plot) 388 cmdline = [ $ 389 ; var on exp grid plt timave date1 spec disp proj out 390 '@@sosstdev 1 CDT3 T xyt 1m@t412 187001 196912 2x2 1 v', $ 391 '@@sotoxdev 2 CDT3 U xyt 1m@t412 187001 196912 1 1 v', $ 392 '@@sotoxdev 0 CDT3 U xyt 1m@t412 187001 196912 1 1 v', $ 393 '@@sotoydev 0 CDT3 V xyt 1m@t412 187001 196912 1 1 v', $ 394 'lastline 0' ] 395 </programlisting> 396 </para> 397 </listitem> 398 <listitem xml:id="var_exp"> 399 <para><varname>exp</varname> : If you want to make a difference between 2 experiments, you have two options. 400 </para> 401 <para> 402 This is the first one<footnote><para>cf. for the second one <xref linkend="var_spec"/></para></footnote> : Pay attention to the fact that the 2 files should have the same <varname>var</varname> name, the same <varname>grid</varname>, the same <varname>timeave</varname>, the same <varname>plt</varname>, the same <varname>date1</varname>, … 403 <programlisting> 404 ; exp : name of exp. For difference of 2 exp : <exp1>-<exp2> 405 ; For division of 2 exp : <exp1>/<exp2> 406 cmdline = [ $ 407 ; var on exp grid plt timave date1 spec disp proj out 408 'sozotaux 1 CD2-2L24 U xt_pac_eq 1mm 01_1860-1959 12_1860-1959 2P 1 v', $ 409 'lastline 0' ] 410 </programlisting> 411 </para> 412 </listitem> 413 <listitem> 414 <para><varname>grid</varname> : The grid type defines the grids (regular or irregular like the ORCA grid) to read.</para> 415 <para>For instance, &project; will read <filename>grids_ncpt62.nc</filename> which is stored in <filename>IDL/Defaults/Grids</filename>. 358 416 This grid is considered as regular (because you specified it in <filename>plt_def.pro</filename> in the variable <varname>nc_grid_list</varname>). 359 This file contains 3 variables : the land sea mask fraction, latitudes as a 1D variable and longitudes as a 1D variables. 360 And &project; through &SAXO; routines will build the grid with the help of those variables : gphit (eg latitudes), glamt (longitudes), tmask (masks on T-points), e1t (scale factor along x), e2t (scale factor along y) as 2d variables … Usually the atmospheric grids are regular. 361 You can get easily the <filename>grids_*</filename> files through the IPCC database. 417 This file contains 3 variables : the land sea mask fraction, latitudes as a 1D variable and longitudes as a 1D variable. 418 And &project; through &SAXO; routines will build the grid with the help of those variables : <varname>gphit</varname> (eg latitudes), <varname>glamt</varname> (longitudes), <varname>tmask</varname> (masks on T-points), <varname>e1t</varname> (scale factor along x), <varname>e2t</varname> (scale factor along y) as 2D variables … 419 </para> 420 <para>Usually the atmospheric grids are regular. 421 You can get easily the <filename>grids_*</filename> files through the IPCC database 362 422 <footnote> 363 423 <para> 364 Have a look on <link xl:href="http://www-pcmdi.llnl.gov/ipcc/standard_output.html#overview"/>424 <link xl:href="http://www-pcmdi.llnl.gov/ipcc/standard_output.html#overview">IPCC Standard Output from Coupled Ocean-Atmosphere GCMs</link> 365 425 </para> 366 426 </footnote> 367 with the variable <varname>sftlf</varname> and build a new âgridâ. 368 At the moment, only 2d field can be read from these grid. 369 </para> 370 <para>If the variable is stored in an irregular grid, things are a bit more complicated to build a new grid readable by &project; and &SAXO;. 371 You will need to build a file where the variables gphit, glamt, glamu, glamv, tmask … are already stored. 427 with the variable <varname>sftlf</varname> and build a new grid. 428 At the moment, only 2D field can be read from these grids. 429 </para> 430 <para>If the variable is stored in an irregular grid, things are a bit more complicated to build a new grid readable by &project; and &SAXO;. 431 You will need to build a file where the variables <varname>gphit</varname>, <varname>glamt</varname>, <varname>glamu</varname>, <varname>glamv</varname>, <varname>tmask</varname> … are already stored. 432 </para> 433 <para> 372 434 For the moment, the ORCA grid (NEMO, IPSL) and the MICOM grid (BCM model, NERSC) can be read (even 3D fields). 373 435 These grids are Arakawa C-type with T, U, V and F points. 374 <programlisting> 375 ; grid : grid name or @<grid> (to read grid from data file) 376 'precip 1 NCEP ncpt62 xy 58y 1948 - 1 1 v', $ 377 </programlisting> 378 <inlinegraphic fileref="embedded:graphics4" width="17.591cm" depth="11.741cm"/> 379 </para> 380 </listitem> 381 <listitem> 382 <para><varname>plt</varname> : This parameter defines the kind of plot you want to see. 436 <programlisting> 437 ; grid : grid name or @<grid> (to read grid from data file) 438 cmdline = [ $ 439 ; var on exp grid plt timave date1 spec disp proj out 440 'precip 1 NCEP ncpt62 xy 58y 1948 - 1 1 v', $ 441 'lastline 0' ] 442 </programlisting> 443 <mediaobject> 444 <imageobject> 445 <imagedata fileref="figgif/NCEP_PRECIP_TROP_58y.gif" format="GIF"/> 446 </imageobject> 447 <textobject><phrase>[NCEP_PRECIP_TROP_58y.gif]</phrase></textobject> 448 </mediaobject> 449 </para> 450 </listitem> 451 <listitem> 452 <para><varname>plt</varname> : This parameter defines the kind of plot you want to see. 383 453 It will define some features for the &SAXO; plot routines. 384 You can perform 2d maps, hovmoeller diagrams, simple time series, spectrum of time series … 385 <programlisting> 386 ; plt : xy, xz, yz, x, y, z [append _<box> or _#<bathy>] 387 ; {xt, yt, zt, t}_<box>[@f<direc><width>][@s][@z][@r<win>] 388 ; <box> : defined in Default/hovmoel_box.def 389 ; <bathy> : first letters of bathymetry file in Default/Grids 390 ; <direc> : t,x,y,z = filtering/smoothing direction (default: t) 391 ; <width> : running mean filter width (default = 1) 392 ; grid point smoothing for space 393 ; @r<win> : time serie stddev in running <win>dow 394 ; : spectrum of time serie 395 ; : wavelet of time serie 396 ; z : remove zonal mean (eddy field) from 2D field (xy 397 ; plot only) 398 ; density bining plots : xs, ys, s [append _<box> or _#<bathy>] 399 ; st_<box>[@f<direc><width>][@s] 400 ; statistics : @@<variable> 2D plot: plt=xyt 401 ; 402 'sosstsst 1 2L24 T t_nino_3@s 1m@t412 186001 195912 1 1 v', $ 403 </programlisting> 404 <inlinegraphic fileref="embedded:graphics2" width="17.591cm" depth="11.02cm"/> 405 </para> 406 </listitem> 407 <listitem> 408 <para><varname>timeave</varname> : The time average defines the duration on which the files have been averaged. 454 You can perform 2D maps, hovmoeller diagrams, simple time series, spectrum of time series … 455 <programlisting> 456 ; plt : xy, xz, yz, x, y, z [append _<box> or _#<bathy>] 457 ; {xt, yt, zt, t}_<box>[@f<direc><width>][@s][@z][@r<win>] 458 ; <box> : defined in Default/hovmoel_box.def 459 ; <bathy> : first letters of bathymetry file in Default/Grids 460 ; <direc> : t,x,y,z = filtering/smoothing direction (default: t) 461 ; <width> : running mean filter width (default = 1) 462 ; grid point smoothing for space 463 ; @r<win> : time serie stddev in running <win>dow 464 ; : spectrum of time serie 465 ; : wavelet of time serie 466 ; z : remove zonal mean (eddy field) from 2D field (xy 467 ; plot only) 468 ; density bining plots : xs, ys, s [append _<box> or _#<bathy>] 469 ; st_<box>[@f<direc><width>][@s] 470 ; statistics : @@<variable> 2D plot: plt=xyt 471 ; 472 cmdline = [ $ 473 ; var on exp grid plt timave date1 spec disp proj out 474 'sosstsst 1 2L24 T t_nino_3@s 1m@t412 186001 195912 1 1 v', $ 475 'lastline 0' ] 476 </programlisting> 477 <mediaobject> 478 <imageobject> 479 <imagedata fileref="figgif/2L24_SST-SPECTRUM_T_NINO_3_1marobaset412_100y.gif" format="GIF"/> 480 </imageobject> 481 <textobject><phrase>[2L24_SST-SPECTRUM_T_NINO_3_1marobaset412_100y.gif]</phrase></textobject> 482 </mediaobject> 483 </para> 484 </listitem> 485 <listitem> 486 <para><varname>timeave</varname> : The time average defines the duration on which the files have been averaged. 409 487 For instance, you will have <constant>1m</constant>, <constant>1mm</constant>, <constant>1y</constant>, <constant>32y</constant>. 410 488 You may add a trend to that : do you want to remove the seasonal cycle from the time series ? Thus the trend shoud be @t412. 411 Or if you want to write data in another netcdf file, the trend should be @t9 (in that case, you will also have to define the <varname>out</varname> parameter â see below).412 413 414 415 416 417 418 419 420 421 422 423 424 425 </para> 426 427 428 <para><varname>date1</varname> : The name of the netcdffile should have some indications of dates (for instance, <filename>2L24_1m_186001_195912_grid_T.nc</filename>).429 If you only want to visualize the monthly mean SST of May 1871, you will have to specify 187105as the <varname>date1</varname> parameter.489 Or if you want to write data in another NetCDF file, the trend should be @t9 (in that case, you will also have to define the <varname>out</varname> parameter - see below ++ lien). 490 <programlisting> 491 ; timeave : <n>[m]<timeave>[@t<trend>] 492 ; n: integer, timeave: of d(ay),m(onth),y(ear) 493 ; [m] stands for mean <timeave> 494 ; -> requires spec for date interval (of mean): 495 ; [date_i]-[date_f] 496 ; <trend> : time serie trend type (default = 0, in this 497 ; case, use @t9 to 498 ; activate data output writing - out=data) 499 ; @t412: remove mean SC 500 ; @t41: remove mean of time serie 501 ; 502 </programlisting> 503 </para> 504 </listitem> 505 <listitem> 506 <para><varname>date1</varname> : The name of the NetCDF file should have some indications of dates (for instance, <filename>2L24_1m_186001_195912_grid_T.nc</filename>). 507 If you only want to visualize the monthly mean SST of <constant>May 1871</constant>, you will have to specify <constant>187105</constant> as the <varname>date1</varname> parameter. 430 508 It is not compulsory to specify any final date for the <varname>spec</varname> parameter in that case : <constant>-</constant> will be enough. 431 The dates specified in the name of the file and the dates specified in <filename>post_it.pro</filename> should be coherent since the netcdf file only contains time steps : in our example, May, 1871 should corresponds to the 137th time step in the file. 432 Dates can go down to daily scales (18710510) and you can even specify seconds. 433 <programlisting> 434 ; date1 : [yy..yyy][mm][dd]-[sssss][_<ave_period>] 435 ; <ave_period> for mean <timeave> : date interval <date_i>-<date_f> 436 ; 437 </programlisting> 438 </para> 439 </listitem> 440 <listitem> 441 <para><varname>spec</varname> : This parameter has two meanings. 442 It may define the ending date of a 1d plot (SST anomaly averaged over Nino_3 region as a function of time). 443 But it may set parameters for a to make differences between two plots : this is the second way to make differences. 444 <programlisting> 445 ; spec : time serie : date2 446 ; difference : d:<exp>/<timeave>/<date1>[/<spec2>] 447 'votemper 1 CD2 T xz_pac_eq300 100y 1870 d:2L24/100y/1860 1 1 v', $ 448 </programlisting> 449 </para> 450 </listitem> 451 <listitem> 452 <para><varname>disp</varname> : the kind of display is set with this parameter. 509 The dates specified in the name of the file and the dates specified in <filename>post_it.pro</filename> should be coherent since the NetCDF file only contains time steps : in our example, <constant>May, 1871</constant> should corresponds to the <constant>137</constant>th time step in the file. 510 Dates can go down to daily scales (<constant>18710510</constant>) and you can even specify seconds. 511 <programlisting> 512 ; date1 : [yy..yyy][mm][dd]-[sssss][_<ave_period>] 513 ; <ave_period> for mean <timeave> : date interval <date_i>-<date_f> 514 ; 515 </programlisting> 516 </para> 517 </listitem> 518 <listitem xml:id="var_spec"> 519 <para><varname>spec</varname> : This parameter has two meanings. <!-- deux sens c'est pas bon !!! ++--> 520 </para> 521 <para> 522 It may define the ending date of a 1D plot (SST anomaly averaged over Nino_3 region as a function of time). 523 </para> 524 <para> 525 It also set parameters to make differences between two plots : this is the second way to make differences<footnote><para>cf. for the first one <xref linkend="var_exp"/></para></footnote>. 526 <programlisting> 527 ; spec : time serie : date2 528 ; difference : d:<exp>/<timeave>/<date1>[/<spec2>] 529 cmdline = [ $ 530 ; var on exp grid plt timave date1 spec disp proj out 531 'votemper 1 CD2 T xz_pac_eq300 100y 1870 d:2L24/100y/1860 1 1 v', $ 532 'lastline 0' ] 533 </programlisting> 534 </para> 535 </listitem> 536 <listitem> 537 <para><varname>disp</varname> : the kind of display is set with this parameter. 453 538 You can specify if you want several plots on the same window and how they will be organised on it. 539 </para> 540 <para> 454 541 By default, plots are carried out with a landscape view. 542 </para> 543 <para> 455 544 For the example below, <varname>disp</varname> is set to <constant>2x2</constant> and the plot would have been the same with <constant>2x2L</constant>. 456 545 Please notice that you don't have to set <varname>on</varname> to <constant>1</constant> at each line : the first line is enough ; &project; understands that it has to consider four lines for the plot. 457 <programlisting> 458 ; disp : multi-window display n[x<m>][<orient>] <orient> = P (L is default) 459 'sosstsst 1 CD2 T xy 100y 1870 d:2L24/100y/1860 2x2 1 v', $ 460 'tsol 0 CD2 lmdzl xy 100y 1870 d:2L24/100y/1860 1 1 v', $ 461 'sozotaux 0 CD2 U xy 100y 1870 d:2L24/100y/1860 1 1 v', $ 462 'sometauy 0 CD2 V xy 100y 1870 d:2L24/100y/1860 1 1 v', $ 463 </programlisting> 464 </para> 465 </listitem> 466 <listitem> 467 <para><varname>out</varname> : the kind of outputs you want is set with this parameter. 468 You may want to see 'raw' data without processing. 469 In that case, <varname>out</varname> has to be set to <constant>tv</constant>. 470 This plot will be similar to a call to a <command>pltv</command> <!--++ lien avec doc saxo--> &SAXO; routine (you will be able to click on 2d map with your mouse and see point-to-point values). 471 You may want to write processed data (Wind stresses standard deviations, SST anomaly averaged over nino_3 region as a function of time, …) in another netcdf file. 472 In that case, <varname>out</varname> has to be set to <constant>data</constant>. 473 You may want to print your plot into a ps file ('ps') after having visualised it ('v') or directly print it to the printer ('psc') -> does not work ????? 474 <programlisting> 475 ; out : v (view), tv (tvnplot), ps[prt] PostScript, data (ascii, 476 ; requires timeave + @t9) or (t)cdf (netCDF file) 477 ; prt = b : BW printer 478 ; prt = c : color printer 479 ; prt = t : transparent printer 480 ; to save postcript activate save_ps in plt_def 481 ; tcdf: pltt netCDF writing (t, xt, yt types) 482 </programlisting> 483 </para> 484 </listitem> 485 </itemizedlist> 546 <programlisting> 547 ; disp : multi-window display n[x<m>][<orient>] <orient> = P (L is default) 548 cmdline = [ $ 549 ; var on exp grid plt timave date1 spec disp proj out 550 'sosstsst 1 CD2 T xy 100y 1870 d:2L24/100y/1860 2x2 1 v', $ 551 'tsol 0 CD2 lmdzl xy 100y 1870 d:2L24/100y/1860 1 1 v', $ 552 'sozotaux 0 CD2 U xy 100y 1870 d:2L24/100y/1860 1 1 v', $ 553 'sometauy 0 CD2 V xy 100y 1870 d:2L24/100y/1860 1 1 v', $ 554 'lastline 0' ] 555 </programlisting> 556 </para> 557 </listitem> 558 <listitem> 559 <para><varname>out</varname> : the kind of outputs you want is set with this parameter. 560 You may want to see <quote>raw</quote> data without processing. 561 In that case, <varname>out</varname> has to be set to <constant>tv</constant>. 562 This plot will be similar to a call to a <command>pltv</command> <!--++ lien avec doc saxo--> &SAXO; routine (you will be able to click on 2D map with your mouse and see point-to-point values). 563 You may want to write processed data (Wind stresses standard deviations, SST anomaly averaged over nino_3 region as a function of time, …) in another 564 NetCDF file. 565 In that case, <varname>out</varname> has to be set to <constant>data</constant>. 566 You may want to print your plot into a Postscript file ('ps') after having visualised it ('v') or directly print it to the printer ('psc') (not yet working) <!--++--> 567 <programlisting> 568 ; out : v (view), tv (tvnplot), ps[prt] PostScript, data (ascii, 569 ; requires timeave + @t9) or (t)cdf (netCDF file) 570 ; prt = b : BW printer 571 ; prt = c : color printer 572 ; prt = t : transparent printer 573 ; to save postcript activate save_ps in plt_def 574 ; tcdf: pltt netCDF writing (t, xt, yt types) 575 </programlisting> 576 </para> 577 </listitem> 578 </itemizedlist> 486 579 </sect1> 487 580 </chapter> 488 581 <chapter> 489 582 <title>File <filename>plt_def.pro</filename></title> 490 <para>The file <filename>plt_def.pro</filename> is important because it sets some global variables declared in <filename>com_eg.pro</filename>. 491 If you want to add a new global varaible, you'll have to modify <filename>com_eg.pro</filename> and <filename>plt_def.pro</filename>.</para> 492 <itemizedlist> 493 <listitem> 494 <para><varname>box_h</varname> : It will define the area read in the netcdf file. 495 <programlisting> 496 ; horizontal domain 497 box_h = [20,380,-30,30] 498 </programlisting> 499 </para> 500 </listitem> 501 <listitem> 502 <para><varname>glamboundary_box</varname> : the longitudes range shown on the plot is set with this parameter. 503 In that case, the first longitude shown on the left is 20° and the last one is 380° (360°+20°). 504 <programlisting> 505 glamboundary_box = [20, 380] 506 </programlisting> 507 </para> 508 </listitem> 509 <listitem> 510 <para>Those parameters set the limits for the ocean models in depth and for the atmospheric models in altitude (pressure). 511 <programlisting> 512 ; vertical domain 513 depth_z = 5000 514 zoom_z = 400 515 hpa_min = 10 516 hpa_max = 500 517 </programlisting> 518 </para> 519 </listitem> 520 <listitem> 521 <para><varname>msf_mean</varname> : Useful for the computation of the meridional stream function in the macro (<filename>make_msf2.pro</filename>). 522 Keyword used for the definition of the dimensions of the computed data. 523 <programlisting> 524 msf_mean = 0 525 </programlisting> 526 </para> 527 </listitem> 528 <listitem> 529 <para>Those parameters define the the boxes on which the average is made. 530 <programlisting> 531 ; vert_type = 'level' ; 'z' for depth/altitude or 'level' or '0' for nothing 532 vert_type = '0' 533 vert_mean = [1, 1] ; [depth1,depth2] or [level1,level2] in C notation 0-jpk-1 534 </programlisting> 535 </para> 536 </listitem> 537 <listitem> 538 <para>Useful for density projection plots (<constant>xs</constant>, <constant>ys</constant>, <constant>s_</constant>, <constant>st</constant> plot types). 539 <programlisting> 540 ; density domain (sigma) + delta sigma 541 sig_min = 20. 542 sig_max = 27. 543 sig_del = 0.2 544 sig_bowl = 0 ; 0/1 bowl overlay on density binned plots 545 </programlisting> 546 </para> 547 </listitem> 548 <listitem> 549 <para>Useful when comparing time-series on the same plot. 550 <programlisting> 551 ; cross-correlation and normalisation: 552 c_normal = 0 ; normalise data serie 553 c_correl = 1 ; when overlay of 1d curves : 0/1 554 lag_correl = 12L ; bound for lagged-correlation [-lag_correl,..,0,...,lag_correl] 555 </programlisting> 556 </para> 557 </listitem> 558 <listitem> 559 <para>Useful when studying the seasonal inter-annual variability for a given field. 583 <para>The file <filename>plt_def.pro</filename> is important because it sets some global variables declared in <filename>com_eg.pro</filename>. 584 If you want to add a new global varaible, you'll have to modify <filename>com_eg.pro</filename> and <filename>plt_def.pro</filename>.</para> 585 <itemizedlist> 586 <listitem> 587 <para><varname>box_h</varname> : It will define the area read in the NetCDF file. 588 <programlisting> 589 ; horizontal domain 590 box_h = [20,380,-30,30] 591 </programlisting> 592 </para> 593 </listitem> 594 <listitem> 595 <para><varname>glamboundary_box</varname> : the longitudes range shown on the plot is set with this parameter. 596 In that case, the first longitude shown on the left is 20° and the last one is 380° (360°+20°). 597 <programlisting> 598 glamboundary_box = [20, 380] 599 </programlisting> 600 </para> 601 </listitem> 602 <listitem> 603 <para>Those parameters set the limits for the ocean models in depth and for the atmospheric models in altitude (pressure). 604 <programlisting> 605 ; vertical domain 606 depth_z = 5000 607 zoom_z = 400 608 hpa_min = 10 609 hpa_max = 500 610 </programlisting> 611 </para> 612 </listitem> 613 <listitem> 614 <para><varname>msf_mean</varname> : Useful for the computation of the meridional stream function in the macro (<filename>make_msf2.pro</filename>). 615 Keyword used for the definition of the dimensions of the computed data. 616 <programlisting> 617 msf_mean = 0 618 </programlisting> 619 </para> 620 </listitem> 621 <listitem> 622 <para>Those parameters define the boxes on which the average is made. 623 <programlisting> 624 ; vert_type = 'level' ; 'z' for depth/altitude or 'level' or '0' for nothing 625 vert_type = '0' 626 vert_mean = [1, 1] ; [depth1,depth2] or [level1,level2] in C notation 0-jpk-1 627 </programlisting> 628 </para> 629 </listitem> 630 <listitem> 631 <para>Useful for density projection plots (<constant>xs</constant>, <constant>ys</constant>, <constant>s_</constant>, <constant>st</constant> plot types). 632 <programlisting> 633 ; density domain (sigma) + delta sigma 634 sig_min = 20. 635 sig_max = 27. 636 sig_del = 0.2 637 sig_bowl = 0 ; 0/1 bowl overlay on density binned plots 638 </programlisting> 639 </para> 640 </listitem> 641 <listitem> 642 <para>Useful when comparing time-series on the same plot. 643 <programlisting> 644 ; cross-correlation and normalisation: 645 c_normal = 0 ; normalise data serie 646 c_correl = 1 ; when overlay of 1d curves : 0/1 647 lag_correl = 12L ; bound for lagged-correlation [-lag_correl,..,0,...,lag_correl] 648 </programlisting> 649 </para> 650 </listitem> 651 <listitem> 652 <para>Useful when studying the seasonal inter-annual variability for a given 653 field. 560 654 It is used in the macro <filename>make_stddev.pro</filename> 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 </para> 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 </para> 611 612 613 655 <programlisting> 656 ; standard deviation 657 stddev_diff = 0 ; 0/1 (if = 1 makes a difference between the 658 ; std dev for a given month and the std dev of the whole time serie) 659 ; Active with the make_stddev macro for a given month (ex : @@sosstdev_01 for 660 ; sst std dev only for January) 661 </programlisting> 662 <programlisting> 663 ; axis 664 ; ---- 665 ; lat_axis : latitudinal axis : 'reg'ular or 'sin'us latitude 666 lat_axis = 'reg' 667 </programlisting> 668 <programlisting> 669 ; min /max 670 ; -------- 671 ; free minmax in 1D-plots (yes) or take fld_glo_mmx.def value (no) [yes] 672 free_1d_minmax = 'no' 673 </programlisting> 674 </para> 675 </listitem> 676 <listitem> 677 <para>Useful parameters for hovmoeller plots. 678 <programlisting> 679 ; Hovmoellers 680 ; ----------- 681 ; trend_typ : 0 no trend 682 ; 1 remove initial value to serie (trend) 683 ; 2 remove previous value to current (drift) 684 ; 3[<n>] remove serie to mean of <n> final values (inverse trend) 685 ; 4[<n>] remove [n]-average running mean of serie (anomaly) 686 ; for monthly serie use <n>=12 to remove mean 687 ; seasonal cycle 688 ; this value can be field-overriden by specifying @t<trend_typ> after 689 ; timave in post-it line 690 ; 6[<n>] time integral of field activation. <n> is the 691 ; number of previous time steps to integrate from 692 ; (default is from beginning of time serie) 693 ; 694 ; 695 ; field_int : field time integral (0/1) 696 ; nb_cycles : number of repeated cycles for seasonal time series 697 ; def_stride : default stride in hovmoeller sampling (see domain_boxes.def) 698 trend_typ = '0' 699 field_int = 0 700 nb_cycles = 2 701 def_stride = 1 702 asciidir = homedir+'out/ascii_out/' 703 </programlisting> 704 </para> 705 </listitem> 706 <listitem> 707 <para><varname>calendar_type</varname> : models usually have 360 days per year e.g. 30 days per month. 614 708 But some other models are a bit more complex and use more realistic calendars. 615 616 617 618 619 620 621 622 623 </para> 624 625 626 <para> 627 These parameters define some garphical options, whether you want a color palette or a black and white palette and if you want to put the colorbar on the plot or not.628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 </para> 643 644 645 646 647 648 649 650 651 652 653 654 </para> 655 656 657 709 <programlisting> 710 ; calendar type 711 ; 0: 365 days/year 712 ; 1: gregorian 713 ; N: N days per month 714 ; 715 calendar_type = 30 716 </programlisting> 717 </para> 718 </listitem> 719 <listitem> 720 <para> 721 These parameters define some graphical options, whether you want a color palette or a black and white palette and if you want to put the colorbar on the plot or not. 722 <programlisting> 723 ; shading : (fill) 1/0 724 ; pal_type: 'bw', 'col', '2dom' (2dom = read 2 domains in isolignes - ISOSP) 725 ; grey_shade: % of black for 2dom case 726 ; grey_shade_1/2: % of black for 2dom case : difference plots (-/+) 727 ; col_palette: 'yes' or 'no' (put colorbar or not) 728 ; 729 shading = 1 730 pal_type = 'col' 731 grey_shade = 20 732 grey_shade_1 = 5 733 grey_shade_2 = 20 734 col_palette = 'yes' 735 </programlisting> 736 </para> 737 </listitem> 738 <listitem> 739 <para><varname>cont_fill</varname> defines whether you want to mask the continents or not. 740 And <varname>cont_real</varname> is a keyword which sets the real continents or not. 741 <programlisting> 742 cont_fill = 1 ; continent fill for atmosphere grids (1/0) 743 cont_real = 0 ; draw real continents (0) 744 ; = 0 (no real continents drawn) 745 ; = 1 (real continents drawn instead of the mask) 746 ; = 2 (mask + real continents drawn) 747 </programlisting> 748 </para> 749 </listitem> 750 <listitem> 751 <para><varname>vector_sample</varname> defines the way vectors are shown on a vector plot. 658 752 In that case, it will draw one vector out of two.</para> 659 <programlisting> 660 vector_sample = 2 ; vector sampling (1) 661 ;; 662 </programlisting> 663 </listitem> 664 <listitem> 665 <para>Those parameters defines the thickness, the style and the colors of 1D curves. 666 Have a look on the on-line help (search for 'Line Annotation Properties' and 'Graphics keywords (collected)' in the 'Index' panel).</para> 667 <programlisting> 668 line_thick = [2,2,2,2,2,2,2,2] ; 1D plot line thickness (for each overlay curves) 669 line_style = [1,1,1,1,2,2,3,3] ; 1D plot line style (for each overlay curves) 670 line_color = [1,2,3,4,6,7,7,8] ; 1D plot line color (for each overlay curves) 671 ; 1=black; 2=red; 3=green; 4=blue; 6=purple 672 ; 43 ---- 90 ---- 160 ---- 190 ---- 210 ---- 254 673 ; blue turq green yell orange red 674 </programlisting> 675 </listitem> 676 <listitem> 677 <para>Those parameters are important for y=f(next) plots (for instance, zonal winds anomalies averaged on Nino_4 box over SST anomalies averaged on Nino_3 box).</para> 678 <programlisting> 679 symbol_families = '1' ; 4x3 number of colors in time symbol plots (modulo) 680 ; use <n> or <n>x<m> (n same colors, modulo nxm) 681 symbol_families = '4x3' 682 ;; symbol_families = '12x1' 683 symbol_style = [1,1,1,1,2,2,1,1,1,1,1,1] ; Symbol style (for each overlay symbol) 684 symbol_color = [1,2,3,4,2,3,7,8,9,10,11,12] ; Symbol line color (for each overlay symbol) 685 mean_sc_only = 0 686 ;; mean_sc_only = 4 ; 1 = Only plot mean SC in yfx when symbol_families='4x3' and hotyp=t 687 ; 2 = Only plot SC of std dev when symbol_families='4x3' and hotyp=t 688 ; (require 1m@t412) 689 ; 4 = Only plot ICS per month + errorbar when symbol_families='12x1' 690 </programlisting> 691 </listitem> 692 <listitem> 693 <para><varname>look</varname> defines how the drawn axis look like. 694 And <varname>contour_options</varname> defines whether you want to draw the contours or not.</para> 695 <programlisting> 696 ; Graphic keywords for axis, contours 697 ;; contour_options = ',/nocontour' ;;;;;; include this line to delete contour labels 698 contour_options = ',cell_fill=2' ;;;;;; include this line to include contour label 699 look = ',linestyle=0,xthick=2,ythick=2,zthick=2,sepdate='' ''' 700 </programlisting> 701 </listitem> 702 <listitem> 703 <para>When <varname>fill_space</varname> is set, it forces the plot the occupy the maximum space allowed. 753 <programlisting> 754 vector_sample = 2 ; vector sampling (1) 755 </programlisting> 756 </listitem> 757 <listitem> 758 <para>Those parameters defines the thickness, the style and the colors of 1D curves. 759 Have a look on the on-line help (search for <quote>Line Annotation Properties</quote> and <quote>Graphics keywords (collected)</quote> in the <quote>Index</quote> panel).</para> <!-- ++ lein sur doc IDL--> 760 <programlisting> 761 line_thick = [2,2,2,2,2,2,2,2] ; 1D plot line thickness (for each overlay curves) 762 line_style = [1,1,1,1,2,2,3,3] ; 1D plot line style (for each overlay curves) 763 line_color = [1,2,3,4,6,7,7,8] ; 1D plot line color (for each overlay curves) 764 ; 1=black; 2=red; 3=green; 4=blue; 6=purple 765 ; 43 ---- 90 ---- 160 ---- 190 ---- 210 ---- 254 766 ; blue turq green yell orange red 767 </programlisting> 768 </listitem> 769 <listitem> 770 <para>Those parameters are important for y=f(next) plots (for instance, zonal winds anomalies averaged on Nino_4 box over SST anomalies averaged on Nino_3 box).</para> 771 <programlisting> 772 symbol_families = '1' ; 4x3 number of colors in time symbol plots (modulo) 773 ; use <n> or <n>x<m> (n same colors, modulo nxm) 774 symbol_families = '4x3' 775 ;; symbol_families = '12x1' 776 symbol_style = [1,1,1,1,2,2,1,1,1,1,1,1] ; Symbol style (for each overlay symbol) 777 symbol_color = [1,2,3,4,2,3,7,8,9,10,11,12] ; Symbol line color (for each overlay symbol) 778 mean_sc_only = 0 779 ;; mean_sc_only = 4 ; 1 = Only plot mean SC in yfx when symbol_families='4x3' and hotyp=t 780 ; 2 = Only plot SC of std dev when symbol_families='4x3' and hotyp=t 781 ; (require 1m@t412) 782 ; 4 = Only plot ICS per month + errorbar when symbol_families='12x1' 783 </programlisting> 784 </listitem> 785 <listitem> 786 <para><varname>look</varname> defines how the drawn axis look like. 787 And <varname>contour_options</varname> defines whether you want to draw the contours or not.</para> 788 <programlisting> 789 ; Graphic keywords for axis, contours 790 ;; contour_options = ',/nocontour' ;;;;;; include this line to delete contour labels 791 contour_options = ',cell_fill=2' ;;;;;; include this line to include contour label 792 look = ',linestyle=0,xthick=2,ythick=2,zthick=2,sepdate='' ''' 793 </programlisting> 794 </listitem> 795 <listitem> 796 <para>When <varname>fill_space</varname> is set, it forces the plot to occupy the maximum space allowed. 704 797 <varname>marge_option</varname> may be used to reduce blank space between legends or plots of the same window. 705 798 And <varname>title_type</varname> defines whether you want to draw the titles and subtitles or not.</para> 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 799 <programlisting> 800 ; Use of page space and titles 801 ; marge_option : add or reduce marge around the plot ; suitable for 802 ; optimizing space when several plots on the same 803 ; window. See title_type and titles keyword below to 804 ; set it 805 fill_space = 1 ; fill space on plot (0/1) (/rempli option) ? 806 marge_option = 'marge=[0,0,2,2]' ; (use [0, 0, -2, -2] to fill up even more space 807 title_type = 'TS' ; default type of titles 808 ; 'T' for title only, 'S' for subtitle only 809 ; 'TS' for both 810 ; 'off' for no titles 811 </programlisting> 812 </listitem> 813 <listitem> 814 <para><varname>default_txt_format</varname> defines by default the legend to write along each 1D curve. 722 815 In that case, the name of the experiment will discriminate the different curves. 723 816 724 725 726 727 817 If you want to specify more information, you have to add a string of characters behind the <constant>1o</constant>. 818 <programlisting> 819 default_txt_format = 'E' ; default text in legend for 1D plots (E)xperiment(V)ariable[L]ong name[U]nits(B)ox 820 </programlisting> 728 821 </para> 729 822 </listitem> … … 731 824 </chapter> 732 825 <chapter> 733 <title>Files in the Defaultdirectory</title>734 826 <title>Files in the 'config' directory</title> 827 <para/> 735 828 </chapter> 736 829 </book> -
trunk/SRC/Documentation/xmldoc/makefile
r158 r159 107 107 $(DIRWIKI)/WhatsNew \ 108 108 $(DIRWIKI)/WhatisPost_it \ 109 $(DIRWIKI)/HowToUse post_it109 $(DIRWIKI)/HowToUsePost_it 110 110 @echo "Do not forget to import wiki pages" 111 111 @echo "\$$ ssh $(PRODUCT)@forge.ipsl.jussieu.fr mkdir -p /tmp/$(PRODUCT)/" … … 332 332 $< 333 333 334 $(DIRWIKI)/HowToUse post_it : \334 $(DIRWIKI)/HowToUsePost_it : \ 335 335 $(DIRTMP)/How_to_use_post_it_full.xml \ 336 336 $(SAXO_DIR)/SRC/Documentation/xmldoc/saxo_tracwiki.xsl \ … … 361 361 362 362 $(DIRTMP)/How_to_use_post_it_full.xml : \ 363 $(DIRSRC)/How_to_use_post_it.xml 364 @xmllint \ 365 --xinclude \ 366 --encode utf-8 \ 367 --noent \ 368 --output $@ \ 369 $< 363 $(DIRSRC)/How_to_use_post_it.xml \ 364 $(DIRSRC)/figgif/2L24_HTC300_TROP_100y.gif \ 365 $(DIRSRC)/figgif/2L24_PRECIP_OLR_XT_PACEQ_1mm_100y.gif \ 366 $(DIRSRC)/figgif/2L24_SST-SPECTRUM_T_NINO_3_1marobaset412_100y.gif \ 367 $(DIRSRC)/figgif/NCEP_PRECIP_TROP_58y.gif 368 @xmllint \ 369 --xinclude \ 370 --encode utf-8 \ 371 --noent \ 372 --output $@ \ 373 $<
Note: See TracChangeset
for help on using the changeset viewer.