Changeset 6f951ca in flex_extract.git for source/python/submit.py

Timestamp:

Jan 15, 2019, 1:05:10 AM (5 years ago)

Author:

Anne Philipp <anne.philipp@…>

Branches:

master, ctbto, dev

Children:

d4696e0

Parents:

2625ca8

Message:

new style of docstring params and updates in docstrings

File:

• source/python/submit.py (modified) (6 diffs)

source/python/submit.py

@@ -18 +18 @@
 #        - changed path names to variables from config file
 #        - added option for writing mars requests to extra file
-#          additionally,as option without submitting the mars jobs
+#          additionally, as option without submitting the mars jobs
+#        - splitted submit function to use genshi templates for the
+#          job script and avoid code duplication
 #
 # @License:
-#    (C) Copyright 2014-2018.
-#
-#    This software is licensed under the terms of the Apache Licence Version 2.0
-#    which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
-#
-# @Program Functionality:
-#    This program is the main program of flex_extract and controls the
-#    program flow.
-#    If it is supposed to work locally then it works through the necessary
-#    functions get_mars_data and prepareFlexpart. Otherwise it prepares
-#    a shell job script which will do the necessary work on the
-#    ECMWF server and is submitted via ecaccess-job-submit.
-#
-# @Program Content:
-#    - main
-#    - submit
-#
+#    (C) Copyright 2014-2019.
+#    Anne Philipp, Leopold Haimberger
+#
+#    This work is licensed under the Creative Commons Attribution 4.0
+#    International License. To view a copy of this license, visit
+#    http://creativecommons.org/licenses/by/4.0/ or send a letter to
+#    Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
 #*******************************************************************************
+'''This script allows the user to extract meteorological fields from the ECMWF.
+
+It prepares the settings for retrieving the data from ECMWF servers and
+process the resulting files to prepare them for the use with FLEXPART or
+FLEXTRA.
+
+If it is supposed to work locally then it works through the necessary
+functions get_mars_data and prepare_flexpart. Otherwise it prepares
+a job script (korn shell) which will do the necessary work on the
+ECMWF server. This script will de submitted via the ecaccess command
+ecaccess-job-submit.
+
+This file can also be imported as a module which then contains the following
+functions:
+
+    * main - the main function of the script
+    * submit - calls mk_jobscript depending on operation mode and submits its
+    * mk_jobscript - creates the job script from a template
+
+Type: submit.py --help
+to get information about command line parameters.
+Read the documentation for usage instructions.
+'''
 
 # ------------------------------------------------------------------------------
@@ -59 +74 @@
 
 # ------------------------------------------------------------------------------
-# FUNCTIONS
+# METHODS
 # ------------------------------------------------------------------------------
 
@@ -112 +127 @@
     Parameters
     ----------
-    jtemplate : :obj:`string`
+    jtemplate : str
         Job template file from sub-directory "_templates" for
         submission to ECMWF. It contains all necessary
@@ -119 +134 @@
         Default is "job.temp".
 
-    c : :obj:`ControlFile`
+    c : ControlFile
         Contains all the parameters of CONTROL file and
         command line.
 
-    queue : :obj:`string`
+    queue : str
         Name of queue for submission to ECMWF (e.g. ecgate or cca )
 
@@ -201 +216 @@
     Parameters
     ----------
-    jtemplate : :obj:`string`
+    jtemplate : str
         Job template file from sub-directory "_templates" for
         submission to ECMWF. It contains all necessary
@@ -208 +223 @@
         Default is "job.temp".
 
-    job_file : :obj:`string`
+    job_file : str
         Path to the job script file.
 
-    clist : :obj:`list` of :obj:`string`
+    clist : list of str
         Contains all necessary parameters for ECMWF CONTROL file.