Changeset 274f9ef in flex_extract.git for documentation/Sphinx/build/html
- Timestamp:
- Oct 22, 2018, 11:44:47 AM (6 years ago)
- Branches:
- master, ctbto, dev
- Children:
- db27c09
- Parents:
- 708c667
- Location:
- documentation/Sphinx/build/html
- Files:
-
- 43 added
- 22 edited
Legend:
- Unmodified
- Added
- Removed
-
documentation/Sphinx/build/html/_modules/index.html
r708c667 r274f9ef 150 150 151 151 <h1>All modules for which code is available</h1> 152 <ul><li><a href="disaggregation.html">disaggregation</a></li> 152 <ul><li><a href="ControlFile.html">ControlFile</a></li> 153 <li><a href="EcFlexpart.html">EcFlexpart</a></li> 154 <li><a href="GribTools.html">GribTools</a></li> 155 <li><a href="MarsRetrieval.html">MarsRetrieval</a></li> 156 <li><a href="UioFiles.html">UioFiles</a></li> 157 <li><a href="disaggregation.html">disaggregation</a></li> 158 <li><a href="get_mars_data.html">get_mars_data</a></li> 159 <li><a href="install.html">install</a></li> 160 <li><a href="prepare_flexpart.html">prepare_flexpart</a></li> 161 <li><a href="submit.html">submit</a></li> 153 162 <li><a href="tools.html">tools</a></li> 154 163 </ul> -
documentation/Sphinx/build/html/_modules/tools.html
r708c667 r274f9ef 213 213 <span class="c1"># ------------------------------------------------------------------------------</span> 214 214 215 <div class="viewcode-block" id="none_or_str"><a class="viewcode-back" href="../ code.html#tools.none_or_str">[docs]</a><span class="k">def</span> <span class="nf">none_or_str</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>216 <span class="sd">''' </span>217 <span class="sd"> @Description:</span>218 <span class="sd"> Converts the input string into pythons None-type if the string</span> 219 <span class="sd"> contains "None".</span>220 221 <span class="sd"> @Input:</span>222 <span class="sd"> value: string</span>223 <span class="sd"> String to be checked for the "None" word.</span> 224 225 <span class="sd"> @Return:</span>226 <span class="sd"> 227 <span class="sd"> 228 <span class="sd"> 215 <div class="viewcode-block" id="none_or_str"><a class="viewcode-back" href="../api.html#tools.none_or_str">[docs]</a><span class="k">def</span> <span class="nf">none_or_str</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> 216 <span class="sd">'''Converts the input string into pythons None-type if the string</span> 217 <span class="sd"> contains string "None".</span> 218 219 <span class="sd"> Parameters</span> 220 <span class="sd"> ----------</span> 221 <span class="sd"> value : :obj:`string`</span> 222 <span class="sd"> String to be checked for the "None" word.</span> 223 224 <span class="sd"> Return</span> 225 <span class="sd"> ------</span> 226 <span class="sd"> None or value:</span> 227 <span class="sd"> Return depends on the content of the input value. If it was "None",</span> 228 <span class="sd"> then the python type None is returned. Otherwise the string itself.</span> 229 229 <span class="sd"> '''</span> 230 230 <span class="k">if</span> <span class="n">value</span> <span class="o">==</span> <span class="s1">'None'</span><span class="p">:</span> … … 232 232 <span class="k">return</span> <span class="n">value</span></div> 233 233 234 <div class="viewcode-block" id="none_or_int"><a class="viewcode-back" href="../ code.html#tools.none_or_int">[docs]</a><span class="k">def</span> <span class="nf">none_or_int</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>235 <span class="sd">''' </span>236 <span class="sd"> @Description:</span>237 <span class="sd"> Converts the input string into pythons None-type if the string</span> 238 <span class="sd"> contains "None". Otherwise it is converted to an integer value.</span>239 240 <span class="sd"> @Input:</span>241 <span class="sd"> value: string</span>242 <span class="sd"> String to be checked for the "None" word.</span> 243 244 <span class="sd"> @Return:</span>245 <span class="sd"> 246 <span class="sd"> 247 <span class="sd"> 248 <span class="sd"> 234 <div class="viewcode-block" id="none_or_int"><a class="viewcode-back" href="../api.html#tools.none_or_int">[docs]</a><span class="k">def</span> <span class="nf">none_or_int</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> 235 <span class="sd">'''Converts the input string into pythons None-type if the string</span> 236 <span class="sd"> contains string "None". Otherwise it is converted to an integer value.</span> 237 238 <span class="sd"> Parameters</span> 239 <span class="sd"> ----------</span> 240 <span class="sd"> value : :obj:`string`</span> 241 <span class="sd"> String to be checked for the "None" word.</span> 242 243 <span class="sd"> Return</span> 244 <span class="sd"> ------</span> 245 <span class="sd"> None or int(value):</span> 246 <span class="sd"> Return depends on the content of the input value. If it was "None",</span> 247 <span class="sd"> then the python type None is returned. Otherwise the string is</span> 248 <span class="sd"> converted into an integer value.</span> 249 249 <span class="sd"> '''</span> 250 250 <span class="k">if</span> <span class="n">value</span> <span class="o">==</span> <span class="s1">'None'</span><span class="p">:</span> … … 252 252 <span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">value</span><span class="p">)</span></div> 253 253 254 <div class="viewcode-block" id="get_cmdline_arguments"><a class="viewcode-back" href="../code.html#tools.get_cmdline_arguments">[docs]</a><span class="k">def</span> <span class="nf">get_cmdline_arguments</span><span class="p">():</span> 255 <span class="sd">'''</span> 256 <span class="sd"> @Description:</span> 257 <span class="sd"> Decomposes the command line arguments and assigns them to variables.</span> 258 <span class="sd"> Apply default values for non mentioned arguments.</span> 259 260 <span class="sd"> @Input:</span> 261 <span class="sd"> <nothing></span> 262 263 <span class="sd"> @Return:</span> 264 <span class="sd"> args: instance of ArgumentParser</span> 265 <span class="sd"> Contains the commandline arguments from script/program call.</span> 254 <div class="viewcode-block" id="get_cmdline_arguments"><a class="viewcode-back" href="../api.html#tools.get_cmdline_arguments">[docs]</a><span class="k">def</span> <span class="nf">get_cmdline_arguments</span><span class="p">():</span> 255 <span class="sd">'''Decomposes the command line arguments and assigns them to variables.</span> 256 <span class="sd"> Apply default values for non mentioned arguments.</span> 257 258 <span class="sd"> Parameters</span> 259 <span class="sd"> ----------</span> 260 261 <span class="sd"> Return</span> 262 <span class="sd"> ------</span> 263 <span class="sd"> args : :obj:`Namespace`</span> 264 <span class="sd"> Contains the commandline arguments from script/program call.</span> 266 265 <span class="sd"> '''</span> 267 266 … … 342 341 <span class="k">return</span> <span class="n">args</span></div> 343 342 344 <div class="viewcode-block" id="read_ecenv"><a class="viewcode-back" href="../ code.html#tools.read_ecenv">[docs]</a><span class="k">def</span> <span class="nf">read_ecenv</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span>345 <span class="sd">''' </span>346 <span class="sd"> @Description:</span>347 <span class="sd"> Reads the file into a dictionary where the key values are the parameter</span> 348 <span class="sd"> names.</span>349 350 <span class="sd"> @Input:</span>351 <span class="sd"> filename: string</span>352 <span class="sd"> Path to file where the ECMWV environment parameters are stored.</span> 353 354 <span class="sd"> @Return:</span>355 <span class="sd"> envs: dict</span>356 <span class="sd"> 357 <span class="sd"> 343 <div class="viewcode-block" id="read_ecenv"><a class="viewcode-back" href="../api.html#tools.read_ecenv">[docs]</a><span class="k">def</span> <span class="nf">read_ecenv</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span> 344 <span class="sd">'''Reads the file into a dictionary where the key values are the parameter</span> 345 <span class="sd"> names.</span> 346 347 <span class="sd"> Parameters</span> 348 <span class="sd"> ----------</span> 349 <span class="sd"> filename : :obj:`string`</span> 350 <span class="sd"> Path to file where the ECMWF environment parameters are stored.</span> 351 352 <span class="sd"> Return</span> 353 <span class="sd"> ------</span> 354 <span class="sd"> envs : :obj:`dictionary`</span> 355 <span class="sd"> Contains the environment parameter ecuid, ecgid, gateway</span> 356 <span class="sd"> and destination for ECMWF server environments.</span> 358 357 <span class="sd"> '''</span> 359 358 <span class="n">envs</span><span class="o">=</span> <span class="p">{}</span> … … 366 365 <span class="k">return</span> <span class="n">envs</span></div> 367 366 368 <div class="viewcode-block" id="clean_up"><a class="viewcode-back" href="../code.html#tools.clean_up">[docs]</a><span class="k">def</span> <span class="nf">clean_up</span><span class="p">(</span><span class="n">c</span><span class="p">):</span> 369 <span class="sd">'''</span> 370 <span class="sd"> @Description:</span> 371 <span class="sd"> Remove all files from intermediate directory</span> 372 <span class="sd"> (inputdir from CONTROL file).</span> 373 374 <span class="sd"> @Input:</span> 375 <span class="sd"> c: instance of class ControlFile</span> 376 <span class="sd"> Contains all the parameters of CONTROL file and</span> 377 <span class="sd"> command line.</span> 378 <span class="sd"> For more information about format and content of the parameter</span> 379 <span class="sd"> see documentation.</span> 380 381 <span class="sd"> @Return:</span> 382 <span class="sd"> <nothing></span> 367 <div class="viewcode-block" id="clean_up"><a class="viewcode-back" href="../api.html#tools.clean_up">[docs]</a><span class="k">def</span> <span class="nf">clean_up</span><span class="p">(</span><span class="n">c</span><span class="p">):</span> 368 <span class="sd">'''Remove all files from intermediate directory (inputdir).</span> 369 370 <span class="sd"> Parameters</span> 371 <span class="sd"> ----------</span> 372 <span class="sd"> c : :obj:`ControlFile`</span> 373 <span class="sd"> Contains all the parameters of CONTROL file and</span> 374 <span class="sd"> command line.</span> 375 376 <span class="sd"> Return</span> 377 <span class="sd"> ------</span> 378 383 379 <span class="sd"> '''</span> 384 380 … … 397 393 398 394 399 <div class="viewcode-block" id="my_error"><a class="viewcode-back" href="../ code.html#tools.my_error">[docs]</a><span class="k">def</span> <span class="nf">my_error</span><span class="p">(</span><span class="n">users</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="s1">'ERROR'</span><span class="p">):</span>400 <span class="sd">''' </span>401 <span class="sd"> @Description:</span>402 <span class="sd"> Prints a specified error message which can be passed to the function</span> 403 <span class="sd"> before exiting the program.</span>404 405 <span class="sd"> @Input:</span>406 <span class="sd"> user: list of strings</span>407 <span class="sd"> Contains all email addresses which should be notified.</span>408 <span class="sd"> It might also contain just the ecmwf user name which wil trigger</span>409 <span class="sd"> mailing to the associated email address for this user.</span> 410 411 <span class="sd"> message: string, optional</span>412 <span class="sd"> Error message. Default value is "ERROR".</span> 413 414 <span class="sd"> @Return:</span>415 <span class="sd"> <nothing></span> 395 <div class="viewcode-block" id="my_error"><a class="viewcode-back" href="../api.html#tools.my_error">[docs]</a><span class="k">def</span> <span class="nf">my_error</span><span class="p">(</span><span class="n">users</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="s1">'ERROR'</span><span class="p">):</span> 396 <span class="sd">'''Prints a specified error message which can be passed to the function</span> 397 <span class="sd"> before exiting the program.</span> 398 399 <span class="sd"> Parameters</span> 400 <span class="sd"> ----------</span> 401 <span class="sd"> user : :obj:`list` of :obj:`string`</span> 402 <span class="sd"> Contains all email addresses which should be notified.</span> 403 <span class="sd"> It might also contain just the ecmwf user name which wil trigger</span> 404 <span class="sd"> mailing to the associated email address for this user.</span> 405 406 <span class="sd"> message : :obj:`string`, optional</span> 407 <span class="sd"> Error message. Default value is "ERROR".</span> 408 409 <span class="sd"> Return</span> 410 <span class="sd"> ------</span> 411 416 412 <span class="sd"> '''</span> 417 413 … … 443 439 444 440 445 <div class="viewcode-block" id="normal_exit"><a class="viewcode-back" href="../code.html#tools.normal_exit">[docs]</a><span class="k">def</span> <span class="nf">normal_exit</span><span class="p">(</span><span class="n">users</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="s1">'Done!'</span><span class="p">):</span> 446 <span class="sd">'''</span> 447 <span class="sd"> @Description:</span> 448 <span class="sd"> Prints a specific exit message which can be passed to the function.</span> 449 450 <span class="sd"> @Input:</span> 451 <span class="sd"> user: list of strings</span> 452 <span class="sd"> Contains all email addresses which should be notified.</span> 453 <span class="sd"> It might also contain just the ecmwf user name which wil trigger</span> 454 <span class="sd"> mailing to the associated email address for this user.</span> 455 456 <span class="sd"> message: string, optional</span> 457 <span class="sd"> Message for exiting program. Default value is "Done!".</span> 458 459 <span class="sd"> @Return:</span> 460 <span class="sd"> <nothing></span> 441 <div class="viewcode-block" id="normal_exit"><a class="viewcode-back" href="../api.html#tools.normal_exit">[docs]</a><span class="k">def</span> <span class="nf">normal_exit</span><span class="p">(</span><span class="n">users</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="s1">'Done!'</span><span class="p">):</span> 442 <span class="sd">'''Prints a specific exit message which can be passed to the function.</span> 443 444 <span class="sd"> Parameters</span> 445 <span class="sd"> ----------</span> 446 <span class="sd"> user : :obj:`list` of :obj:`string`</span> 447 <span class="sd"> Contains all email addresses which should be notified.</span> 448 <span class="sd"> It might also contain just the ecmwf user name which wil trigger</span> 449 <span class="sd"> mailing to the associated email address for this user.</span> 450 451 <span class="sd"> message : :obj:`string`, optional</span> 452 <span class="sd"> Message for exiting program. Default value is "Done!".</span> 453 454 <span class="sd"> Return</span> 455 <span class="sd"> ------</span> 461 456 462 457 <span class="sd"> '''</span> … … 485 480 486 481 487 <div class="viewcode-block" id="product"><a class="viewcode-back" href="../code.html#tools.product">[docs]</a><span class="k">def</span> <span class="nf">product</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwds</span><span class="p">):</span> 488 <span class="sd">'''</span> 489 <span class="sd"> @Description:</span> 490 <span class="sd"> This method is taken from an example at the ECMWF wiki website.</span> 491 <span class="sd"> https://software.ecmwf.int/wiki/display/GRIB/index.py; 2018-03-16</span> 492 493 <span class="sd"> This method combines the single characters of the passed arguments</span> 494 <span class="sd"> with each other. So that each character of each argument value</span> 495 <span class="sd"> will be combined with each character of the other arguments as a tuple.</span> 496 497 <span class="sd"> Example:</span> 498 <span class="sd"> product('ABCD', 'xy') --> Ax Ay Bx By Cx Cy Dx Dy</span> 499 <span class="sd"> product(range(2), repeat = 3) --> 000 001 010 011 100 101 110 111</span> 500 501 <span class="sd"> @Input:</span> 502 <span class="sd"> *args: tuple</span> 503 <span class="sd"> Positional arguments (arbitrary number).</span> 504 505 <span class="sd"> **kwds: dictionary</span> 506 <span class="sd"> Contains all the keyword arguments from *args.</span> 507 508 <span class="sd"> @Return:</span> 509 <span class="sd"> prod: tuple</span> 510 <span class="sd"> Return will be done with "yield". A tuple of combined arguments.</span> 511 <span class="sd"> See example in description above.</span> 482 <div class="viewcode-block" id="product"><a class="viewcode-back" href="../api.html#tools.product">[docs]</a><span class="k">def</span> <span class="nf">product</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwds</span><span class="p">):</span> 483 <span class="sd">'''This method combines the single characters of the passed arguments</span> 484 <span class="sd"> with each other. So that each character of each argument value</span> 485 <span class="sd"> will be combined with each character of the other arguments as a tuple.</span> 486 487 <span class="sd"> Note</span> 488 <span class="sd"> ----</span> 489 <span class="sd"> This method is taken from an example at the ECMWF wiki website.</span> 490 <span class="sd"> https://software.ecmwf.int/wiki/display/GRIB/index.py; 2018-03-16</span> 491 492 <span class="sd"> Example</span> 493 <span class="sd"> -------</span> 494 <span class="sd"> product('ABCD', 'xy') --> Ax Ay Bx By Cx Cy Dx Dy</span> 495 496 <span class="sd"> product(range(2), repeat = 3) --> 000 001 010 011 100 101 110 111</span> 497 498 <span class="sd"> Parameters</span> 499 <span class="sd"> ----------</span> 500 <span class="sd"> \*args : :obj:`tuple`</span> 501 <span class="sd"> Positional arguments (arbitrary number).</span> 502 503 <span class="sd"> \*\*kwds : :obj:`dictionary`</span> 504 <span class="sd"> Contains all the keyword arguments from \*args.</span> 505 506 <span class="sd"> Return</span> 507 <span class="sd"> ------</span> 508 <span class="sd"> prod : :obj:`tuple`</span> 509 <span class="sd"> Return will be done with "yield". A tuple of combined arguments.</span> 510 <span class="sd"> See example in description above.</span> 512 511 <span class="sd"> '''</span> 513 512 <span class="n">pools</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="nb">tuple</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span> <span class="o">*</span> <span class="n">kwds</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'repeat'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> … … 521 520 522 521 523 <div class="viewcode-block" id="silent_remove"><a class="viewcode-back" href="../ code.html#tools.silent_remove">[docs]</a><span class="k">def</span> <span class="nf">silent_remove</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span>524 <span class="sd">''' </span>525 <span class="sd"> @Description:</span>526 <span class="sd"> Remove file if it exists.</span> 527 <span class="sd"> The function does not fail if the file does not exist.</span>528 529 <span class="sd"> @Input:</span>530 <span class="sd"> filename: string</span>531 <span class="sd"> The name of the file to be removed without notification.</span> 532 533 <span class="sd"> @Return:</span>534 <span class="sd"> <nothing></span> 522 <div class="viewcode-block" id="silent_remove"><a class="viewcode-back" href="../api.html#tools.silent_remove">[docs]</a><span class="k">def</span> <span class="nf">silent_remove</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span> 523 <span class="sd">'''Remove file if it exists.</span> 524 <span class="sd"> The function does not fail if the file does not exist.</span> 525 526 <span class="sd"> Parameters</span> 527 <span class="sd"> ----------</span> 528 <span class="sd"> filename : :obj:`string`</span> 529 <span class="sd"> The name of the file to be removed without notification.</span> 530 531 <span class="sd"> Return</span> 532 <span class="sd"> ------</span> 533 535 534 <span class="sd"> '''</span> 536 535 <span class="k">try</span><span class="p">:</span> … … 544 543 545 544 546 <div class="viewcode-block" id="init128"><a class="viewcode-back" href="../ code.html#tools.init128">[docs]</a><span class="k">def</span> <span class="nf">init128</span><span class="p">(</span><span class="n">filepath</span><span class="p">):</span>547 <span class="sd">''' </span>548 <span class="sd"> @Description:</span> 549 <span class="sd"> Opens and reads the grib file with table 128 information.</span>550 551 <span class="sd"> @Input:</span>552 <span class="sd"> filepath: string</span>553 <span class="sd"> Path to file of ECMWF grib table number 128.</span> 554 555 <span class="sd"> @Return:</span>556 <span class="sd"> table128: dictionary</span>557 <span class="sd"> 558 <span class="sd"> 559 <span class="sd"> 545 <div class="viewcode-block" id="init128"><a class="viewcode-back" href="../api.html#tools.init128">[docs]</a><span class="k">def</span> <span class="nf">init128</span><span class="p">(</span><span class="n">filepath</span><span class="p">):</span> 546 <span class="sd">'''Opens and reads the grib file with table 128 information.</span> 547 548 <span class="sd"> Parameters</span> 549 <span class="sd"> ----------</span> 550 <span class="sd"> filepath : :obj:`string`</span> 551 <span class="sd"> Path to file of ECMWF grib table number 128.</span> 552 553 <span class="sd"> Return</span> 554 <span class="sd"> ------</span> 555 <span class="sd"> table128 : :obj:`dictionary`</span> 556 <span class="sd"> Contains the ECMWF grib table 128 information.</span> 557 <span class="sd"> The key is the parameter number and the value is the</span> 558 <span class="sd"> short name of the parameter.</span> 560 559 <span class="sd"> '''</span> 561 560 <span class="n">table128</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span> … … 569 568 570 569 571 <div class="viewcode-block" id="to_param_id"><a class="viewcode-back" href="../code.html#tools.to_param_id">[docs]</a><span class="k">def</span> <span class="nf">to_param_id</span><span class="p">(</span><span class="n">pars</span><span class="p">,</span> <span class="n">table</span><span class="p">):</span> 572 <span class="sd">'''</span> 573 <span class="sd"> @Description:</span> 574 <span class="sd"> Transform parameter names to parameter ids</span> 575 <span class="sd"> with ECMWF grib table 128.</span> 576 577 <span class="sd"> @Input:</span> 578 <span class="sd"> pars: string</span> 579 <span class="sd"> Addpar argument from CONTROL file in the format of</span> 580 <span class="sd"> parameter names instead of ids. The parameter short</span> 581 <span class="sd"> names are sepearted with "/" and they are passed as</span> 582 <span class="sd"> one single string.</span> 583 584 <span class="sd"> table: dictionary</span> 585 <span class="sd"> Contains the ECMWF grib table 128 information.</span> 586 <span class="sd"> The key is the parameter number and the value is the</span> 587 <span class="sd"> short name of the parameter.</span> 588 589 <span class="sd"> @Return:</span> 590 <span class="sd"> ipar: list of integer</span> 591 <span class="sd"> List of addpar parameters from CONTROL file transformed to</span> 592 <span class="sd"> parameter ids in the format of integer.</span> 570 <div class="viewcode-block" id="to_param_id"><a class="viewcode-back" href="../api.html#tools.to_param_id">[docs]</a><span class="k">def</span> <span class="nf">to_param_id</span><span class="p">(</span><span class="n">pars</span><span class="p">,</span> <span class="n">table</span><span class="p">):</span> 571 <span class="sd">'''Transform parameter names to parameter ids with ECMWF grib table 128.</span> 572 573 <span class="sd"> Parameters</span> 574 <span class="sd"> ----------</span> 575 <span class="sd"> pars : :obj:`string`</span> 576 <span class="sd"> Addpar argument from CONTROL file in the format of</span> 577 <span class="sd"> parameter names instead of ids. The parameter short</span> 578 <span class="sd"> names are sepearted with "/" and they are passed as</span> 579 <span class="sd"> one single string.</span> 580 581 <span class="sd"> table : :obj:`dictionary`</span> 582 <span class="sd"> Contains the ECMWF grib table 128 information.</span> 583 <span class="sd"> The key is the parameter number and the value is the</span> 584 <span class="sd"> short name of the parameter.</span> 585 586 <span class="sd"> Return</span> 587 <span class="sd"> ------</span> 588 <span class="sd"> ipar : :obj:`list` of :obj:`integer`</span> 589 <span class="sd"> List of addpar parameters from CONTROL file transformed to</span> 590 <span class="sd"> parameter ids in the format of integer.</span> 593 591 <span class="sd"> '''</span> 594 592 <span class="n">cpar</span> <span class="o">=</span> <span class="n">pars</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'/'</span><span class="p">)</span> … … 604 602 <span class="k">return</span> <span class="n">ipar</span></div> 605 603 606 <div class="viewcode-block" id="get_list_as_string"><a class="viewcode-back" href="../ code.html#tools.get_list_as_string">[docs]</a><span class="k">def</span> <span class="nf">get_list_as_string</span><span class="p">(</span><span class="n">list_obj</span><span class="p">,</span> <span class="n">concatenate_sign</span><span class="o">=</span><span class="s1">', '</span><span class="p">):</span>607 <span class="sd">''' </span>608 <span class="sd"> @Description:</span> 609 <span class="sd"> Converts a list of arbitrary content into a single string.</span>610 611 <span class="sd"> @Input:</span>612 <span class="sd"> list_obj: list</span>613 <span class="sd"> A list with arbitrary content.</span> 614 615 <span class="sd"> concatenate_sign: string, optional</span>616 <span class="sd"> A string which is used to concatenate the single</span>617 <span class="sd"> list elements. Default value is ", ".</span> 618 619 <span class="sd"> @Return:</span>620 <span class="sd"> str_of_list: string</span>621 <span class="sd"> 604 <div class="viewcode-block" id="get_list_as_string"><a class="viewcode-back" href="../api.html#tools.get_list_as_string">[docs]</a><span class="k">def</span> <span class="nf">get_list_as_string</span><span class="p">(</span><span class="n">list_obj</span><span class="p">,</span> <span class="n">concatenate_sign</span><span class="o">=</span><span class="s1">', '</span><span class="p">):</span> 605 <span class="sd">'''Converts a list of arbitrary content into a single string.</span> 606 607 <span class="sd"> Parameters</span> 608 <span class="sd"> ----------</span> 609 <span class="sd"> list_obj : :obj:`list`</span> 610 <span class="sd"> A list with arbitrary content.</span> 611 612 <span class="sd"> concatenate_sign : :obj:`string`, optional</span> 613 <span class="sd"> A string which is used to concatenate the single</span> 614 <span class="sd"> list elements. Default value is ", ".</span> 615 616 <span class="sd"> Return</span> 617 <span class="sd"> ------</span> 618 <span class="sd"> str_of_list : :obj:`string`</span> 619 <span class="sd"> The content of the list as a single string.</span> 622 620 <span class="sd"> '''</span> 623 621 … … 626 624 <span class="k">return</span> <span class="n">str_of_list</span></div> 627 625 628 <div class="viewcode-block" id="make_dir"><a class="viewcode-back" href="../ code.html#tools.make_dir">[docs]</a><span class="k">def</span> <span class="nf">make_dir</span><span class="p">(</span><span class="n">directory</span><span class="p">):</span>629 <span class="sd">''' </span>630 <span class="sd"> @Description:</span>631 <span class="sd"> Creates a directory and gives a warning if the directory</span> 632 <span class="sd"> already exists. The program stops only if there is another problem.</span>633 634 <span class="sd"> @Input:</span>635 <span class="sd"> directory: string</span>636 <span class="sd"> The directory name including the path which should be created.</span> 637 638 <span class="sd"> @Return:</span>639 <span class="sd"> <nothing></span> 626 <div class="viewcode-block" id="make_dir"><a class="viewcode-back" href="../api.html#tools.make_dir">[docs]</a><span class="k">def</span> <span class="nf">make_dir</span><span class="p">(</span><span class="n">directory</span><span class="p">):</span> 627 <span class="sd">'''Creates a directory and gives a warning if the directory</span> 628 <span class="sd"> already exists. The program stops only if there is another problem.</span> 629 630 <span class="sd"> Parameters</span> 631 <span class="sd"> ----------</span> 632 <span class="sd"> directory : :obj:`string`</span> 633 <span class="sd"> The directory name including the path which should be created.</span> 634 635 <span class="sd"> Return</span> 636 <span class="sd"> ------</span> 637 640 638 <span class="sd"> '''</span> 641 639 <span class="k">try</span><span class="p">:</span> … … 650 648 <span class="k">return</span></div> 651 649 652 <div class="viewcode-block" id="put_file_to_ecserver"><a class="viewcode-back" href="../code.html#tools.put_file_to_ecserver">[docs]</a><span class="k">def</span> <span class="nf">put_file_to_ecserver</span><span class="p">(</span><span class="n">ecd</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">target</span><span class="p">,</span> <span class="n">ecuid</span><span class="p">,</span> <span class="n">ecgid</span><span class="p">):</span> 653 <span class="sd">'''</span> 654 <span class="sd"> @Description:</span> 655 <span class="sd"> Uses the ecaccess-file-put command to send a file to the ECMWF servers.</span> 656 657 <span class="sd"> NOTE:</span> 658 <span class="sd"> The return value is just for testing reasons. It does not have</span> 659 <span class="sd"> to be used from the calling function since the whole error handling</span> 660 <span class="sd"> is done in here.</span> 661 662 <span class="sd"> @Input:</span> 663 <span class="sd"> ecd: string</span> 664 <span class="sd"> The path were the file is stored.</span> 665 666 <span class="sd"> filename: string</span> 667 <span class="sd"> The name of the file to send to the ECMWF server.</span> 668 669 <span class="sd"> target: string</span> 670 <span class="sd"> The target queue where the file should be sent to.</span> 671 672 <span class="sd"> ecuid: string</span> 673 <span class="sd"> The user id on ECMWF server.</span> 674 675 <span class="sd"> ecgid: string</span> 676 <span class="sd"> The group id on ECMWF server.</span> 677 678 <span class="sd"> @Return:</span> 679 <span class="sd"> rcode: string</span> 680 <span class="sd"> Resulting code of command execution. If successful the string</span> 681 <span class="sd"> will be empty.</span> 650 <div class="viewcode-block" id="put_file_to_ecserver"><a class="viewcode-back" href="../api.html#tools.put_file_to_ecserver">[docs]</a><span class="k">def</span> <span class="nf">put_file_to_ecserver</span><span class="p">(</span><span class="n">ecd</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">target</span><span class="p">,</span> <span class="n">ecuid</span><span class="p">,</span> <span class="n">ecgid</span><span class="p">):</span> 651 <span class="sd">'''Uses the ecaccess-file-put command to send a file to the ECMWF servers.</span> 652 653 <span class="sd"> Note</span> 654 <span class="sd"> ----</span> 655 <span class="sd"> The return value is just for testing reasons. It does not have</span> 656 <span class="sd"> to be used from the calling function since the whole error handling</span> 657 <span class="sd"> is done in here.</span> 658 659 <span class="sd"> Parameters</span> 660 <span class="sd"> ----------</span> 661 <span class="sd"> ecd : :obj:`string`</span> 662 <span class="sd"> The path were the file is stored.</span> 663 664 <span class="sd"> filename : :obj:`string`</span> 665 <span class="sd"> The name of the file to send to the ECMWF server.</span> 666 667 <span class="sd"> target : :obj:`string`</span> 668 <span class="sd"> The target queue where the file should be sent to.</span> 669 670 <span class="sd"> ecuid : :obj:`string`</span> 671 <span class="sd"> The user id on ECMWF server.</span> 672 673 <span class="sd"> ecgid : :obj:`string`</span> 674 <span class="sd"> The group id on ECMWF server.</span> 675 676 <span class="sd"> Return</span> 677 <span class="sd"> ------</span> 678 <span class="sd"> rcode : :obj:`string`</span> 679 <span class="sd"> Resulting code of command execution. If successful the string</span> 680 <span class="sd"> will be empty.</span> 682 681 <span class="sd"> '''</span> 683 682 … … 698 697 <span class="k">return</span> <span class="n">rcode</span></div> 699 698 700 <div class="viewcode-block" id="submit_job_to_ecserver"><a class="viewcode-back" href="../code.html#tools.submit_job_to_ecserver">[docs]</a><span class="k">def</span> <span class="nf">submit_job_to_ecserver</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">jobname</span><span class="p">):</span> 701 <span class="sd">'''</span> 702 <span class="sd"> @Description:</span> 703 <span class="sd"> Uses ecaccess-job-submit command to submit a job to the ECMWF server.</span> 704 705 <span class="sd"> NOTE:</span> 706 <span class="sd"> The return value is just for testing reasons. It does not have</span> 707 <span class="sd"> to be used from the calling function since the whole error handling</span> 708 <span class="sd"> is done in here.</span> 709 710 <span class="sd"> @Input:</span> 711 <span class="sd"> target: string</span> 712 <span class="sd"> The target where the file should be sent to, e.g. the queue.</span> 713 714 <span class="sd"> jobname: string</span> 715 <span class="sd"> The name of the jobfile to be submitted to the ECMWF server.</span> 716 717 <span class="sd"> @Return:</span> 718 <span class="sd"> rcode: string</span> 719 <span class="sd"> Resulting code of command execution. If successful the string</span> 720 <span class="sd"> will contain an integer number, representing the id of the job</span> 721 <span class="sd"> at the ecmwf server.</span> 699 <div class="viewcode-block" id="submit_job_to_ecserver"><a class="viewcode-back" href="../api.html#tools.submit_job_to_ecserver">[docs]</a><span class="k">def</span> <span class="nf">submit_job_to_ecserver</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">jobname</span><span class="p">):</span> 700 <span class="sd">'''Uses ecaccess-job-submit command to submit a job to the ECMWF server.</span> 701 702 <span class="sd"> Note</span> 703 <span class="sd"> ----</span> 704 <span class="sd"> The return value is just for testing reasons. It does not have</span> 705 <span class="sd"> to be used from the calling function since the whole error handling</span> 706 <span class="sd"> is done in here.</span> 707 708 <span class="sd"> Parameters</span> 709 <span class="sd"> ----------</span> 710 <span class="sd"> target : :obj:`string`</span> 711 <span class="sd"> The target where the file should be sent to, e.g. the queue.</span> 712 713 <span class="sd"> jobname : :obj:`string`</span> 714 <span class="sd"> The name of the jobfile to be submitted to the ECMWF server.</span> 715 716 <span class="sd"> Return</span> 717 <span class="sd"> ------</span> 718 <span class="sd"> rcode : :obj:`string`</span> 719 <span class="sd"> Resulting code of command execution. If successful the string</span> 720 <span class="sd"> will contain an integer number, representing the id of the job</span> 721 <span class="sd"> at the ecmwf server.</span> 722 722 <span class="sd"> '''</span> 723 723 -
documentation/Sphinx/build/html/_sources/api.rst.txt
r708c667 r274f9ef 2 2 ============================ 3 3 4 .. contents:: 5 :local: 6 7 Porgrams 8 -------- 9 10 install 11 ******* 12 13 .. automodule:: install 14 :members: 15 16 submit 17 ****** 18 19 .. automodule:: submit 20 :members: 21 22 Classes 23 ------- 24 25 ControlFile 26 *********** 27 28 .. automodule:: ControlFile 29 :members: 30 31 EcFlexpart 32 ********** 33 34 .. automodule:: EcFlexpart 35 :members: 36 37 GribTools 38 ********* 39 40 .. automodule:: GribTools 41 :members: 42 43 MarsRetrieval 44 ************* 45 46 .. automodule:: MarsRetrieval 47 :members: 48 49 UioFiles 50 ******** 51 52 .. automodule:: UioFiles 53 :members: 54 55 56 57 Modules 58 ------- 59 60 get_mars_data 61 ************* 62 63 .. automodule:: get_mars_data 64 :members: 65 66 prepare_flexpart 67 **************** 68 69 .. automodule:: prepare_flexpart 70 :members: 71 72 tools 73 ***** 74 75 .. automodule:: tools 76 :members: 77 78 disaggregation 79 ************** 80 4 81 .. automodule:: disaggregation 5 82 :members: -
documentation/Sphinx/build/html/_sources/downloads.rst.txt
r708c667 r274f9ef 5 5 6 6 UNDER CONSTRUCTION 7 8 .. toctree:: 9 :hidden: 10 :maxdepth: 2 11 12 downloads/tar_balls 13 downloads/git_repo 14 downloads/history_changes 15 -
documentation/Sphinx/build/html/_sources/index.rst.txt
r708c667 r274f9ef 4 4 contain the root `toctree` directive. 5 5 6 Welcome to flex_extract's documentation! 7 ======================================== 6 Welcome to flex_extract's user documentation! 7 ============================================= 8 9 flex_extract is a software to retrieve meteorological fields from the European Centre for Medium-Range Weather Forecasts (ECMWF) Mars archive to server as input files for the FLEXTRA/FLEXPART Atmospheric Transport Modelling system. 10 11 12 .. The scripts can be 1) executed locally using the ECMWF WebMARS interface, or 2) on the ECMWF member 13 .. state gateway server or HPC facility using the ecaccess software package. As another option the scripts can 3) 14 .. also be triggered using ecflow scheduling software used by ECMWF for data dissemination. 15 16 All required second party software and libraries used within flex_extract is open source and free of charge. 17 18 8 19 .. raw:: html 9 20 … … 87 98 88 99 .. toctree:: 89 :maxdepth: 2100 :maxdepth: 3 90 101 :caption: Table of Contents: 91 102 -
documentation/Sphinx/build/html/_sources/installation.rst.txt
r708c667 r274f9ef 1 1 Installation 2 2 ============ 3 4 Describe installation process flex_extract ....5 3 6 4 UNDER CONSTRUCTION 5 6 .. toctree:: 7 :hidden: 8 :maxdepth: 2 9 10 installation/requirements 11 installation/oper_modes 12 installation/test_install 13 14 15 -
documentation/Sphinx/build/html/_sources/program_structure.rst.txt
r708c667 r274f9ef 5 5 6 6 UNDER CONSTRUCTION 7 8 .. toctree:: 9 :hidden: 10 :maxdepth: 2 11 12 program_structure/prog_overview 13 program_structure/prog_components 14 program_structure/prog_flow -
documentation/Sphinx/build/html/_sources/requirements.rst.txt
r708c667 r274f9ef 2 2 ============ 3 3 4 Describe the requirements to use flex_extract ....5 4 6 5 UNDER CONSTRUCTION 6 -
documentation/Sphinx/build/html/_sources/support.rst.txt
r708c667 r274f9ef 2 2 ======= 3 3 4 Describe support options ....5 4 6 5 UNDER CONSTRUCTION 6 7 8 .. toctree:: 9 :hidden: 10 :maxdepth: 2 11 12 support/ticket_system 13 support/mailing_list 14 support/known_bugs_issues 15 support/faq 16 -
documentation/Sphinx/build/html/_sources/user_guide.rst.txt
r708c667 r274f9ef 1 1 User Guide 2 2 ========== 3 4 Describe using flex_extract ....5 3 6 4 UNDER CONSTRUCTION 5 6 .. toctree:: 7 :hidden: 8 :maxdepth: 2 9 10 user_guide/how_to 11 user_guide/control_templates 12 -
documentation/Sphinx/build/html/api.html
r708c667 r274f9ef 30 30 <link rel="search" title="Search" href="search.html" /> 31 31 <link rel="next" title="Support" href="support.html" /> 32 <link rel="prev" title=" User Guide" href="user_guide.html" />32 <link rel="prev" title="CONTROL-file templates" href="user_guide/control_templates.html" /> 33 33 34 34 … … 89 89 <li class="toctree-l1"><a class="reference internal" href="program_structure.html">Program Structure</a></li> 90 90 <li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li> 91 <li class="toctree-l1 current"><a class="current reference internal" href="#">Auto Generated Documentation</a></li> 91 <li class="toctree-l1 current"><a class="current reference internal" href="#">Auto Generated Documentation</a><ul> 92 <li class="toctree-l2"><a class="reference internal" href="#porgrams">Porgrams</a><ul> 93 <li class="toctree-l3"><a class="reference internal" href="#module-install">install</a></li> 94 <li class="toctree-l3"><a class="reference internal" href="#module-submit">submit</a></li> 95 </ul> 96 </li> 97 <li class="toctree-l2"><a class="reference internal" href="#classes">Classes</a><ul> 98 <li class="toctree-l3"><a class="reference internal" href="#module-ControlFile">ControlFile</a></li> 99 <li class="toctree-l3"><a class="reference internal" href="#module-EcFlexpart">EcFlexpart</a></li> 100 <li class="toctree-l3"><a class="reference internal" href="#module-GribTools">GribTools</a></li> 101 <li class="toctree-l3"><a class="reference internal" href="#module-MarsRetrieval">MarsRetrieval</a></li> 102 <li class="toctree-l3"><a class="reference internal" href="#module-UioFiles">UioFiles</a></li> 103 </ul> 104 </li> 105 <li class="toctree-l2"><a class="reference internal" href="#modules">Modules</a><ul> 106 <li class="toctree-l3"><a class="reference internal" href="#module-get_mars_data">get_mars_data</a></li> 107 <li class="toctree-l3"><a class="reference internal" href="#module-prepare_flexpart">prepare_flexpart</a></li> 108 <li class="toctree-l3"><a class="reference internal" href="#module-tools">tools</a></li> 109 <li class="toctree-l3"><a class="reference internal" href="#module-disaggregation">disaggregation</a></li> 110 </ul> 111 </li> 112 </ul> 113 </li> 92 114 <li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li> 93 115 </ul> … … 155 177 <div itemprop="articleBody"> 156 178 157 <div class="section" id="module-disaggregation"> 158 <span id="auto-generated-documentation"></span><h1>Auto Generated Documentation<a class="headerlink" href="#module-disaggregation" title="Permalink to this headline">¶</a></h1> 179 <div class="section" id="auto-generated-documentation"> 180 <h1>Auto Generated Documentation<a class="headerlink" href="#auto-generated-documentation" title="Permalink to this headline">¶</a></h1> 181 <div class="contents local topic" id="contents"> 182 <ul class="simple"> 183 <li><a class="reference internal" href="#porgrams" id="id1">Porgrams</a><ul> 184 <li><a class="reference internal" href="#module-install" id="id2">install</a></li> 185 <li><a class="reference internal" href="#module-submit" id="id3">submit</a></li> 186 </ul> 187 </li> 188 <li><a class="reference internal" href="#classes" id="id4">Classes</a><ul> 189 <li><a class="reference internal" href="#module-ControlFile" id="id5">ControlFile</a></li> 190 <li><a class="reference internal" href="#module-EcFlexpart" id="id6">EcFlexpart</a></li> 191 <li><a class="reference internal" href="#module-GribTools" id="id7">GribTools</a></li> 192 <li><a class="reference internal" href="#module-MarsRetrieval" id="id8">MarsRetrieval</a></li> 193 <li><a class="reference internal" href="#module-UioFiles" id="id9">UioFiles</a></li> 194 </ul> 195 </li> 196 <li><a class="reference internal" href="#modules" id="id10">Modules</a><ul> 197 <li><a class="reference internal" href="#module-get_mars_data" id="id11">get_mars_data</a></li> 198 <li><a class="reference internal" href="#module-prepare_flexpart" id="id12">prepare_flexpart</a></li> 199 <li><a class="reference internal" href="#module-tools" id="id13">tools</a></li> 200 <li><a class="reference internal" href="#module-disaggregation" id="id14">disaggregation</a></li> 201 </ul> 202 </li> 203 </ul> 204 </div> 205 <div class="section" id="porgrams"> 206 <h2><a class="toc-backref" href="#id1">Porgrams</a><a class="headerlink" href="#porgrams" title="Permalink to this headline">¶</a></h2> 207 <div class="section" id="module-install"> 208 <span id="install"></span><h3><a class="toc-backref" href="#id2">install</a><a class="headerlink" href="#module-install" title="Permalink to this headline">¶</a></h3> 209 <dl class="function"> 210 <dt id="install.delete_convert_build"> 211 <code class="descclassname">install.</code><code class="descname">delete_convert_build</code><span class="sig-paren">(</span><em>src_path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#delete_convert_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.delete_convert_build" title="Permalink to this definition">¶</a></dt> 212 <dd><p>Clean up the Fortran source directory and remove all 213 build files (e.g. *.o, *.mod and CONVERT2)</p> 214 <table class="docutils field-list" frame="void" rules="none"> 215 <col class="field-name" /> 216 <col class="field-body" /> 217 <tbody valign="top"> 218 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>src_path</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Path to the fortran source directory.</td> 219 </tr> 220 </tbody> 221 </table> 222 </dd></dl> 223 224 <dl class="function"> 225 <dt id="install.get_install_cmdline_arguments"> 226 <code class="descclassname">install.</code><code class="descname">get_install_cmdline_arguments</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#get_install_cmdline_arguments"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.get_install_cmdline_arguments" title="Permalink to this definition">¶</a></dt> 227 <dd><p>Decomposes the command line arguments and assigns them to variables. 228 Apply default values for non mentioned arguments.</p> 229 <table class="docutils field-list" frame="void" rules="none"> 230 <col class="field-name" /> 231 <col class="field-body" /> 232 <tbody valign="top"> 233 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><strong>args</strong> – Contains the commandline arguments from script/program call.</td> 234 </tr> 235 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Namespace</span></code></td> 236 </tr> 237 </tbody> 238 </table> 239 </dd></dl> 240 241 <dl class="function"> 242 <dt id="install.install_via_gateway"> 243 <code class="descclassname">install.</code><code class="descname">install_via_gateway</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#install_via_gateway"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.install_via_gateway" title="Permalink to this definition">¶</a></dt> 244 <dd><p>Perform the actual installation on local machine or prepare data 245 transfer to remote gate and submit a job script which will 246 install everything on the remote gate.</p> 247 <table class="docutils field-list" frame="void" rules="none"> 248 <col class="field-name" /> 249 <col class="field-body" /> 250 <tbody valign="top"> 251 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and 252 command line.</td> 253 </tr> 254 </tbody> 255 </table> 256 </dd></dl> 257 258 <dl class="function"> 259 <dt id="install.main"> 260 <code class="descclassname">install.</code><code class="descname">main</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.main" title="Permalink to this definition">¶</a></dt> 261 <dd><p>Controls the installation process. Calls the installation function 262 if target is specified.</p> 263 </dd></dl> 264 265 <dl class="function"> 266 <dt id="install.make_convert_build"> 267 <code class="descclassname">install.</code><code class="descname">make_convert_build</code><span class="sig-paren">(</span><em>src_path</em>, <em>makefile</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#make_convert_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.make_convert_build" title="Permalink to this definition">¶</a></dt> 268 <dd><p>Compiles the Fortran code and generates the executable.</p> 269 <table class="docutils field-list" frame="void" rules="none"> 270 <col class="field-name" /> 271 <col class="field-body" /> 272 <tbody valign="top"> 273 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 274 <li><strong>src_path</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Path to the fortran source directory.</li> 275 <li><strong>makefile</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The name of the makefile which should be used.</li> 276 </ul> 277 </td> 278 </tr> 279 </tbody> 280 </table> 281 </dd></dl> 282 283 <dl class="function"> 284 <dt id="install.mk_compilejob"> 285 <code class="descclassname">install.</code><code class="descname">mk_compilejob</code><span class="sig-paren">(</span><em>makefile</em>, <em>target</em>, <em>ecuid</em>, <em>ecgid</em>, <em>fp_root</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#mk_compilejob"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_compilejob" title="Permalink to this definition">¶</a></dt> 286 <dd><p>Modifies the original job template file so that it is specified 287 for the user and the environment were it will be applied. Result 288 is stored in a new file “job.temp” in the python directory.</p> 289 <table class="docutils field-list" frame="void" rules="none"> 290 <col class="field-name" /> 291 <col class="field-body" /> 292 <tbody valign="top"> 293 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 294 <li><strong>makefile</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Name of the makefile which should be used to compile FORTRAN 295 CONVERT2 program.</li> 296 <li><strong>target</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The target where the installation should be done, e.g. the queue.</li> 297 <li><strong>ecuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The user id on ECMWF server.</li> 298 <li><strong>ecgid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The group id on ECMWF server.</li> 299 <li><strong>fp_root</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Path to the root directory of FLEXPART environment or flex_extract 300 environment.</li> 301 </ul> 302 </td> 303 </tr> 304 </tbody> 305 </table> 306 </dd></dl> 307 308 <dl class="function"> 309 <dt id="install.mk_env_vars"> 310 <code class="descclassname">install.</code><code class="descname">mk_env_vars</code><span class="sig-paren">(</span><em>ecuid</em>, <em>ecgid</em>, <em>gateway</em>, <em>destination</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#mk_env_vars"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_env_vars" title="Permalink to this definition">¶</a></dt> 311 <dd><p>Creates a file named ECMWF_ENV which contains the 312 necessary environmental variables at ECMWF servers. 313 It is based on the template ECMWF_ENV.template.</p> 314 <table class="docutils field-list" frame="void" rules="none"> 315 <col class="field-name" /> 316 <col class="field-body" /> 317 <tbody valign="top"> 318 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 319 <li><strong>ecuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The user id on ECMWF server.</li> 320 <li><strong>ecgid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The group id on ECMWF server.</li> 321 <li><strong>gateway</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The gateway server the user is using.</li> 322 <li><strong>destination</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The remote destination which is used to transfer files 323 from ECMWF server to local gateway server.</li> 324 </ul> 325 </td> 326 </tr> 327 </tbody> 328 </table> 329 </dd></dl> 330 331 <dl class="function"> 332 <dt id="install.mk_job_template"> 333 <code class="descclassname">install.</code><code class="descname">mk_job_template</code><span class="sig-paren">(</span><em>ecuid</em>, <em>ecgid</em>, <em>gateway</em>, <em>destination</em>, <em>fp_root</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#mk_job_template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_job_template" title="Permalink to this definition">¶</a></dt> 334 <dd><p>Modifies the original job template file so that it is specified 335 for the user and the environment were it will be applied. Result 336 is stored in a new file.</p> 337 <table class="docutils field-list" frame="void" rules="none"> 338 <col class="field-name" /> 339 <col class="field-body" /> 340 <tbody valign="top"> 341 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 342 <li><strong>ecuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The user id on ECMWF server.</li> 343 <li><strong>ecgid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The group id on ECMWF server.</li> 344 <li><strong>gateway</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The gateway server the user is using.</li> 345 <li><strong>destination</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The remote destination which is used to transfer files 346 from ECMWF server to local gateway server.</li> 347 <li><strong>fp_root</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Path to the root directory of FLEXPART environment or flex_extract 348 environment.</li> 349 </ul> 350 </td> 351 </tr> 352 </tbody> 353 </table> 354 </dd></dl> 355 356 <dl class="function"> 357 <dt id="install.mk_tarball"> 358 <code class="descclassname">install.</code><code class="descname">mk_tarball</code><span class="sig-paren">(</span><em>tarball_path</em>, <em>target</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#mk_tarball"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_tarball" title="Permalink to this definition">¶</a></dt> 359 <dd><p>Creates a tarball with all necessary files which need to be sent to the 360 installation directory. 361 It does not matter if this is local or remote. 362 Collects all python files, the Fortran source and makefiles, 363 the ECMWF_ENV file, the CONTROL files as well as the 364 template files.</p> 365 <table class="docutils field-list" frame="void" rules="none"> 366 <col class="field-name" /> 367 <col class="field-body" /> 368 <tbody valign="top"> 369 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 370 <li><strong>tarball_path</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The complete path to the tar file which will contain all 371 relevant data for flex_extract.</li> 372 <li><strong>target</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The queue where the job is submitted to.</li> 373 </ul> 374 </td> 375 </tr> 376 </tbody> 377 </table> 378 </dd></dl> 379 380 <dl class="function"> 381 <dt id="install.un_tarball"> 382 <code class="descclassname">install.</code><code class="descname">un_tarball</code><span class="sig-paren">(</span><em>tarball_path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#un_tarball"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.un_tarball" title="Permalink to this definition">¶</a></dt> 383 <dd><p>Extracts the given tarball into current directory.</p> 384 <table class="docutils field-list" frame="void" rules="none"> 385 <col class="field-name" /> 386 <col class="field-body" /> 387 <tbody valign="top"> 388 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tarball_path</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The complete path to the tar file which will contain all 389 relevant data for flex_extract.</td> 390 </tr> 391 </tbody> 392 </table> 393 </dd></dl> 394 395 </div> 396 <div class="section" id="module-submit"> 397 <span id="submit"></span><h3><a class="toc-backref" href="#id3">submit</a><a class="headerlink" href="#module-submit" title="Permalink to this headline">¶</a></h3> 398 <dl class="function"> 399 <dt id="submit.main"> 400 <code class="descclassname">submit.</code><code class="descname">main</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/submit.html#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#submit.main" title="Permalink to this definition">¶</a></dt> 401 <dd><p>Get the arguments from script call and from CONTROL file. 402 Decides from the argument “queue” if the local version 403 is done “queue=None” or the gateway version with “queue=ecgate” 404 or “queue=cca”.</p> 405 </dd></dl> 406 407 <dl class="function"> 408 <dt id="submit.submit"> 409 <code class="descclassname">submit.</code><code class="descname">submit</code><span class="sig-paren">(</span><em>jtemplate</em>, <em>c</em>, <em>queue</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/submit.html#submit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#submit.submit" title="Permalink to this definition">¶</a></dt> 410 <dd><p>Prepares the job script and submit it to the specified queue.</p> 411 <table class="docutils field-list" frame="void" rules="none"> 412 <col class="field-name" /> 413 <col class="field-body" /> 414 <tbody valign="top"> 415 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 416 <li><strong>jtemplate</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Job template file from sub-directory “_templates” for 417 submission to ECMWF. It contains all necessary 418 module and variable settings for the ECMWF environment as well as 419 the job call and mail report instructions. 420 Default is “job.temp”.</li> 421 <li><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and 422 command line.</li> 423 <li><strong>queue</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Name of queue for submission to ECMWF (e.g. ecgate or cca )</li> 424 </ul> 425 </td> 426 </tr> 427 </tbody> 428 </table> 429 </dd></dl> 430 431 </div> 432 </div> 433 <div class="section" id="classes"> 434 <h2><a class="toc-backref" href="#id4">Classes</a><a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2> 435 <div class="section" id="module-ControlFile"> 436 <span id="controlfile"></span><h3><a class="toc-backref" href="#id5">ControlFile</a><a class="headerlink" href="#module-ControlFile" title="Permalink to this headline">¶</a></h3> 437 <dl class="class"> 438 <dt id="ControlFile.ControlFile"> 439 <em class="property">class </em><code class="descclassname">ControlFile.</code><code class="descname">ControlFile</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ControlFile.html#ControlFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ControlFile.ControlFile" title="Permalink to this definition">¶</a></dt> 440 <dd><p>Contains the information which are stored in the CONTROL files.</p> 441 <dl class="method"> 442 <dt id="ControlFile.ControlFile.assign_args_to_control"> 443 <code class="descname">assign_args_to_control</code><span class="sig-paren">(</span><em>args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ControlFile.html#ControlFile.assign_args_to_control"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ControlFile.ControlFile.assign_args_to_control" title="Permalink to this definition">¶</a></dt> 444 <dd><p>Overwrites the existing ControlFile instance attributes with 445 the command line arguments.</p> 446 <table class="docutils field-list" frame="void" rules="none"> 447 <col class="field-name" /> 448 <col class="field-body" /> 449 <tbody valign="top"> 450 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>args</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Namespace</span></code>) – Contains the commandline arguments from script/program call.</td> 451 </tr> 452 </tbody> 453 </table> 454 </dd></dl> 455 456 <dl class="method"> 457 <dt id="ControlFile.ControlFile.assign_envs_to_control"> 458 <code class="descname">assign_envs_to_control</code><span class="sig-paren">(</span><em>envs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ControlFile.html#ControlFile.assign_envs_to_control"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ControlFile.ControlFile.assign_envs_to_control" title="Permalink to this definition">¶</a></dt> 459 <dd><p>Assigns the ECMWF environment parameter.</p> 460 <table class="docutils field-list" frame="void" rules="none"> 461 <col class="field-name" /> 462 <col class="field-body" /> 463 <tbody valign="top"> 464 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>envs</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dictionary</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">strings</span></code>) – Contains the ECMWF environment parameternames “ECUID”, “ECGID”, 465 “DESTINATION” and “GATEWAY” with its corresponding values. 466 They were read from the file “ECMWF_ENV”.</td> 467 </tr> 468 </tbody> 469 </table> 470 </dd></dl> 471 472 <dl class="method"> 473 <dt id="ControlFile.ControlFile.check_conditions"> 474 <code class="descname">check_conditions</code><span class="sig-paren">(</span><em>queue</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ControlFile.html#ControlFile.check_conditions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ControlFile.ControlFile.check_conditions" title="Permalink to this definition">¶</a></dt> 475 <dd><p>Checks a couple of necessary attributes and conditions, 476 such as if they exist and contain values. 477 Otherwise set default values.</p> 478 <table class="docutils field-list" frame="void" rules="none"> 479 <col class="field-name" /> 480 <col class="field-body" /> 481 <tbody valign="top"> 482 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>queue</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Name of the queue if submitted to the ECMWF servers. 483 Used to check if ecuid, ecgid, gateway and destination 484 are set correctly and are not empty.</td> 485 </tr> 486 </tbody> 487 </table> 488 </dd></dl> 489 490 <dl class="method"> 491 <dt id="ControlFile.ControlFile.check_install_conditions"> 492 <code class="descname">check_install_conditions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ControlFile.html#ControlFile.check_install_conditions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ControlFile.ControlFile.check_install_conditions" title="Permalink to this definition">¶</a></dt> 493 <dd><p>Checks a couple of necessary attributes and conditions 494 for the installation such as if they exist and contain values. 495 Otherwise set default values.</p> 496 </dd></dl> 497 498 <dl class="method"> 499 <dt id="ControlFile.ControlFile.to_list"> 500 <code class="descname">to_list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ControlFile.html#ControlFile.to_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ControlFile.ControlFile.to_list" title="Permalink to this definition">¶</a></dt> 501 <dd><p>Just generates a list of strings containing the attributes and 502 assigned values except the attributes “_expanded”, “exedir”, 503 “ecmwfdatadir” and “flexpart_root_scripts”.</p> 504 <table class="docutils field-list" frame="void" rules="none"> 505 <col class="field-name" /> 506 <col class="field-body" /> 507 <tbody valign="top"> 508 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><strong>l</strong> – A sorted list of the all ControlFile class attributes with 509 their values except the attributes “_expanded”, “exedir”, 510 “ecmwfdatadir” and “flexpart_root_scripts”.</td> 511 </tr> 512 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></td> 513 </tr> 514 </tbody> 515 </table> 516 </dd></dl> 517 518 </dd></dl> 519 520 </div> 521 <div class="section" id="module-EcFlexpart"> 522 <span id="ecflexpart"></span><h3><a class="toc-backref" href="#id6">EcFlexpart</a><a class="headerlink" href="#module-EcFlexpart" title="Permalink to this headline">¶</a></h3> 523 <dl class="class"> 524 <dt id="EcFlexpart.EcFlexpart"> 525 <em class="property">class </em><code class="descclassname">EcFlexpart.</code><code class="descname">EcFlexpart</code><span class="sig-paren">(</span><em>c</em>, <em>fluxes=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/EcFlexpart.html#EcFlexpart"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart" title="Permalink to this definition">¶</a></dt> 526 <dd><p>Class to retrieve FLEXPART specific ECMWF data.</p> 527 <dl class="method"> 528 <dt id="EcFlexpart.EcFlexpart.create"> 529 <code class="descname">create</code><span class="sig-paren">(</span><em>inputfiles</em>, <em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/EcFlexpart.html#EcFlexpart.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.create" title="Permalink to this definition">¶</a></dt> 530 <dd><p>An index file will be created which depends on the combination 531 of “date”, “time” and “stepRange” values. This is used to iterate 532 over all messages in each grib file which were passed through the 533 parameter “inputfiles” to seperate specific parameters into fort.* 534 files. Afterwards the FORTRAN program is called to convert 535 the data fields all to the same grid and put them in one file 536 per unique time step (combination of “date”, “time” and 537 “stepRange”).</p> 538 <div class="admonition note"> 539 <p class="first admonition-title">Note</p> 540 <p class="last">This method is based on the ECMWF example index.py 541 <a class="reference external" href="https://software.ecmwf.int/wiki/display/GRIB/index.py">https://software.ecmwf.int/wiki/display/GRIB/index.py</a></p> 542 </div> 543 <table class="docutils field-list" frame="void" rules="none"> 544 <col class="field-name" /> 545 <col class="field-body" /> 546 <tbody valign="top"> 547 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 548 <li><strong>inputfiles</strong> (<a class="reference internal" href="#module-UioFiles" title="UioFiles"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UioFiles</span></code></a>) – Contains a list of files.</li> 549 <li><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and 550 command line.</li> 551 </ul> 552 </td> 553 </tr> 554 </tbody> 555 </table> 556 </dd></dl> 557 558 <dl class="method"> 559 <dt id="EcFlexpart.EcFlexpart.deacc_fluxes"> 560 <code class="descname">deacc_fluxes</code><span class="sig-paren">(</span><em>inputfiles</em>, <em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/EcFlexpart.html#EcFlexpart.deacc_fluxes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.deacc_fluxes" title="Permalink to this definition">¶</a></dt> 561 <dd><p>Goes through all flux fields in ordered time and de-accumulate 562 the fields. Afterwards the fields are disaggregated in time. 563 Different versions of disaggregation is provided for rainfall 564 data (darain, modified linear) and the surface fluxes and 565 stress data (dapoly, cubic polynomial).</p> 566 <table class="docutils field-list" frame="void" rules="none"> 567 <col class="field-name" /> 568 <col class="field-body" /> 569 <tbody valign="top"> 570 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 571 <li><strong>inputfiles</strong> (<a class="reference internal" href="#module-UioFiles" title="UioFiles"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UioFiles</span></code></a>) – Contains a list of files.</li> 572 <li><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and 573 command line.</li> 574 </ul> 575 </td> 576 </tr> 577 </tbody> 578 </table> 579 </dd></dl> 580 581 <dl class="method"> 582 <dt id="EcFlexpart.EcFlexpart.prepare_fp_files"> 583 <code class="descname">prepare_fp_files</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/EcFlexpart.html#EcFlexpart.prepare_fp_files"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.prepare_fp_files" title="Permalink to this definition">¶</a></dt> 584 <dd><p>Conversion of GRIB files to FLEXPART binary format.</p> 585 <table class="docutils field-list" frame="void" rules="none"> 586 <col class="field-name" /> 587 <col class="field-body" /> 588 <tbody valign="top"> 589 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and 590 command line.</td> 591 </tr> 592 </tbody> 593 </table> 594 </dd></dl> 595 596 <dl class="method"> 597 <dt id="EcFlexpart.EcFlexpart.process_output"> 598 <code class="descname">process_output</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/EcFlexpart.html#EcFlexpart.process_output"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.process_output" title="Permalink to this definition">¶</a></dt> 599 <dd><p>The grib files are postprocessed depending on the selection in 600 CONTROL file. The resulting files are moved to the output 601 directory if its not equal to the input directory. 602 The following modifications might be done if 603 properly switched in CONTROL file: 604 GRIB2 - Conversion to GRIB2 605 ECTRANS - Transfer of files to gateway server 606 ECSTORAGE - Storage at ECMWF server</p> 607 <table class="docutils field-list" frame="void" rules="none"> 608 <col class="field-name" /> 609 <col class="field-body" /> 610 <tbody valign="top"> 611 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and 612 command line.</td> 613 </tr> 614 </tbody> 615 </table> 616 </dd></dl> 617 618 <dl class="method"> 619 <dt id="EcFlexpart.EcFlexpart.retrieve"> 620 <code class="descname">retrieve</code><span class="sig-paren">(</span><em>server</em>, <em>dates</em>, <em>public</em>, <em>request</em>, <em>inputdir='.'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/EcFlexpart.html#EcFlexpart.retrieve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.retrieve" title="Permalink to this definition">¶</a></dt> 621 <dd><p>Finalizing the retrieval information by setting final details 622 depending on grid type. 623 Prepares MARS retrievals per grid type and submits them.</p> 624 <table class="docutils field-list" frame="void" rules="none"> 625 <col class="field-name" /> 626 <col class="field-body" /> 627 <tbody valign="top"> 628 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 629 <li><strong>server</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">ECMWFService</span></code> or <code class="xref py py-obj docutils literal notranslate"><span class="pre">ECMWFDataServer</span></code>) – The connection to the ECMWF server. This is different 630 for member state users which have full access and non 631 member state users which have only access to the public 632 data sets. The decision is made from command line argument 633 “public”; for public access its True (ECMWFDataServer) 634 for member state users its False (ECMWFService)</li> 635 <li><strong>dates</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Contains start and end date of the retrieval in the format 636 “YYYYMMDD/to/YYYYMMDD”</li> 637 <li><strong>request</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">integer</span></code>) – Selects the mode of retrieval. 638 0: Retrieves the data from ECMWF. 639 1: Prints the mars requests to an output file. 640 2: Retrieves the data and prints the mars request.</li> 641 <li><strong>inputdir</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Path to the directory where the retrieved data is about 642 to be stored. The default is the current directory (‘.’).</li> 643 </ul> 644 </td> 645 </tr> 646 </tbody> 647 </table> 648 </dd></dl> 649 650 <dl class="method"> 651 <dt id="EcFlexpart.EcFlexpart.write_namelist"> 652 <code class="descname">write_namelist</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/EcFlexpart.html#EcFlexpart.write_namelist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.write_namelist" title="Permalink to this definition">¶</a></dt> 653 <dd><p>Creates a namelist file in the temporary directory and writes 654 the following values to it: maxl, maxb, mlevel, 655 mlevelist, mnauf, metapar, rlo0, rlo1, rla0, rla1, 656 momega, momegadiff, mgauss, msmooth, meta, metadiff, mdpdeta</p> 657 <table class="docutils field-list" frame="void" rules="none"> 658 <col class="field-name" /> 659 <col class="field-body" /> 660 <tbody valign="top"> 661 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 662 <li><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and 663 command line.</li> 664 <li><strong>filename</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Name of the namelist file.</li> 665 </ul> 666 </td> 667 </tr> 668 </tbody> 669 </table> 670 </dd></dl> 671 672 </dd></dl> 673 674 </div> 675 <div class="section" id="module-GribTools"> 676 <span id="gribtools"></span><h3><a class="toc-backref" href="#id7">GribTools</a><a class="headerlink" href="#module-GribTools" title="Permalink to this headline">¶</a></h3> 677 <dl class="class"> 678 <dt id="GribTools.GribTools"> 679 <em class="property">class </em><code class="descclassname">GribTools.</code><code class="descname">GribTools</code><span class="sig-paren">(</span><em>filenames</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GribTools.html#GribTools"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribTools.GribTools" title="Permalink to this definition">¶</a></dt> 680 <dd><p>Class for GRIB utilities (new methods) based on GRIB API</p> 681 <dl class="method"> 682 <dt id="GribTools.GribTools.copy"> 683 <code class="descname">copy</code><span class="sig-paren">(</span><em>filename_in</em>, <em>selectWhere=True</em>, <em>keynames=[]</em>, <em>keyvalues=[]</em>, <em>filemode='w'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GribTools.html#GribTools.copy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribTools.GribTools.copy" title="Permalink to this definition">¶</a></dt> 684 <dd><p>Add the content of another input grib file to the objects file but 685 only messages corresponding to keys/values passed to the function. 686 The selectWhere switch decides if to copy the keys equal to (True) or 687 different to (False) the keynames/keyvalues list passed to the function.</p> 688 <table class="docutils field-list" frame="void" rules="none"> 689 <col class="field-name" /> 690 <col class="field-body" /> 691 <tbody valign="top"> 692 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 693 <li><strong>filename_in</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Filename of the input file to read the grib messages from.</li> 694 <li><strong>selectWhere</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">boolean</span></code>, optional) – Decides if to copy the keynames and values equal to (True) or 695 different to (False) the keynames/keyvalues list passed to the 696 function. Default is True.</li> 697 <li><strong>keynames</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – List of keynames. Default is an empty list.</li> 698 <li><strong>keyvalues</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – List of keynames. Default is an empty list.</li> 699 <li><strong>filemode</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Sets the mode for the output file. Default is “w”.</li> 700 </ul> 701 </td> 702 </tr> 703 </tbody> 704 </table> 705 </dd></dl> 706 707 <dl class="method"> 708 <dt id="GribTools.GribTools.get_keys"> 709 <code class="descname">get_keys</code><span class="sig-paren">(</span><em>keynames</em>, <em>wherekeynames=[]</em>, <em>wherekeyvalues=[]</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GribTools.html#GribTools.get_keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribTools.GribTools.get_keys" title="Permalink to this definition">¶</a></dt> 710 <dd><p>Get keyvalues for a given list of keynames a where statement 711 can be given (list of key and list of values)</p> 712 <table class="docutils field-list" frame="void" rules="none"> 713 <col class="field-name" /> 714 <col class="field-body" /> 715 <tbody valign="top"> 716 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 717 <li><strong>keynames</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – List of keynames.</li> 718 <li><strong>wherekeynames</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Default value is an empty list.</li> 719 <li><strong>wherekeyvalues</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Default value is an empty list.</li> 720 </ul> 721 </td> 722 </tr> 723 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>return_list</strong> – List of keyvalues for given keynames.</p> 724 </td> 725 </tr> 726 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code></p> 727 </td> 728 </tr> 729 </tbody> 730 </table> 731 </dd></dl> 732 733 <dl class="method"> 734 <dt id="GribTools.GribTools.index"> 735 <code class="descname">index</code><span class="sig-paren">(</span><em>index_keys=['mars'], index_file='my.idx'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GribTools.html#GribTools.index"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribTools.GribTools.index" title="Permalink to this definition">¶</a></dt> 736 <dd><p>Create index file from a list of files if it does not exist or 737 read an index file.</p> 738 <table class="docutils field-list" frame="void" rules="none"> 739 <col class="field-name" /> 740 <col class="field-body" /> 741 <tbody valign="top"> 742 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 743 <li><strong>index_keys</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Contains the list of key parameter names from 744 which the index is to be created. 745 Default is a list with a single entry string “mars”.</li> 746 <li><strong>index_file</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Filename where the indices are stored. 747 Default is “my.idx”.</li> 748 </ul> 749 </td> 750 </tr> 751 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>iid</strong> – Grib index id.</p> 752 </td> 753 </tr> 754 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">integer</span></code></p> 755 </td> 756 </tr> 757 </tbody> 758 </table> 759 </dd></dl> 760 761 <dl class="method"> 762 <dt id="GribTools.GribTools.set_keys"> 763 <code class="descname">set_keys</code><span class="sig-paren">(</span><em>fromfile</em>, <em>keynames</em>, <em>keyvalues</em>, <em>wherekeynames=[]</em>, <em>wherekeyvalues=[]</em>, <em>strict=False</em>, <em>filemode='w'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GribTools.html#GribTools.set_keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribTools.GribTools.set_keys" title="Permalink to this definition">¶</a></dt> 764 <dd><p>Opens the file to read the grib messages and then write 765 them to a new output file. By default all messages are 766 written out. Also, the keyvalues of the passed list of 767 keynames are set or only those meeting the where statement. 768 (list of key and list of values).</p> 769 <table class="docutils field-list" frame="void" rules="none"> 770 <col class="field-name" /> 771 <col class="field-body" /> 772 <tbody valign="top"> 773 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 774 <li><strong>fromfile</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Filename of the input file to read the grib messages from.</li> 775 <li><strong>keynames</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – List of keynames. Default is an empty list.</li> 776 <li><strong>keyvalues</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – List of keynames. Default is an empty list.</li> 777 <li><strong>wherekeynames</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Default value is an empty list.</li> 778 <li><strong>wherekeyvalues</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Default value is an empty list.</li> 779 <li><strong>strict</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">boolean</span></code>, optional) – Decides if everything from keynames and keyvalues 780 is written out the grib file (False) or only those 781 meeting the where statement (True). Default is False.</li> 782 <li><strong>filemode</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Sets the mode for the output file. Default is “w”.</li> 783 </ul> 784 </td> 785 </tr> 786 </tbody> 787 </table> 788 </dd></dl> 789 790 </dd></dl> 791 792 </div> 793 <div class="section" id="module-MarsRetrieval"> 794 <span id="marsretrieval"></span><h3><a class="toc-backref" href="#id8">MarsRetrieval</a><a class="headerlink" href="#module-MarsRetrieval" title="Permalink to this headline">¶</a></h3> 795 <dl class="class"> 796 <dt id="MarsRetrieval.MarsRetrieval"> 797 <em class="property">class </em><code class="descclassname">MarsRetrieval.</code><code class="descname">MarsRetrieval</code><span class="sig-paren">(</span><em>server</em>, <em>public</em>, <em>marsclass='ei'</em>, <em>dataset=''</em>, <em>type=''</em>, <em>levtype=''</em>, <em>levelist=''</em>, <em>repres=''</em>, <em>date=''</em>, <em>resol=''</em>, <em>stream=''</em>, <em>area=''</em>, <em>time=''</em>, <em>step=''</em>, <em>expver='1'</em>, <em>number=''</em>, <em>accuracy=''</em>, <em>grid=''</em>, <em>gaussian=''</em>, <em>target=''</em>, <em>param=''</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MarsRetrieval.html#MarsRetrieval"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#MarsRetrieval.MarsRetrieval" title="Permalink to this definition">¶</a></dt> 798 <dd><p>Class for submitting MARS retrievals.</p> 799 <p>A description of MARS keywords/arguments and examples of their 800 values can be found here: 801 <a class="reference external" href="https://software.ecmwf.int/wiki/display/UDOC/">https://software.ecmwf.int/wiki/display/UDOC/</a> Identification+keywords#Identificationkeywords-class</p> 802 <dl class="method"> 803 <dt id="MarsRetrieval.MarsRetrieval.data_retrieve"> 804 <code class="descname">data_retrieve</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/MarsRetrieval.html#MarsRetrieval.data_retrieve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.data_retrieve" title="Permalink to this definition">¶</a></dt> 805 <dd><p>Submits a MARS retrieval. Depending on the existence of 806 ECMWF Web-API it is submitted via Python or a 807 subprocess in the Shell. The parameter for the mars retrieval 808 are taken from the defined class attributes.</p> 809 </dd></dl> 810 811 <dl class="method"> 812 <dt id="MarsRetrieval.MarsRetrieval.display_info"> 813 <code class="descname">display_info</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/MarsRetrieval.html#MarsRetrieval.display_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.display_info" title="Permalink to this definition">¶</a></dt> 814 <dd><p>Prints all class attributes and their values to the 815 standard output.</p> 816 </dd></dl> 817 818 <dl class="method"> 819 <dt id="MarsRetrieval.MarsRetrieval.print_info"> 820 <code class="descname">print_info</code><span class="sig-paren">(</span><em>inputdir</em>, <em>request_number</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MarsRetrieval.html#MarsRetrieval.print_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.print_info" title="Permalink to this definition">¶</a></dt> 821 <dd><p>Prints all mars requests to an extra file for debugging and 822 information.</p> 823 <table class="docutils field-list" frame="void" rules="none"> 824 <col class="field-name" /> 825 <col class="field-body" /> 826 <tbody valign="top"> 827 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 828 <li><strong>inputdir</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The path where all data from the retrievals are stored.</li> 829 <li><strong>request_number</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">integer</span></code>) – Number of mars requests for flux and non-flux data.</li> 830 </ul> 831 </td> 832 </tr> 833 </tbody> 834 </table> 835 </dd></dl> 836 837 <dl class="method"> 838 <dt id="MarsRetrieval.MarsRetrieval.print_infodata_csv"> 839 <code class="descname">print_infodata_csv</code><span class="sig-paren">(</span><em>inputdir</em>, <em>request_number</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MarsRetrieval.html#MarsRetrieval.print_infodata_csv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.print_infodata_csv" title="Permalink to this definition">¶</a></dt> 840 <dd><p>Write all request parameter in alpabetical order into a “csv” file.</p> 841 <table class="docutils field-list" frame="void" rules="none"> 842 <col class="field-name" /> 843 <col class="field-body" /> 844 <tbody valign="top"> 845 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 846 <li><strong>inputdir</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The path where all data from the retrievals are stored.</li> 847 <li><strong>request_number</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">integer</span></code>) – Number of mars requests for flux and non-flux data.</li> 848 </ul> 849 </td> 850 </tr> 851 </tbody> 852 </table> 853 </dd></dl> 854 855 </dd></dl> 856 857 </div> 858 <div class="section" id="module-UioFiles"> 859 <span id="uiofiles"></span><h3><a class="toc-backref" href="#id9">UioFiles</a><a class="headerlink" href="#module-UioFiles" title="Permalink to this headline">¶</a></h3> 860 <dl class="class"> 861 <dt id="UioFiles.UioFiles"> 862 <em class="property">class </em><code class="descclassname">UioFiles.</code><code class="descname">UioFiles</code><span class="sig-paren">(</span><em>path</em>, <em>pattern</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/UioFiles.html#UioFiles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#UioFiles.UioFiles" title="Permalink to this definition">¶</a></dt> 863 <dd><p>Class to manipulate files. At initialisation it has the pattern 864 which stores a regular expression pattern for the files, the path 865 to the files and the files already.</p> 866 <dl class="method"> 867 <dt id="UioFiles.UioFiles.delete_files"> 868 <code class="descname">delete_files</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/UioFiles.html#UioFiles.delete_files"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#UioFiles.UioFiles.delete_files" title="Permalink to this definition">¶</a></dt> 869 <dd><p>Deletes the files.</p> 870 </dd></dl> 871 872 </dd></dl> 873 874 </div> 875 </div> 876 <div class="section" id="modules"> 877 <h2><a class="toc-backref" href="#id10">Modules</a><a class="headerlink" href="#modules" title="Permalink to this headline">¶</a></h2> 878 <div class="section" id="module-get_mars_data"> 879 <span id="get-mars-data"></span><h3><a class="toc-backref" href="#id11">get_mars_data</a><a class="headerlink" href="#module-get_mars_data" title="Permalink to this headline">¶</a></h3> 880 <dl class="function"> 881 <dt id="get_mars_data.do_retrievement"> 882 <code class="descclassname">get_mars_data.</code><code class="descname">do_retrievement</code><span class="sig-paren">(</span><em>c</em>, <em>server</em>, <em>start</em>, <em>end</em>, <em>delta_t</em>, <em>fluxes=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/get_mars_data.html#do_retrievement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.do_retrievement" title="Permalink to this definition">¶</a></dt> 883 <dd><p>Divides the complete retrieval period in smaller chunks and 884 retrieves the data from MARS.</p> 885 <table class="docutils field-list" frame="void" rules="none"> 886 <col class="field-name" /> 887 <col class="field-body" /> 888 <tbody valign="top"> 889 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 890 <li><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and 891 command line.</li> 892 <li><strong>server</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">ECMWFService</span></code>) – The server connection to ECMWF.</li> 893 <li><strong>start</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime</span></code>) – The start date of the retrieval.</li> 894 <li><strong>end</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime</span></code>) – The end date of the retrieval.</li> 895 <li><strong>delta_t</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime</span></code>) – Delta_t + 1 is the maximal time period of a single 896 retrieval.</li> 897 <li><strong>fluxes</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">boolean</span></code>, optional) – Decides if the flux parameters are to be retrieved or 898 the rest of the parameter list. 899 Default value is False.</li> 900 </ul> 901 </td> 902 </tr> 903 </tbody> 904 </table> 905 </dd></dl> 906 907 <dl class="function"> 908 <dt id="get_mars_data.get_mars_data"> 909 <code class="descclassname">get_mars_data.</code><code class="descname">get_mars_data</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/get_mars_data.html#get_mars_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.get_mars_data" title="Permalink to this definition">¶</a></dt> 910 <dd><p>Retrieves the EC data needed for a FLEXPART simulation.</p> 911 <p>Start and end dates for retrieval period is set. Retrievals 912 are divided into smaller periods if necessary and datechunk parameter 913 is set.</p> 914 <table class="docutils field-list" frame="void" rules="none"> 915 <col class="field-name" /> 916 <col class="field-body" /> 917 <tbody valign="top"> 918 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and 919 command line.</td> 920 </tr> 921 </tbody> 922 </table> 923 </dd></dl> 924 925 <dl class="function"> 926 <dt id="get_mars_data.main"> 927 <code class="descclassname">get_mars_data.</code><code class="descname">main</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/get_mars_data.html#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.main" title="Permalink to this definition">¶</a></dt> 928 <dd><p>Controls the program to get data out of mars.</p> 929 <p>This is done if it is called directly from command line. 930 Then it also takes program call arguments and control file input.</p> 931 </dd></dl> 932 933 </div> 934 <div class="section" id="module-prepare_flexpart"> 935 <span id="prepare-flexpart"></span><h3><a class="toc-backref" href="#id12">prepare_flexpart</a><a class="headerlink" href="#module-prepare_flexpart" title="Permalink to this headline">¶</a></h3> 936 <dl class="function"> 937 <dt id="prepare_flexpart.main"> 938 <code class="descclassname">prepare_flexpart.</code><code class="descname">main</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/prepare_flexpart.html#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#prepare_flexpart.main" title="Permalink to this definition">¶</a></dt> 939 <dd><p>Controls the program to prepare flexpart input files from mars data.</p> 940 <p>This is done if it is called directly from command line. 941 Then it also takes program call arguments and control file input.</p> 942 </dd></dl> 943 944 <dl class="function"> 945 <dt id="prepare_flexpart.prepare_flexpart"> 946 <code class="descclassname">prepare_flexpart.</code><code class="descname">prepare_flexpart</code><span class="sig-paren">(</span><em>ppid</em>, <em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/prepare_flexpart.html#prepare_flexpart"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#prepare_flexpart.prepare_flexpart" title="Permalink to this definition">¶</a></dt> 947 <dd><p>Converts the mars data into flexpart ready input files.</p> 948 <p>Specific data fields are converted to a different grid and the flux 949 data are going to be disaggregated. The data fields are collected by 950 hour and stored in a file with a specific FLEXPART relevant naming 951 convention.</p> 952 <table class="docutils field-list" frame="void" rules="none"> 953 <col class="field-name" /> 954 <col class="field-body" /> 955 <tbody valign="top"> 956 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 957 <li><strong>ppid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code>) – Contains the ppid number of the current ECMWF job. It will be None if 958 the method was called within this module.</li> 959 <li><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and 960 command line.</li> 961 </ul> 962 </td> 963 </tr> 964 </tbody> 965 </table> 966 </dd></dl> 967 968 </div> 969 <div class="section" id="module-tools"> 970 <span id="tools"></span><h3><a class="toc-backref" href="#id13">tools</a><a class="headerlink" href="#module-tools" title="Permalink to this headline">¶</a></h3> 971 <dl class="function"> 972 <dt id="tools.clean_up"> 973 <code class="descclassname">tools.</code><code class="descname">clean_up</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#clean_up"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.clean_up" title="Permalink to this definition">¶</a></dt> 974 <dd><p>Remove all files from intermediate directory (inputdir).</p> 975 <table class="docutils field-list" frame="void" rules="none"> 976 <col class="field-name" /> 977 <col class="field-body" /> 978 <tbody valign="top"> 979 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and 980 command line.</td> 981 </tr> 982 </tbody> 983 </table> 984 </dd></dl> 985 986 <dl class="function"> 987 <dt id="tools.get_cmdline_arguments"> 988 <code class="descclassname">tools.</code><code class="descname">get_cmdline_arguments</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#get_cmdline_arguments"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.get_cmdline_arguments" title="Permalink to this definition">¶</a></dt> 989 <dd><p>Decomposes the command line arguments and assigns them to variables. 990 Apply default values for non mentioned arguments.</p> 991 <table class="docutils field-list" frame="void" rules="none"> 992 <col class="field-name" /> 993 <col class="field-body" /> 994 <tbody valign="top"> 995 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><strong>args</strong> – Contains the commandline arguments from script/program call.</td> 996 </tr> 997 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Namespace</span></code></td> 998 </tr> 999 </tbody> 1000 </table> 1001 </dd></dl> 1002 1003 <dl class="function"> 1004 <dt id="tools.get_list_as_string"> 1005 <code class="descclassname">tools.</code><code class="descname">get_list_as_string</code><span class="sig-paren">(</span><em>list_obj</em>, <em>concatenate_sign='</em>, <em>'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#get_list_as_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.get_list_as_string" title="Permalink to this definition">¶</a></dt> 1006 <dd><p>Converts a list of arbitrary content into a single string.</p> 1007 <table class="docutils field-list" frame="void" rules="none"> 1008 <col class="field-name" /> 1009 <col class="field-body" /> 1010 <tbody valign="top"> 1011 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 1012 <li><strong>list_obj</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code>) – A list with arbitrary content.</li> 1013 <li><strong>concatenate_sign</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – A string which is used to concatenate the single 1014 list elements. Default value is “, “.</li> 1015 </ul> 1016 </td> 1017 </tr> 1018 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>str_of_list</strong> – The content of the list as a single string.</p> 1019 </td> 1020 </tr> 1021 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code></p> 1022 </td> 1023 </tr> 1024 </tbody> 1025 </table> 1026 </dd></dl> 1027 1028 <dl class="function"> 1029 <dt id="tools.init128"> 1030 <code class="descclassname">tools.</code><code class="descname">init128</code><span class="sig-paren">(</span><em>filepath</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#init128"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.init128" title="Permalink to this definition">¶</a></dt> 1031 <dd><p>Opens and reads the grib file with table 128 information.</p> 1032 <table class="docutils field-list" frame="void" rules="none"> 1033 <col class="field-name" /> 1034 <col class="field-body" /> 1035 <tbody valign="top"> 1036 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filepath</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Path to file of ECMWF grib table number 128.</td> 1037 </tr> 1038 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>table128</strong> – Contains the ECMWF grib table 128 information. 1039 The key is the parameter number and the value is the 1040 short name of the parameter.</td> 1041 </tr> 1042 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dictionary</span></code></td> 1043 </tr> 1044 </tbody> 1045 </table> 1046 </dd></dl> 1047 1048 <dl class="function"> 1049 <dt id="tools.make_dir"> 1050 <code class="descclassname">tools.</code><code class="descname">make_dir</code><span class="sig-paren">(</span><em>directory</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#make_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.make_dir" title="Permalink to this definition">¶</a></dt> 1051 <dd><p>Creates a directory and gives a warning if the directory 1052 already exists. The program stops only if there is another problem.</p> 1053 <table class="docutils field-list" frame="void" rules="none"> 1054 <col class="field-name" /> 1055 <col class="field-body" /> 1056 <tbody valign="top"> 1057 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>directory</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The directory name including the path which should be created.</td> 1058 </tr> 1059 </tbody> 1060 </table> 1061 </dd></dl> 1062 1063 <dl class="function"> 1064 <dt id="tools.my_error"> 1065 <code class="descclassname">tools.</code><code class="descname">my_error</code><span class="sig-paren">(</span><em>users</em>, <em>message='ERROR'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#my_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.my_error" title="Permalink to this definition">¶</a></dt> 1066 <dd><p>Prints a specified error message which can be passed to the function 1067 before exiting the program.</p> 1068 <table class="docutils field-list" frame="void" rules="none"> 1069 <col class="field-name" /> 1070 <col class="field-body" /> 1071 <tbody valign="top"> 1072 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 1073 <li><strong>user</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Contains all email addresses which should be notified. 1074 It might also contain just the ecmwf user name which wil trigger 1075 mailing to the associated email address for this user.</li> 1076 <li><strong>message</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Error message. Default value is “ERROR”.</li> 1077 </ul> 1078 </td> 1079 </tr> 1080 </tbody> 1081 </table> 1082 </dd></dl> 1083 1084 <dl class="function"> 1085 <dt id="tools.none_or_int"> 1086 <code class="descclassname">tools.</code><code class="descname">none_or_int</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#none_or_int"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.none_or_int" title="Permalink to this definition">¶</a></dt> 1087 <dd><p>Converts the input string into pythons None-type if the string 1088 contains string “None”. Otherwise it is converted to an integer value.</p> 1089 <table class="docutils field-list" frame="void" rules="none"> 1090 <col class="field-name" /> 1091 <col class="field-body" /> 1092 <tbody valign="top"> 1093 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – String to be checked for the “None” word.</td> 1094 </tr> 1095 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Return depends on the content of the input value. If it was “None”, 1096 then the python type None is returned. Otherwise the string is 1097 converted into an integer value.</td> 1098 </tr> 1099 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">None or int(value)</td> 1100 </tr> 1101 </tbody> 1102 </table> 1103 </dd></dl> 1104 1105 <dl class="function"> 1106 <dt id="tools.none_or_str"> 1107 <code class="descclassname">tools.</code><code class="descname">none_or_str</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#none_or_str"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.none_or_str" title="Permalink to this definition">¶</a></dt> 1108 <dd><p>Converts the input string into pythons None-type if the string 1109 contains string “None”.</p> 1110 <table class="docutils field-list" frame="void" rules="none"> 1111 <col class="field-name" /> 1112 <col class="field-body" /> 1113 <tbody valign="top"> 1114 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – String to be checked for the “None” word.</td> 1115 </tr> 1116 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Return depends on the content of the input value. If it was “None”, 1117 then the python type None is returned. Otherwise the string itself.</td> 1118 </tr> 1119 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">None or value</td> 1120 </tr> 1121 </tbody> 1122 </table> 1123 </dd></dl> 1124 1125 <dl class="function"> 1126 <dt id="tools.normal_exit"> 1127 <code class="descclassname">tools.</code><code class="descname">normal_exit</code><span class="sig-paren">(</span><em>users</em>, <em>message='Done!'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#normal_exit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.normal_exit" title="Permalink to this definition">¶</a></dt> 1128 <dd><p>Prints a specific exit message which can be passed to the function.</p> 1129 <table class="docutils field-list" frame="void" rules="none"> 1130 <col class="field-name" /> 1131 <col class="field-body" /> 1132 <tbody valign="top"> 1133 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 1134 <li><strong>user</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Contains all email addresses which should be notified. 1135 It might also contain just the ecmwf user name which wil trigger 1136 mailing to the associated email address for this user.</li> 1137 <li><strong>message</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Message for exiting program. Default value is “Done!”.</li> 1138 </ul> 1139 </td> 1140 </tr> 1141 </tbody> 1142 </table> 1143 </dd></dl> 1144 1145 <dl class="function"> 1146 <dt id="tools.product"> 1147 <code class="descclassname">tools.</code><code class="descname">product</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwds</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#product"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.product" title="Permalink to this definition">¶</a></dt> 1148 <dd><p>This method combines the single characters of the passed arguments 1149 with each other. So that each character of each argument value 1150 will be combined with each character of the other arguments as a tuple.</p> 1151 <div class="admonition note"> 1152 <p class="first admonition-title">Note</p> 1153 <p class="last">This method is taken from an example at the ECMWF wiki website. 1154 <a class="reference external" href="https://software.ecmwf.int/wiki/display/GRIB/index.py">https://software.ecmwf.int/wiki/display/GRIB/index.py</a>; 2018-03-16</p> 1155 </div> 1156 <p class="rubric">Example</p> 1157 <p>product(‘ABCD’, ‘xy’) –> Ax Ay Bx By Cx Cy Dx Dy</p> 1158 <p>product(range(2), repeat = 3) –> 000 001 010 011 100 101 110 111</p> 1159 <table class="docutils field-list" frame="void" rules="none"> 1160 <col class="field-name" /> 1161 <col class="field-body" /> 1162 <tbody valign="top"> 1163 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 1164 <li><strong>*args</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">tuple</span></code>) – Positional arguments (arbitrary number).</li> 1165 <li><strong>**kwds</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dictionary</span></code>) – Contains all the keyword arguments from *args.</li> 1166 </ul> 1167 </td> 1168 </tr> 1169 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>prod</strong> – Return will be done with “yield”. A tuple of combined arguments. 1170 See example in description above.</p> 1171 </td> 1172 </tr> 1173 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tuple</span></code></p> 1174 </td> 1175 </tr> 1176 </tbody> 1177 </table> 1178 </dd></dl> 1179 1180 <dl class="function"> 1181 <dt id="tools.put_file_to_ecserver"> 1182 <code class="descclassname">tools.</code><code class="descname">put_file_to_ecserver</code><span class="sig-paren">(</span><em>ecd</em>, <em>filename</em>, <em>target</em>, <em>ecuid</em>, <em>ecgid</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#put_file_to_ecserver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.put_file_to_ecserver" title="Permalink to this definition">¶</a></dt> 1183 <dd><p>Uses the ecaccess-file-put command to send a file to the ECMWF servers.</p> 1184 <div class="admonition note"> 1185 <p class="first admonition-title">Note</p> 1186 <p class="last">The return value is just for testing reasons. It does not have 1187 to be used from the calling function since the whole error handling 1188 is done in here.</p> 1189 </div> 1190 <table class="docutils field-list" frame="void" rules="none"> 1191 <col class="field-name" /> 1192 <col class="field-body" /> 1193 <tbody valign="top"> 1194 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 1195 <li><strong>ecd</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The path were the file is stored.</li> 1196 <li><strong>filename</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The name of the file to send to the ECMWF server.</li> 1197 <li><strong>target</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The target queue where the file should be sent to.</li> 1198 <li><strong>ecuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The user id on ECMWF server.</li> 1199 <li><strong>ecgid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The group id on ECMWF server.</li> 1200 </ul> 1201 </td> 1202 </tr> 1203 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>rcode</strong> – Resulting code of command execution. If successful the string 1204 will be empty.</p> 1205 </td> 1206 </tr> 1207 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code></p> 1208 </td> 1209 </tr> 1210 </tbody> 1211 </table> 1212 </dd></dl> 1213 1214 <dl class="function"> 1215 <dt id="tools.read_ecenv"> 1216 <code class="descclassname">tools.</code><code class="descname">read_ecenv</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#read_ecenv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.read_ecenv" title="Permalink to this definition">¶</a></dt> 1217 <dd><p>Reads the file into a dictionary where the key values are the parameter 1218 names.</p> 1219 <table class="docutils field-list" frame="void" rules="none"> 1220 <col class="field-name" /> 1221 <col class="field-body" /> 1222 <tbody valign="top"> 1223 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Path to file where the ECMWF environment parameters are stored.</td> 1224 </tr> 1225 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>envs</strong> – Contains the environment parameter ecuid, ecgid, gateway 1226 and destination for ECMWF server environments.</td> 1227 </tr> 1228 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dictionary</span></code></td> 1229 </tr> 1230 </tbody> 1231 </table> 1232 </dd></dl> 1233 1234 <dl class="function"> 1235 <dt id="tools.silent_remove"> 1236 <code class="descclassname">tools.</code><code class="descname">silent_remove</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#silent_remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.silent_remove" title="Permalink to this definition">¶</a></dt> 1237 <dd><p>Remove file if it exists. 1238 The function does not fail if the file does not exist.</p> 1239 <table class="docutils field-list" frame="void" rules="none"> 1240 <col class="field-name" /> 1241 <col class="field-body" /> 1242 <tbody valign="top"> 1243 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The name of the file to be removed without notification.</td> 1244 </tr> 1245 </tbody> 1246 </table> 1247 </dd></dl> 1248 1249 <dl class="function"> 1250 <dt id="tools.submit_job_to_ecserver"> 1251 <code class="descclassname">tools.</code><code class="descname">submit_job_to_ecserver</code><span class="sig-paren">(</span><em>target</em>, <em>jobname</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#submit_job_to_ecserver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.submit_job_to_ecserver" title="Permalink to this definition">¶</a></dt> 1252 <dd><p>Uses ecaccess-job-submit command to submit a job to the ECMWF server.</p> 1253 <div class="admonition note"> 1254 <p class="first admonition-title">Note</p> 1255 <p class="last">The return value is just for testing reasons. It does not have 1256 to be used from the calling function since the whole error handling 1257 is done in here.</p> 1258 </div> 1259 <table class="docutils field-list" frame="void" rules="none"> 1260 <col class="field-name" /> 1261 <col class="field-body" /> 1262 <tbody valign="top"> 1263 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 1264 <li><strong>target</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The target where the file should be sent to, e.g. the queue.</li> 1265 <li><strong>jobname</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The name of the jobfile to be submitted to the ECMWF server.</li> 1266 </ul> 1267 </td> 1268 </tr> 1269 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>rcode</strong> – Resulting code of command execution. If successful the string 1270 will contain an integer number, representing the id of the job 1271 at the ecmwf server.</p> 1272 </td> 1273 </tr> 1274 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code></p> 1275 </td> 1276 </tr> 1277 </tbody> 1278 </table> 1279 </dd></dl> 1280 1281 <dl class="function"> 1282 <dt id="tools.to_param_id"> 1283 <code class="descclassname">tools.</code><code class="descname">to_param_id</code><span class="sig-paren">(</span><em>pars</em>, <em>table</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#to_param_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.to_param_id" title="Permalink to this definition">¶</a></dt> 1284 <dd><p>Transform parameter names to parameter ids with ECMWF grib table 128.</p> 1285 <table class="docutils field-list" frame="void" rules="none"> 1286 <col class="field-name" /> 1287 <col class="field-body" /> 1288 <tbody valign="top"> 1289 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 1290 <li><strong>pars</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Addpar argument from CONTROL file in the format of 1291 parameter names instead of ids. The parameter short 1292 names are sepearted with “/” and they are passed as 1293 one single string.</li> 1294 <li><strong>table</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dictionary</span></code>) – Contains the ECMWF grib table 128 information. 1295 The key is the parameter number and the value is the 1296 short name of the parameter.</li> 1297 </ul> 1298 </td> 1299 </tr> 1300 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>ipar</strong> – List of addpar parameters from CONTROL file transformed to 1301 parameter ids in the format of integer.</p> 1302 </td> 1303 </tr> 1304 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">integer</span></code></p> 1305 </td> 1306 </tr> 1307 </tbody> 1308 </table> 1309 </dd></dl> 1310 1311 </div> 1312 <div class="section" id="module-disaggregation"> 1313 <span id="disaggregation"></span><h3><a class="toc-backref" href="#id14">disaggregation</a><a class="headerlink" href="#module-disaggregation" title="Permalink to this headline">¶</a></h3> 159 1314 <dl class="function"> 160 1315 <dt id="disaggregation.IA3"> … … 274 1429 275 1430 </div> 1431 </div> 1432 </div> 276 1433 277 1434 … … 286 1443 287 1444 288 <a href="user_guide .html" class="btn btn-neutral" title="User Guide" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>1445 <a href="user_guide/control_templates.html" class="btn btn-neutral" title="CONTROL-file templates" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> 289 1446 290 1447 </div> -
documentation/Sphinx/build/html/downloads.html
r708c667 r274f9ef 29 29 <link rel="index" title="Index" href="genindex.html" /> 30 30 <link rel="search" title="Search" href="search.html" /> 31 <link rel="next" title=" Installation" href="installation.html" />32 <link rel="prev" title="Welcome to flex_extract’s documentation!" href="index.html" />31 <link rel="next" title="Download tar-balls" href="downloads/tar_balls.html" /> 32 <link rel="prev" title="Welcome to flex_extract’s user documentation!" href="index.html" /> 33 33 34 34 … … 85 85 <p class="caption"><span class="caption-text">Table of Contents:</span></p> 86 86 <ul class="current"> 87 <li class="toctree-l1 current"><a class="current reference internal" href="#">Downloads</a></li> 87 <li class="toctree-l1 current"><a class="current reference internal" href="#">Downloads</a><ul> 88 <li class="toctree-l2"><a class="reference internal" href="downloads/tar_balls.html">Download tar-balls</a></li> 89 <li class="toctree-l2"><a class="reference internal" href="downloads/git_repo.html">Git Repository</a></li> 90 <li class="toctree-l2"><a class="reference internal" href="downloads/history_changes.html">History of Changes</a></li> 91 </ul> 92 </li> 88 93 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> 89 94 <li class="toctree-l1"><a class="reference internal" href="program_structure.html">Program Structure</a></li> … … 160 165 <blockquote> 161 166 <div>UNDER CONSTRUCTION</div></blockquote> 167 <div class="toctree-wrapper compound"> 168 </div> 162 169 </div> 163 170 … … 170 177 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 171 178 172 <a href=" installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>173 174 175 <a href="index.html" class="btn btn-neutral" title="Welcome to flex_extract’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>179 <a href="downloads/tar_balls.html" class="btn btn-neutral float-right" title="Download tar-balls" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> 180 181 182 <a href="index.html" class="btn btn-neutral" title="Welcome to flex_extract’s user documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> 176 183 177 184 </div> -
documentation/Sphinx/build/html/genindex.html
r708c667 r274f9ef 156 156 157 157 <div class="genindex-jumpbox"> 158 <a href="#D"><strong>D</strong></a> 158 <a href="#A"><strong>A</strong></a> 159 | <a href="#C"><strong>C</strong></a> 160 | <a href="#D"><strong>D</strong></a> 161 | <a href="#E"><strong>E</strong></a> 162 | <a href="#G"><strong>G</strong></a> 159 163 | <a href="#I"><strong>I</strong></a> 164 | <a href="#M"><strong>M</strong></a> 165 | <a href="#N"><strong>N</strong></a> 166 | <a href="#P"><strong>P</strong></a> 167 | <a href="#R"><strong>R</strong></a> 168 | <a href="#S"><strong>S</strong></a> 169 | <a href="#T"><strong>T</strong></a> 170 | <a href="#U"><strong>U</strong></a> 171 | <a href="#W"><strong>W</strong></a> 160 172 161 173 </div> 174 <h2 id="A">A</h2> 175 <table style="width: 100%" class="indextable genindextable"><tr> 176 <td style="width: 33%; vertical-align: top;"><ul> 177 <li><a href="api.html#ControlFile.ControlFile.assign_args_to_control">assign_args_to_control() (ControlFile.ControlFile method)</a> 178 </li> 179 </ul></td> 180 <td style="width: 33%; vertical-align: top;"><ul> 181 <li><a href="api.html#ControlFile.ControlFile.assign_envs_to_control">assign_envs_to_control() (ControlFile.ControlFile method)</a> 182 </li> 183 </ul></td> 184 </tr></table> 185 186 <h2 id="C">C</h2> 187 <table style="width: 100%" class="indextable genindextable"><tr> 188 <td style="width: 33%; vertical-align: top;"><ul> 189 <li><a href="api.html#ControlFile.ControlFile.check_conditions">check_conditions() (ControlFile.ControlFile method)</a> 190 </li> 191 <li><a href="api.html#ControlFile.ControlFile.check_install_conditions">check_install_conditions() (ControlFile.ControlFile method)</a> 192 </li> 193 <li><a href="api.html#tools.clean_up">clean_up() (in module tools)</a> 194 </li> 195 </ul></td> 196 <td style="width: 33%; vertical-align: top;"><ul> 197 <li><a href="api.html#ControlFile.ControlFile">ControlFile (class in ControlFile)</a> 198 199 <ul> 200 <li><a href="api.html#module-ControlFile">(module)</a> 201 </li> 202 </ul></li> 203 <li><a href="api.html#GribTools.GribTools.copy">copy() (GribTools.GribTools method)</a> 204 </li> 205 <li><a href="api.html#EcFlexpart.EcFlexpart.create">create() (EcFlexpart.EcFlexpart method)</a> 206 </li> 207 </ul></td> 208 </tr></table> 209 162 210 <h2 id="D">D</h2> 163 211 <table style="width: 100%" class="indextable genindextable"><tr> … … 165 213 <li><a href="api.html#disaggregation.dapoly">dapoly() (in module disaggregation)</a> 166 214 </li> 167 </ul></td>168 <td style="width: 33%; vertical-align: top;"><ul>169 215 <li><a href="api.html#disaggregation.darain">darain() (in module disaggregation)</a> 170 216 </li> 217 <li><a href="api.html#MarsRetrieval.MarsRetrieval.data_retrieve">data_retrieve() (MarsRetrieval.MarsRetrieval method)</a> 218 </li> 219 <li><a href="api.html#EcFlexpart.EcFlexpart.deacc_fluxes">deacc_fluxes() (EcFlexpart.EcFlexpart method)</a> 220 </li> 221 </ul></td> 222 <td style="width: 33%; vertical-align: top;"><ul> 223 <li><a href="api.html#install.delete_convert_build">delete_convert_build() (in module install)</a> 224 </li> 225 <li><a href="api.html#UioFiles.UioFiles.delete_files">delete_files() (UioFiles.UioFiles method)</a> 226 </li> 171 227 <li><a href="api.html#module-disaggregation">disaggregation (module)</a> 172 228 </li> 229 <li><a href="api.html#MarsRetrieval.MarsRetrieval.display_info">display_info() (MarsRetrieval.MarsRetrieval method)</a> 230 </li> 231 <li><a href="api.html#get_mars_data.do_retrievement">do_retrievement() (in module get_mars_data)</a> 232 </li> 233 </ul></td> 234 </tr></table> 235 236 <h2 id="E">E</h2> 237 <table style="width: 100%" class="indextable genindextable"><tr> 238 <td style="width: 33%; vertical-align: top;"><ul> 239 <li><a href="api.html#EcFlexpart.EcFlexpart">EcFlexpart (class in EcFlexpart)</a> 240 241 <ul> 242 <li><a href="api.html#module-EcFlexpart">(module)</a> 243 </li> 244 </ul></li> 245 </ul></td> 246 </tr></table> 247 248 <h2 id="G">G</h2> 249 <table style="width: 100%" class="indextable genindextable"><tr> 250 <td style="width: 33%; vertical-align: top;"><ul> 251 <li><a href="api.html#tools.get_cmdline_arguments">get_cmdline_arguments() (in module tools)</a> 252 </li> 253 <li><a href="api.html#install.get_install_cmdline_arguments">get_install_cmdline_arguments() (in module install)</a> 254 </li> 255 <li><a href="api.html#GribTools.GribTools.get_keys">get_keys() (GribTools.GribTools method)</a> 256 </li> 257 <li><a href="api.html#tools.get_list_as_string">get_list_as_string() (in module tools)</a> 258 </li> 259 </ul></td> 260 <td style="width: 33%; vertical-align: top;"><ul> 261 <li><a href="api.html#module-get_mars_data">get_mars_data (module)</a> 262 </li> 263 <li><a href="api.html#get_mars_data.get_mars_data">get_mars_data() (in module get_mars_data)</a> 264 </li> 265 <li><a href="api.html#GribTools.GribTools">GribTools (class in GribTools)</a> 266 267 <ul> 268 <li><a href="api.html#module-GribTools">(module)</a> 269 </li> 270 </ul></li> 173 271 </ul></td> 174 272 </tr></table> … … 178 276 <td style="width: 33%; vertical-align: top;"><ul> 179 277 <li><a href="api.html#disaggregation.IA3">IA3() (in module disaggregation)</a> 278 </li> 279 <li><a href="api.html#GribTools.GribTools.index">index() (GribTools.GribTools method)</a> 280 </li> 281 </ul></td> 282 <td style="width: 33%; vertical-align: top;"><ul> 283 <li><a href="api.html#tools.init128">init128() (in module tools)</a> 284 </li> 285 <li><a href="api.html#module-install">install (module)</a> 286 </li> 287 <li><a href="api.html#install.install_via_gateway">install_via_gateway() (in module install)</a> 288 </li> 289 </ul></td> 290 </tr></table> 291 292 <h2 id="M">M</h2> 293 <table style="width: 100%" class="indextable genindextable"><tr> 294 <td style="width: 33%; vertical-align: top;"><ul> 295 <li><a href="api.html#get_mars_data.main">main() (in module get_mars_data)</a> 296 297 <ul> 298 <li><a href="api.html#install.main">(in module install)</a> 299 </li> 300 <li><a href="api.html#prepare_flexpart.main">(in module prepare_flexpart)</a> 301 </li> 302 <li><a href="api.html#submit.main">(in module submit)</a> 303 </li> 304 </ul></li> 305 <li><a href="api.html#install.make_convert_build">make_convert_build() (in module install)</a> 306 </li> 307 <li><a href="api.html#tools.make_dir">make_dir() (in module tools)</a> 308 </li> 309 </ul></td> 310 <td style="width: 33%; vertical-align: top;"><ul> 311 <li><a href="api.html#MarsRetrieval.MarsRetrieval">MarsRetrieval (class in MarsRetrieval)</a> 312 313 <ul> 314 <li><a href="api.html#module-MarsRetrieval">(module)</a> 315 </li> 316 </ul></li> 317 <li><a href="api.html#install.mk_compilejob">mk_compilejob() (in module install)</a> 318 </li> 319 <li><a href="api.html#install.mk_env_vars">mk_env_vars() (in module install)</a> 320 </li> 321 <li><a href="api.html#install.mk_job_template">mk_job_template() (in module install)</a> 322 </li> 323 <li><a href="api.html#install.mk_tarball">mk_tarball() (in module install)</a> 324 </li> 325 <li><a href="api.html#tools.my_error">my_error() (in module tools)</a> 326 </li> 327 </ul></td> 328 </tr></table> 329 330 <h2 id="N">N</h2> 331 <table style="width: 100%" class="indextable genindextable"><tr> 332 <td style="width: 33%; vertical-align: top;"><ul> 333 <li><a href="api.html#tools.none_or_int">none_or_int() (in module tools)</a> 334 </li> 335 </ul></td> 336 <td style="width: 33%; vertical-align: top;"><ul> 337 <li><a href="api.html#tools.none_or_str">none_or_str() (in module tools)</a> 338 </li> 339 <li><a href="api.html#tools.normal_exit">normal_exit() (in module tools)</a> 340 </li> 341 </ul></td> 342 </tr></table> 343 344 <h2 id="P">P</h2> 345 <table style="width: 100%" class="indextable genindextable"><tr> 346 <td style="width: 33%; vertical-align: top;"><ul> 347 <li><a href="api.html#module-prepare_flexpart">prepare_flexpart (module)</a> 348 </li> 349 <li><a href="api.html#prepare_flexpart.prepare_flexpart">prepare_flexpart() (in module prepare_flexpart)</a> 350 </li> 351 <li><a href="api.html#EcFlexpart.EcFlexpart.prepare_fp_files">prepare_fp_files() (EcFlexpart.EcFlexpart method)</a> 352 </li> 353 <li><a href="api.html#MarsRetrieval.MarsRetrieval.print_info">print_info() (MarsRetrieval.MarsRetrieval method)</a> 354 </li> 355 </ul></td> 356 <td style="width: 33%; vertical-align: top;"><ul> 357 <li><a href="api.html#MarsRetrieval.MarsRetrieval.print_infodata_csv">print_infodata_csv() (MarsRetrieval.MarsRetrieval method)</a> 358 </li> 359 <li><a href="api.html#EcFlexpart.EcFlexpart.process_output">process_output() (EcFlexpart.EcFlexpart method)</a> 360 </li> 361 <li><a href="api.html#tools.product">product() (in module tools)</a> 362 </li> 363 <li><a href="api.html#tools.put_file_to_ecserver">put_file_to_ecserver() (in module tools)</a> 364 </li> 365 </ul></td> 366 </tr></table> 367 368 <h2 id="R">R</h2> 369 <table style="width: 100%" class="indextable genindextable"><tr> 370 <td style="width: 33%; vertical-align: top;"><ul> 371 <li><a href="api.html#tools.read_ecenv">read_ecenv() (in module tools)</a> 372 </li> 373 </ul></td> 374 <td style="width: 33%; vertical-align: top;"><ul> 375 <li><a href="api.html#EcFlexpart.EcFlexpart.retrieve">retrieve() (EcFlexpart.EcFlexpart method)</a> 376 </li> 377 </ul></td> 378 </tr></table> 379 380 <h2 id="S">S</h2> 381 <table style="width: 100%" class="indextable genindextable"><tr> 382 <td style="width: 33%; vertical-align: top;"><ul> 383 <li><a href="api.html#GribTools.GribTools.set_keys">set_keys() (GribTools.GribTools method)</a> 384 </li> 385 <li><a href="api.html#tools.silent_remove">silent_remove() (in module tools)</a> 386 </li> 387 </ul></td> 388 <td style="width: 33%; vertical-align: top;"><ul> 389 <li><a href="api.html#module-submit">submit (module)</a> 390 </li> 391 <li><a href="api.html#submit.submit">submit() (in module submit)</a> 392 </li> 393 <li><a href="api.html#tools.submit_job_to_ecserver">submit_job_to_ecserver() (in module tools)</a> 394 </li> 395 </ul></td> 396 </tr></table> 397 398 <h2 id="T">T</h2> 399 <table style="width: 100%" class="indextable genindextable"><tr> 400 <td style="width: 33%; vertical-align: top;"><ul> 401 <li><a href="api.html#ControlFile.ControlFile.to_list">to_list() (ControlFile.ControlFile method)</a> 402 </li> 403 </ul></td> 404 <td style="width: 33%; vertical-align: top;"><ul> 405 <li><a href="api.html#tools.to_param_id">to_param_id() (in module tools)</a> 406 </li> 407 <li><a href="api.html#module-tools">tools (module)</a> 408 </li> 409 </ul></td> 410 </tr></table> 411 412 <h2 id="U">U</h2> 413 <table style="width: 100%" class="indextable genindextable"><tr> 414 <td style="width: 33%; vertical-align: top;"><ul> 415 <li><a href="api.html#UioFiles.UioFiles">UioFiles (class in UioFiles)</a> 416 417 <ul> 418 <li><a href="api.html#module-UioFiles">(module)</a> 419 </li> 420 </ul></li> 421 </ul></td> 422 <td style="width: 33%; vertical-align: top;"><ul> 423 <li><a href="api.html#install.un_tarball">un_tarball() (in module install)</a> 424 </li> 425 </ul></td> 426 </tr></table> 427 428 <h2 id="W">W</h2> 429 <table style="width: 100%" class="indextable genindextable"><tr> 430 <td style="width: 33%; vertical-align: top;"><ul> 431 <li><a href="api.html#EcFlexpart.EcFlexpart.write_namelist">write_namelist() (EcFlexpart.EcFlexpart method)</a> 180 432 </li> 181 433 </ul></td> -
documentation/Sphinx/build/html/index.html
r708c667 r274f9ef 9 9 <meta name="viewport" content="width=device-width, initial-scale=1.0"> 10 10 11 <title>Welcome to flex_extract’s documentation! — flex_extract 7.1 alpha documentation</title>11 <title>Welcome to flex_extract’s user documentation! — flex_extract 7.1 alpha documentation</title> 12 12 13 13 … … 135 135 <li><a href="#">Docs</a> »</li> 136 136 137 <li>Welcome to flex_extract’s documentation!</li>137 <li>Welcome to flex_extract’s user documentation!</li> 138 138 139 139 … … 154 154 <div itemprop="articleBody"> 155 155 156 <div class="section" id="welcome-to-flex-extract-s-documentation"> 157 <h1>Welcome to flex_extract’s documentation!<a class="headerlink" href="#welcome-to-flex-extract-s-documentation" title="Permalink to this headline">¶</a></h1> 156 <div class="section" id="welcome-to-flex-extract-s-user-documentation"> 157 <h1>Welcome to flex_extract’s user documentation!<a class="headerlink" href="#welcome-to-flex-extract-s-user-documentation" title="Permalink to this headline">¶</a></h1> 158 <p>flex_extract is a software to retrieve meteorological fields from the European Centre for Medium-Range Weather Forecasts (ECMWF) Mars archive to server as input files for the FLEXTRA/FLEXPART Atmospheric Transport Modelling system.</p> 159 <p>All required second party software and libraries used within flex_extract is open source and free of charge.</p> 158 160 <table style="width:100%;"> 159 161 <tr> … … 239 241 <li class="toctree-l1"><a class="reference internal" href="program_structure.html">Program Structure</a></li> 240 242 <li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li> 241 <li class="toctree-l1"><a class="reference internal" href="api.html">Auto Generated Documentation</a></li> 243 <li class="toctree-l1"><a class="reference internal" href="api.html">Auto Generated Documentation</a><ul> 244 <li class="toctree-l2"><a class="reference internal" href="api.html#porgrams">Porgrams</a><ul> 245 <li class="toctree-l3"><a class="reference internal" href="api.html#module-install">install</a></li> 246 <li class="toctree-l3"><a class="reference internal" href="api.html#module-submit">submit</a></li> 247 </ul> 248 </li> 249 <li class="toctree-l2"><a class="reference internal" href="api.html#classes">Classes</a><ul> 250 <li class="toctree-l3"><a class="reference internal" href="api.html#module-ControlFile">ControlFile</a></li> 251 <li class="toctree-l3"><a class="reference internal" href="api.html#module-EcFlexpart">EcFlexpart</a></li> 252 <li class="toctree-l3"><a class="reference internal" href="api.html#module-GribTools">GribTools</a></li> 253 <li class="toctree-l3"><a class="reference internal" href="api.html#module-MarsRetrieval">MarsRetrieval</a></li> 254 <li class="toctree-l3"><a class="reference internal" href="api.html#module-UioFiles">UioFiles</a></li> 255 </ul> 256 </li> 257 <li class="toctree-l2"><a class="reference internal" href="api.html#modules">Modules</a><ul> 258 <li class="toctree-l3"><a class="reference internal" href="api.html#module-get_mars_data">get_mars_data</a></li> 259 <li class="toctree-l3"><a class="reference internal" href="api.html#module-prepare_flexpart">prepare_flexpart</a></li> 260 <li class="toctree-l3"><a class="reference internal" href="api.html#module-tools">tools</a></li> 261 <li class="toctree-l3"><a class="reference internal" href="api.html#module-disaggregation">disaggregation</a></li> 262 </ul> 263 </li> 264 </ul> 265 </li> 242 266 <li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li> 243 267 </ul> -
documentation/Sphinx/build/html/installation.html
r708c667 r274f9ef 29 29 <link rel="index" title="Index" href="genindex.html" /> 30 30 <link rel="search" title="Search" href="search.html" /> 31 <link rel="next" title=" Usage" href="usage.html" />32 <link rel="prev" title=" Requirements" href="requirements.html" />31 <link rel="next" title="Requirements" href="installation/requirements.html" /> 32 <link rel="prev" title="Downloads" href="downloads.html" /> 33 33 34 34 … … 83 83 84 84 85 <p class="caption"><span class="caption-text"> Contents:</span></p>85 <p class="caption"><span class="caption-text">Table of Contents:</span></p> 86 86 <ul class="current"> 87 <li class="toctree-l1"><a class="reference internal" href="requirements.html">Requirements</a></li> 88 <li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a></li> 89 <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li> 90 <li class="toctree-l1"><a class="reference internal" href="API.html">Auto Generated Documentation</a></li> 87 <li class="toctree-l1"><a class="reference internal" href="downloads.html">Downloads</a></li> 88 <li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul> 89 <li class="toctree-l2"><a class="reference internal" href="installation/requirements.html">Requirements</a></li> 90 <li class="toctree-l2"><a class="reference internal" href="installation/oper_modes.html">Operating modes</a></li> 91 <li class="toctree-l2"><a class="reference internal" href="installation/test_install.html">Installation test</a></li> 92 </ul> 93 </li> 94 <li class="toctree-l1"><a class="reference internal" href="program_structure.html">Program Structure</a></li> 95 <li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li> 96 <li class="toctree-l1"><a class="reference internal" href="api.html">Auto Generated Documentation</a></li> 97 <li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li> 91 98 </ul> 92 99 … … 155 162 <div class="section" id="installation"> 156 163 <h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1> 157 <p>Describe installation process flex_extract ….</p>158 164 <blockquote> 159 165 <div>UNDER CONSTRUCTION</div></blockquote> 166 <div class="toctree-wrapper compound"> 167 </div> 160 168 </div> 161 169 … … 168 176 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 169 177 170 <a href=" usage.html" class="btn btn-neutral float-right" title="Usage" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>171 172 173 <a href=" requirements.html" class="btn btn-neutral" title="Requirements" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>178 <a href="installation/requirements.html" class="btn btn-neutral float-right" title="Requirements" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> 179 180 181 <a href="downloads.html" class="btn btn-neutral" title="Downloads" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> 174 182 175 183 </div> -
documentation/Sphinx/build/html/program_structure.html
r708c667 r274f9ef 29 29 <link rel="index" title="Index" href="genindex.html" /> 30 30 <link rel="search" title="Search" href="search.html" /> 31 <link rel="next" title=" User Guide" href="user_guide.html" />32 <link rel="prev" title="Installation " href="installation.html" />31 <link rel="next" title="Program Overview" href="program_structure/prog_overview.html" /> 32 <link rel="prev" title="Installation test" href="installation/test_install.html" /> 33 33 34 34 … … 87 87 <li class="toctree-l1"><a class="reference internal" href="downloads.html">Downloads</a></li> 88 88 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> 89 <li class="toctree-l1 current"><a class="current reference internal" href="#">Program Structure</a></li> 89 <li class="toctree-l1 current"><a class="current reference internal" href="#">Program Structure</a><ul> 90 <li class="toctree-l2"><a class="reference internal" href="program_structure/prog_overview.html">Program Overview</a></li> 91 <li class="toctree-l2"><a class="reference internal" href="program_structure/prog_components.html">Program Components</a></li> 92 <li class="toctree-l2"><a class="reference internal" href="program_structure/prog_flow.html">Program Flow</a></li> 93 </ul> 94 </li> 90 95 <li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li> 91 96 <li class="toctree-l1"><a class="reference internal" href="api.html">Auto Generated Documentation</a></li> … … 160 165 <blockquote> 161 166 <div>UNDER CONSTRUCTION</div></blockquote> 167 <div class="toctree-wrapper compound"> 168 </div> 162 169 </div> 163 170 … … 170 177 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 171 178 172 <a href=" user_guide.html" class="btn btn-neutral float-right" title="User Guide" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>173 174 175 <a href="installation .html" class="btn btn-neutral" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>179 <a href="program_structure/prog_overview.html" class="btn btn-neutral float-right" title="Program Overview" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> 180 181 182 <a href="installation/test_install.html" class="btn btn-neutral" title="Installation test" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> 176 183 177 184 </div> -
documentation/Sphinx/build/html/py-modindex.html
r708c667 r274f9ef 160 160 161 161 <div class="modindex-jumpbox"> 162 <a href="#cap-d"><strong>d</strong></a> 162 <a href="#cap-c"><strong>c</strong></a> | 163 <a href="#cap-d"><strong>d</strong></a> | 164 <a href="#cap-e"><strong>e</strong></a> | 165 <a href="#cap-g"><strong>g</strong></a> | 166 <a href="#cap-i"><strong>i</strong></a> | 167 <a href="#cap-m"><strong>m</strong></a> | 168 <a href="#cap-p"><strong>p</strong></a> | 169 <a href="#cap-s"><strong>s</strong></a> | 170 <a href="#cap-t"><strong>t</strong></a> | 171 <a href="#cap-u"><strong>u</strong></a> 163 172 </div> 164 173 165 174 <table class="indextable modindextable"> 175 <tr class="pcap"><td></td><td> </td><td></td></tr> 176 <tr class="cap" id="cap-c"><td></td><td> 177 <strong>c</strong></td><td></td></tr> 178 <tr> 179 <td></td> 180 <td> 181 <a href="api.html#module-ControlFile"><code class="xref">ControlFile</code></a></td><td> 182 <em></em></td></tr> 166 183 <tr class="pcap"><td></td><td> </td><td></td></tr> 167 184 <tr class="cap" id="cap-d"><td></td><td> … … 171 188 <td> 172 189 <a href="api.html#module-disaggregation"><code class="xref">disaggregation</code></a></td><td> 190 <em></em></td></tr> 191 <tr class="pcap"><td></td><td> </td><td></td></tr> 192 <tr class="cap" id="cap-e"><td></td><td> 193 <strong>e</strong></td><td></td></tr> 194 <tr> 195 <td></td> 196 <td> 197 <a href="api.html#module-EcFlexpart"><code class="xref">EcFlexpart</code></a></td><td> 198 <em></em></td></tr> 199 <tr class="pcap"><td></td><td> </td><td></td></tr> 200 <tr class="cap" id="cap-g"><td></td><td> 201 <strong>g</strong></td><td></td></tr> 202 <tr> 203 <td></td> 204 <td> 205 <a href="api.html#module-get_mars_data"><code class="xref">get_mars_data</code></a></td><td> 206 <em></em></td></tr> 207 <tr> 208 <td></td> 209 <td> 210 <a href="api.html#module-GribTools"><code class="xref">GribTools</code></a></td><td> 211 <em></em></td></tr> 212 <tr class="pcap"><td></td><td> </td><td></td></tr> 213 <tr class="cap" id="cap-i"><td></td><td> 214 <strong>i</strong></td><td></td></tr> 215 <tr> 216 <td></td> 217 <td> 218 <a href="api.html#module-install"><code class="xref">install</code></a></td><td> 219 <em></em></td></tr> 220 <tr class="pcap"><td></td><td> </td><td></td></tr> 221 <tr class="cap" id="cap-m"><td></td><td> 222 <strong>m</strong></td><td></td></tr> 223 <tr> 224 <td></td> 225 <td> 226 <a href="api.html#module-MarsRetrieval"><code class="xref">MarsRetrieval</code></a></td><td> 227 <em></em></td></tr> 228 <tr class="pcap"><td></td><td> </td><td></td></tr> 229 <tr class="cap" id="cap-p"><td></td><td> 230 <strong>p</strong></td><td></td></tr> 231 <tr> 232 <td></td> 233 <td> 234 <a href="api.html#module-prepare_flexpart"><code class="xref">prepare_flexpart</code></a></td><td> 235 <em></em></td></tr> 236 <tr class="pcap"><td></td><td> </td><td></td></tr> 237 <tr class="cap" id="cap-s"><td></td><td> 238 <strong>s</strong></td><td></td></tr> 239 <tr> 240 <td></td> 241 <td> 242 <a href="api.html#module-submit"><code class="xref">submit</code></a></td><td> 243 <em></em></td></tr> 244 <tr class="pcap"><td></td><td> </td><td></td></tr> 245 <tr class="cap" id="cap-t"><td></td><td> 246 <strong>t</strong></td><td></td></tr> 247 <tr> 248 <td></td> 249 <td> 250 <a href="api.html#module-tools"><code class="xref">tools</code></a></td><td> 251 <em></em></td></tr> 252 <tr class="pcap"><td></td><td> </td><td></td></tr> 253 <tr class="cap" id="cap-u"><td></td><td> 254 <strong>u</strong></td><td></td></tr> 255 <tr> 256 <td></td> 257 <td> 258 <a href="api.html#module-UioFiles"><code class="xref">UioFiles</code></a></td><td> 173 259 <em></em></td></tr> 174 260 </table> -
documentation/Sphinx/build/html/requirements.html
r708c667 r274f9ef 29 29 <link rel="index" title="Index" href="genindex.html" /> 30 30 <link rel="search" title="Search" href="search.html" /> 31 <link rel="next" title=" Installation" href="installation.html" />32 <link rel="prev" title=" Welcome to flex_extract’s documentation!" href="index.html" />31 <link rel="next" title="Operating modes" href="oper_modes.html" /> 32 <link rel="prev" title="Installation" href="installation.html" /> 33 33 34 34 … … 83 83 84 84 85 <p class="caption"><span class="caption-text"> Contents:</span></p>85 <p class="caption"><span class="caption-text">Table of Contents:</span></p> 86 86 <ul class="current"> 87 <li class="toctree-l1 current"><a class="current reference internal" href="#">Requirements</a></li> 88 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> 89 <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li> 90 <li class="toctree-l1"><a class="reference internal" href="API.html">Auto Generated Documentation</a></li> 87 <li class="toctree-l1"><a class="reference internal" href="downloads.html">Downloads</a></li> 88 <li class="toctree-l1 current"><a class="reference internal" href="installation.html">Installation</a><ul class="current"> 89 <li class="toctree-l2 current"><a class="current reference internal" href="#">Requirements</a></li> 90 <li class="toctree-l2"><a class="reference internal" href="oper_modes.html">Operating modes</a></li> 91 <li class="toctree-l2"><a class="reference internal" href="test_install.html">Installation test</a></li> 92 </ul> 93 </li> 94 <li class="toctree-l1"><a class="reference internal" href="program_structure.html">Program Structure</a></li> 95 <li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li> 96 <li class="toctree-l1"><a class="reference internal" href="api.html">Auto Generated Documentation</a></li> 97 <li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li> 91 98 </ul> 92 99 … … 133 140 134 141 <li><a href="index.html">Docs</a> »</li> 142 143 <li><a href="installation.html">Installation</a> »</li> 135 144 136 145 <li>Requirements</li> … … 155 164 <div class="section" id="requirements"> 156 165 <h1>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h1> 157 <p>Describe the requirements to use flex_extract ….</p>158 166 <blockquote> 159 167 <div>UNDER CONSTRUCTION</div></blockquote> … … 168 176 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 169 177 170 <a href=" installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>171 172 173 <a href="in dex.html" class="btn btn-neutral" title="Welcome to flex_extract’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>178 <a href="oper_modes.html" class="btn btn-neutral float-right" title="Operating modes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> 179 180 181 <a href="installation.html" class="btn btn-neutral" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> 174 182 175 183 </div> -
documentation/Sphinx/build/html/searchindex.js
r708c667 r274f9ef 1 Search.setIndex({docnames:["api","downloads"," index","installation","program_structure","requirements","support","user_guide"],envversion:54,filenames:["api.rst","downloads.rst","index.rst","installation.rst","program_structure.rst","requirements.rst","support.rst","user_guide.rst"],objects:{"":{disaggregation:[0,0,0,"-"]},disaggregation:{IA3:[0,1,1,""],dapoly:[0,1,1,""],darain:[0,1,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:function"},terms:{"class":[],"default":[],"float":0,"function":[],"int":[],"new":0,"return":0,"short":[],For:0,Its:0,The:0,Uses:[],abcd:[],about:[],abov:[],accumlu:0,accumul:0,adapt:0,adaptaion:[],adding:0,addit:0,addition:0,addpar:[],address:[],advanc:0,afterward:0,algorithm:0,alist:0,all:0,alreadi:[],also:[],ann:0,anoth:[],api:2,appli:0,applic:0,arbitrari:[],arcad:[],arg:[],argument:[],argumentpars:[],arrai:0,array_t1:0,array_t2:0,array_t3:0,array_t4:0,articl:0,assign:[],associ:0,asteroid:[],attribut:0,author:0,auto:2,ball:2,base:0,beck:0,befor:[],book:[],box:0,bug:2,call:[],can:[],central:0,chang:2,changehistori:[],charact:[],check:[],clean_up:[],code:[],coin:[],collect:[],combin:[],command:[],commandlin:[],common:0,complet:0,compon:2,concaten:[],concatenate_sign:[],conserv:0,construct:[1,2,3,4,5,6,7],contain:[],content:2,control:2,controlfil:[],convert:[],copi:0,copyright:0,creat:[],creativ:0,creativecommon:0,cubic:0,dapoli:0,darain:0,data:0,date:[],deaccumul:0,decompos:[],depend:[],describ:[1,3,4,5,6,7],descript:[],destin:[],develop:0,dict:[],dictionari:[],differ:2,dimens:0,dimension:0,directori:[],disaggreg:0,disaggregationreg:[],dispers:0,displai:[],doc:[],doe:[],done:0,download:2,draw:[],dure:0,each:0,ecaccess:[],ecd:[],ecflexpart:[],ecgid:[],ecmwf:0,ecmwv:[],ecuid:[],element:[],email:[],empti:[],env:[],environ:[],equal:0,error:[],exampl:[],execut:[],exist:[],exit:[],extens:0,fail:[],faq:2,field:0,file:[],filenam:[],filepath:[],filter:0,flex_extract:[1,3,4,5,7],flexpart:0,flow:2,flux:0,format:[],fortran:0,from:0,full:[],gatewai:[],gener:2,geometr:0,geoscientif:0,get:[],get_cmdline_argu:[],get_list_as_str:[],git:2,github:[],give:[],given:[],grib:[],grid:0,group:[],guid:2,haimberg:0,handl:[],have:0,help:[],here:2,histori:2,hittmeir:0,horizont:0,how:2,http:0,ia3:0,ids:[],improv:0,includ:[],index:2,inform:0,init128:[],input:0,inputdir:[],instal:2,instanc:[],instead:[],integ:[],integr:0,intermedi:[],intern:0,interpol:0,interv:0,ipar:[],issu:2,itself:[],jame:0,job:[],jobfil:[],jobnam:[],june:0,just:[],keep:0,kei:[],keyword:[],known:2,kwd:[],lagrangian:0,learn:[],length:0,leopold:0,letter:0,licens:[0,2],line:[],linear:0,linux:[],list:[0,2],list_obj:[],mac:[],mail:2,make_dir:[],march:0,mean:0,mention:[],messag:[],method:[],might:[],migrat:0,mode:2,model:0,modifi:0,modul:2,monoton:0,more:0,mountain:0,my_error:[],name:[],neg:0,nfield:0,non:0,none:[],none_or_int:[],none_or_str:[],normal_exit:[],note:[],noth:[],notif:[],notifi:[],novemb:0,number:[],obj:[],one:2,onli:[],open:[],oper:2,option:[1,6],org:0,origin:0,originla:[],other:[],otherwis:[],output:0,overview:2,page:2,par:[],paramet:0,particl:0,pass:[],path:[],petra:0,philipp:0,point:0,polynomi:0,posit:[],primit:[],print:[],problem:[],process:3,prod:[],product:[],program:2,properti:0,pure:[],put:2,put_file_to_ecserv:[],python:0,quantiti:0,queue:[],quick:[],rainfal:0,rang:[],raw:0,rcode:[],read:[],read_ecenv:[],reason:[],reconstruct:0,refer:0,releas:[],remov:[],repeat:[],replac:[],repositori:2,repres:[],requir:2,rest:[],result:[],sabin:0,sampl:0,scheme:0,script:[],search:2,second:[],see:0,seibert:0,send:0,sent:[],sepeart:[],seri:0,server:[],should:[],silent_remov:[],sinc:[],singl:[],size:[],smasher:[],softwar:[],solut:0,sourc:0,specif:[],specifi:[],sprite:[],stop:[],store:[],str_of_list:[],string:[],structur:2,subgrid:0,submit:[],submit_job_to_ecserv:[],success:[],support:2,system:2,tabl:[],table128:[],taken:[],tar:2,target:[],templat:2,test:2,text:2,thei:[],them:[],thi:0,three:0,ticket:2,time:0,timeseri:0,timespan:0,to_param_id:[],tool:[],transform:[],trigger:[],tupl:[],two:0,type:0,under:[0,1,3,4,5,6,7],univers:0,usa:0,usag:[],use:[2,5],used:0,user:2,using:[0,7],valu:0,variabl:[],vienna:0,view:0,visit:0,warn:[],websit:[],were:[],where:[],which:[0,2],whole:[],wiki:[],wil:[],window:[],within:0,without:[],word:[],work:0,yield:[]},titles:["Auto Generated Documentation","Downloads","Welcome to flex_extract\u2019s documentation!","Installation","Program Structure","Requirements","Support","User Guide"],titleterms:{auto:0,document:[0,2],download:1,flex_extract:2,gener:0,guid:7,indic:2,instal:3,program:4,pure:[],requir:5,rest:[],structur:4,support:6,tabl:2,usag:[],user:7,welcom:2}})1 Search.setIndex({docnames:["api","downloads","downloads/git_repo","downloads/history_changes","downloads/tar_balls","index","installation","installation/oper_modes","installation/requirements","installation/test_install","program_structure","program_structure/prog_components","program_structure/prog_flow","program_structure/prog_overview","support","support/faq","support/known_bugs_issues","support/mailing_list","support/ticket_system","user_guide","user_guide/control_templates","user_guide/how_to"],envversion:54,filenames:["api.rst","downloads.rst","downloads/git_repo.rst","downloads/history_changes.rst","downloads/tar_balls.rst","index.rst","installation.rst","installation/oper_modes.rst","installation/requirements.rst","installation/test_install.rst","program_structure.rst","program_structure/prog_components.rst","program_structure/prog_flow.rst","program_structure/prog_overview.rst","support.rst","support/faq.rst","support/known_bugs_issues.rst","support/mailing_list.rst","support/ticket_system.rst","user_guide.rst","user_guide/control_templates.rst","user_guide/how_to.rst"],objects:{"":{ControlFile:[0,0,0,"-"],EcFlexpart:[0,0,0,"-"],GribTools:[0,0,0,"-"],MarsRetrieval:[0,0,0,"-"],UioFiles:[0,0,0,"-"],disaggregation:[0,0,0,"-"],get_mars_data:[0,0,0,"-"],install:[0,0,0,"-"],prepare_flexpart:[0,0,0,"-"],submit:[0,0,0,"-"],tools:[0,0,0,"-"]},"ControlFile.ControlFile":{assign_args_to_control:[0,2,1,""],assign_envs_to_control:[0,2,1,""],check_conditions:[0,2,1,""],check_install_conditions:[0,2,1,""],to_list:[0,2,1,""]},"EcFlexpart.EcFlexpart":{create:[0,2,1,""],deacc_fluxes:[0,2,1,""],prepare_fp_files:[0,2,1,""],process_output:[0,2,1,""],retrieve:[0,2,1,""],write_namelist:[0,2,1,""]},"GribTools.GribTools":{copy:[0,2,1,""],get_keys:[0,2,1,""],index:[0,2,1,""],set_keys:[0,2,1,""]},"MarsRetrieval.MarsRetrieval":{data_retrieve:[0,2,1,""],display_info:[0,2,1,""],print_info:[0,2,1,""],print_infodata_csv:[0,2,1,""]},"UioFiles.UioFiles":{delete_files:[0,2,1,""]},ControlFile:{ControlFile:[0,1,1,""]},EcFlexpart:{EcFlexpart:[0,1,1,""]},GribTools:{GribTools:[0,1,1,""]},MarsRetrieval:{MarsRetrieval:[0,1,1,""]},UioFiles:{UioFiles:[0,1,1,""]},disaggregation:{IA3:[0,3,1,""],dapoly:[0,3,1,""],darain:[0,3,1,""]},get_mars_data:{do_retrievement:[0,3,1,""],get_mars_data:[0,3,1,""],main:[0,3,1,""]},install:{delete_convert_build:[0,3,1,""],get_install_cmdline_arguments:[0,3,1,""],install_via_gateway:[0,3,1,""],main:[0,3,1,""],make_convert_build:[0,3,1,""],mk_compilejob:[0,3,1,""],mk_env_vars:[0,3,1,""],mk_job_template:[0,3,1,""],mk_tarball:[0,3,1,""],un_tarball:[0,3,1,""]},prepare_flexpart:{main:[0,3,1,""],prepare_flexpart:[0,3,1,""]},submit:{main:[0,3,1,""],submit:[0,3,1,""]},tools:{clean_up:[0,3,1,""],get_cmdline_arguments:[0,3,1,""],get_list_as_string:[0,3,1,""],init128:[0,3,1,""],make_dir:[0,3,1,""],my_error:[0,3,1,""],none_or_int:[0,3,1,""],none_or_str:[0,3,1,""],normal_exit:[0,3,1,""],product:[0,3,1,""],put_file_to_ecserver:[0,3,1,""],read_ecenv:[0,3,1,""],silent_remove:[0,3,1,""],submit_job_to_ecserver:[0,3,1,""],to_param_id:[0,3,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"boolean":0,"class":5,"default":0,"final":0,"float":0,"function":0,"int":0,"new":0,"public":0,"return":0,"short":0,"switch":0,"true":0,For:0,Its:0,The:0,Then:0,Used:0,Uses:0,_expand:0,_templat:0,abcd:0,about:0,abov:0,access:0,accumlu:0,accumul:0,accuraci:0,actual:0,adapt:0,adaptaion:[],add:0,adding:0,addit:0,addition:0,addpar:0,address:0,advanc:0,afterward:0,algorithm:0,alist:0,all:[0,5],alpabet:0,alreadi:0,also:0,ann:0,anoth:0,api:[0,5],appli:0,applic:0,arbitrari:0,arcad:[],archiv:5,area:0,arg:0,argument:0,argumentpars:[],arrai:0,array_t1:0,array_t2:0,array_t3:0,array_t4:0,articl:0,assign:0,assign_args_to_control:0,assign_envs_to_control:0,associ:0,asteroid:[],atmospher:5,attribut:0,author:0,auto:5,ball:5,base:0,beck:0,befor:0,binari:0,book:[],box:0,bug:5,build:0,call:0,can:0,cca:0,centr:5,central:0,chang:5,changehistori:[],charact:0,charg:5,check:0,check_condit:0,check_install_condit:0,chunk:0,clean:0,clean_up:0,code:0,coin:[],collect:0,combin:0,command:0,commandlin:0,common:0,compil:0,complet:0,compon:5,concaten:0,concatenate_sign:0,condit:0,connect:0,conserv:0,construct:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21],contain:0,content:[0,5],control:[0,5],controlfil:5,convent:0,convers:0,convert2:0,convert:0,copi:0,copyright:0,correctli:0,correspond:0,coupl:0,creat:0,creativ:0,creativecommon:0,csv:0,cubic:0,current:0,dapoli:0,darain:0,data:0,data_retriev:0,dataset:0,date:0,datechunk:0,datetim:0,deacc_flux:0,deaccumul:0,debug:0,decid:0,decis:0,decompos:0,defin:0,delet:0,delete_convert_build:0,delete_fil:0,delta_t:0,depend:0,describ:[1,10],descript:0,destin:0,detail:0,develop:0,dict:[],dictionari:0,differ:[0,5],dimens:0,dimension:0,directli:0,directori:0,disaggreg:5,disaggregationreg:[],dispers:0,displai:0,display_info:0,divid:0,do_retriev:0,doc:[],doe:0,done:0,download:5,draw:[],dure:0,each:0,ecaccess:0,ecd:0,ecflexpart:5,ecgat:0,ecgid:0,ecmwf:[0,5],ecmwf_env:0,ecmwfdatadir:0,ecmwfdataserv:0,ecmwfservic:0,ecmwv:[],ecstorag:0,ectran:0,ecuid:0,element:0,email:0,empti:0,end:0,entri:0,env:0,environ:0,environment:0,equal:0,error:0,european:5,everyth:0,exampl:0,except:0,execut:0,exedir:0,exist:0,exit:0,express:0,expver:0,extens:0,extra:0,extract:0,fail:0,fals:0,faq:5,field:[0,5],file:[0,5],filemod:0,filenam:0,filename_in:0,filepath:0,filter:0,flex_extract:[0,1,10],flexpart:[0,5],flexpart_root_script:0,flextra:5,flow:5,flux:0,follow:0,forecast:5,format:0,fort:0,fortran:0,found:0,fp_root:0,free:5,from:[0,5],fromfil:0,full:0,gate:0,gatewai:0,gaussian:0,gener:5,geometr:0,geoscientif:0,get:0,get_cmdline_argu:0,get_install_cmdline_argu:0,get_kei:0,get_list_as_str:0,get_mars_data:5,git:5,github:[],give:0,given:0,goe:0,going:0,grib2:0,grib:0,gribtool:5,grid:0,group:0,guid:5,haimberg:0,handl:0,has:0,have:0,help:[],here:[0,5],histori:5,hittmeir:0,horizont:0,hour:0,how:5,http:0,ia3:0,identif:0,identificationkeyword:0,ids:0,idx:0,iid:0,improv:0,includ:0,index:[0,5],index_fil:0,index_kei:0,indic:0,inform:0,init128:0,initialis:0,input:[0,5],inputdir:0,inputfil:0,instal:5,install_via_gatewai:0,instanc:0,instead:0,instruct:0,integ:0,integr:0,intermedi:0,intern:0,interpol:0,interv:0,ipar:0,issu:5,iter:0,its:0,itself:0,jame:0,job:0,jobfil:0,jobnam:0,jtemplat:0,june:0,just:0,keep:0,kei:0,keynam:0,keyvalu:0,keyword:0,known:5,kwd:0,lagrangian:0,learn:[],length:0,leopold:0,letter:0,levelist:0,levtyp:0,librari:5,licens:[0,5],line:0,linear:0,linux:[],list:[0,5],list_obj:0,local:0,mac:[],machin:0,made:0,mail:[0,5],main:0,make_convert_build:0,make_dir:0,makefil:0,manipul:0,mar:[0,5],march:0,marsclass:0,marsretriev:5,matter:0,maxb:0,maxim:0,maxl:0,mdpdeta:0,mean:0,medium:5,meet:0,member:0,mention:0,messag:0,meta:0,metadiff:0,metapar:0,meteorolog:5,method:0,mgauss:0,might:0,migrat:0,mk_compilejob:0,mk_env_var:0,mk_job_templ:0,mk_tarbal:0,mlevel:0,mlevelist:0,mnauf:0,mod:0,mode:[0,5],model:[0,5],modif:0,modifi:0,modul:5,momega:0,momegadiff:0,monoton:0,more:0,mountain:0,move:0,msmooth:0,my_error:0,name:0,namelist:0,namespac:0,necessari:0,need:0,neg:0,nfield:0,non:0,none:0,none_or_int:0,none_or_str:0,normal_exit:0,note:[],noth:[],notif:0,notifi:0,novemb:0,number:0,obj:[],object:0,one:[0,5],onli:0,open:[0,5],oper:5,option:[0,1],order:0,org:0,origin:0,originla:[],other:0,otherwis:0,out:0,output:0,over:0,overview:5,overwrit:0,page:5,par:0,param:0,paramet:0,parameternam:0,parti:5,particl:0,pass:0,path:0,pattern:0,per:0,perform:0,period:0,petra:0,philipp:0,point:0,polynomi:0,porgram:5,posit:0,postprocess:0,ppid:0,prepar:0,prepare_flexpart:5,prepare_fp_fil:0,primit:[],print:0,print_info:0,print_infodata_csv:0,problem:0,process:0,process_output:0,prod:0,product:0,program:[0,5],properli:0,properti:0,provid:0,pure:[],put:[0,5],put_file_to_ecserv:0,python:0,quantiti:0,queue:0,quick:[],rainfal:0,rang:[0,5],raw:0,rcode:0,read:0,read_ecenv:0,readi:0,reason:0,reconstruct:0,refer:0,regular:0,releas:[],relev:0,remot:0,remov:0,repeat:0,replac:[],report:0,repositori:5,repr:0,repres:0,request:0,request_numb:0,requir:5,resol:0,rest:0,result:0,retriev:[0,5],return_list:0,rla0:0,rla1:0,rlo0:0,rlo1:0,root:0,sabin:0,same:0,sampl:0,scheme:0,script:0,search:5,second:5,see:0,seibert:0,select:0,selectwher:0,send:0,sent:0,sepeart:0,seper:0,seri:0,server:[0,5],set:0,set_kei:0,shell:0,should:0,silent_remov:0,simul:0,sinc:0,singl:0,size:[],smaller:0,smasher:[],softwar:[0,5],solut:0,some:[],sort:0,sourc:[0,5],specif:0,specifi:0,sprite:[],src_path:0,standard:0,start:0,state:0,statement:0,step:0,steprang:0,stop:0,storag:0,store:0,str_of_list:0,stream:0,stress:0,strict:0,string:0,structur:5,sub:0,subgrid:0,submiss:0,submit:5,submit_job_to_ecserv:0,subprocess:0,success:0,support:5,surfac:0,system:5,tabl:0,table128:0,take:0,taken:0,tar:[0,5],tarbal:0,tarball_path:0,target:0,temp:0,templat:[0,5],temporari:0,test:[0,5],text:5,thei:0,them:0,thi:0,those:0,three:0,through:0,ticket:5,time:0,timeseri:0,timespan:0,to_list:0,to_param_id:0,tool:5,transfer:0,transform:0,transport:5,trigger:0,tupl:0,two:0,type:0,udoc:0,uiofil:5,un_tarbal:0,under:[0,1,2,3,4,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21],uniqu:0,univers:0,usa:0,usag:[],use:5,used:[0,5],user:0,using:0,util:0,valu:0,variabl:0,version:0,via:0,vienna:0,view:0,visit:0,warn:0,weather:5,web:0,websit:0,well:0,were:0,what:[],where:0,wherekeynam:0,wherekeyvalu:0,which:[0,5],whole:0,wiki:0,wil:0,window:[],within:[0,5],without:0,word:0,work:0,write:0,write_namelist:0,written:0,yield:0,yyyymmdd:0},titles:["Auto Generated Documentation","Downloads","Git Repository","History of Changes","Download tar-balls","Welcome to flex_extract\u2019s user documentation!","Installation","Operating modes","Requirements","Installation test","Program Structure","Program Components","Program Flow","Program Overview","Support","FAQ - Frequently asked questions","Known Bugs and Issues","Mailing Lists","Ticket System","User Guide","CONTROL-file templates","How to use flex_extract"],titleterms:{"class":0,ask:15,auto:0,ball:4,bug:16,chang:3,compon:11,content:[],control:20,controlfil:0,disaggreg:0,document:[0,5],download:[1,4],ecflexpart:0,faq:15,file:20,flex_extract:[5,21],flow:12,frequent:15,gener:0,get_mars_data:0,git:2,gribtool:0,guid:19,histori:3,how:21,indic:5,instal:[0,6,9],issu:16,known:16,list:17,mail:17,marsretriev:0,mode:7,modul:0,oper:7,overview:13,porgram:0,prepare_flexpart:0,program:[10,11,12,13],pure:[],question:15,repositori:2,requir:8,rest:[],structur:10,submit:0,support:14,system:18,tabl:5,tar:4,templat:20,test:9,ticket:18,tool:0,uiofil:0,usag:[],use:21,user:[5,19],welcom:5}}) -
documentation/Sphinx/build/html/support.html
r708c667 r274f9ef 29 29 <link rel="index" title="Index" href="genindex.html" /> 30 30 <link rel="search" title="Search" href="search.html" /> 31 <link rel="next" title="Ticket System" href="support/ticket_system.html" /> 31 32 <link rel="prev" title="Auto Generated Documentation" href="api.html" /> 32 33 … … 89 90 <li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li> 90 91 <li class="toctree-l1"><a class="reference internal" href="api.html">Auto Generated Documentation</a></li> 91 <li class="toctree-l1 current"><a class="current reference internal" href="#">Support</a></li> 92 <li class="toctree-l1 current"><a class="current reference internal" href="#">Support</a><ul> 93 <li class="toctree-l2"><a class="reference internal" href="support/ticket_system.html">Ticket System</a></li> 94 <li class="toctree-l2"><a class="reference internal" href="support/mailing_list.html">Mailing Lists</a></li> 95 <li class="toctree-l2"><a class="reference internal" href="support/known_bugs_issues.html">Known Bugs and Issues</a></li> 96 <li class="toctree-l2"><a class="reference internal" href="support/faq.html">FAQ - Frequently asked questions</a></li> 97 </ul> 98 </li> 92 99 </ul> 93 100 … … 156 163 <div class="section" id="support"> 157 164 <h1>Support<a class="headerlink" href="#support" title="Permalink to this headline">¶</a></h1> 158 <p>Describe support options ….</p>159 165 <blockquote> 160 166 <div>UNDER CONSTRUCTION</div></blockquote> 167 <div class="toctree-wrapper compound"> 168 </div> 161 169 </div> 162 170 … … 168 176 169 177 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 178 179 <a href="support/ticket_system.html" class="btn btn-neutral float-right" title="Ticket System" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> 170 180 171 181 -
documentation/Sphinx/build/html/user_guide.html
r708c667 r274f9ef 29 29 <link rel="index" title="Index" href="genindex.html" /> 30 30 <link rel="search" title="Search" href="search.html" /> 31 <link rel="next" title=" Auto Generated Documentation" href="api.html" />32 <link rel="prev" title="Program Structure" href="program_structure.html" />31 <link rel="next" title="How to use flex_extract" href="user_guide/how_to.html" /> 32 <link rel="prev" title="Program Flow" href="program_structure/prog_flow.html" /> 33 33 34 34 … … 88 88 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> 89 89 <li class="toctree-l1"><a class="reference internal" href="program_structure.html">Program Structure</a></li> 90 <li class="toctree-l1 current"><a class="current reference internal" href="#">User Guide</a></li> 90 <li class="toctree-l1 current"><a class="current reference internal" href="#">User Guide</a><ul> 91 <li class="toctree-l2"><a class="reference internal" href="user_guide/how_to.html">How to use flex_extract</a></li> 92 <li class="toctree-l2"><a class="reference internal" href="user_guide/control_templates.html">CONTROL-file templates</a></li> 93 </ul> 94 </li> 91 95 <li class="toctree-l1"><a class="reference internal" href="api.html">Auto Generated Documentation</a></li> 92 96 <li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li> … … 157 161 <div class="section" id="user-guide"> 158 162 <h1>User Guide<a class="headerlink" href="#user-guide" title="Permalink to this headline">¶</a></h1> 159 <p>Describe using flex_extract ….</p>160 163 <blockquote> 161 164 <div>UNDER CONSTRUCTION</div></blockquote> 165 <div class="toctree-wrapper compound"> 166 </div> 162 167 </div> 163 168 … … 170 175 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 171 176 172 <a href=" api.html" class="btn btn-neutral float-right" title="Auto Generated Documentation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>173 174 175 <a href="program_structure .html" class="btn btn-neutral" title="Program Structure" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>177 <a href="user_guide/how_to.html" class="btn btn-neutral float-right" title="How to use flex_extract" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> 178 179 180 <a href="program_structure/prog_flow.html" class="btn btn-neutral" title="Program Flow" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> 176 181 177 182 </div>
Note: See TracChangeset
for help on using the changeset viewer.