Changeset 274f9ef in flex_extract.git for source/python/mods/prepare_flexpart.py

Timestamp:

Oct 22, 2018, 11:44:47 AM (6 years ago)

Author:

Anne Philipp <anne.philipp@…>

Branches:

master, ctbto, dev

Children:

db27c09

Parents:

708c667

Message:

Converted docstrings to numpy style and build first structure for sphinxdocumentation (incl API)

File:

• source/python/mods/prepare_flexpart.py (modified) (2 diffs)

source/python/mods/prepare_flexpart.py

@@ -79 +79 @@
 # ------------------------------------------------------------------------------
 def main():
-    '''
-    @Description:
-        If prepare_flexpart is called from command line, this function controls
-        the program flow and calls the argumentparser function and
-        the prepare_flexpart function for preparation of GRIB data for FLEXPART.
+    '''Controls the program to prepare flexpart input files from mars data.
 
-    @Input:
-        <nothing>
+    This is done if it is called directly from command line.
+    Then it also takes program call arguments and control file input.
 
-    @Return:
-        <nothing>
+    Parameters
+    ----------
+
+    Return
+    ------
+
     '''
 
@@ -105 +105 @@
 
 def prepare_flexpart(ppid, c):
-    '''
-    @Description:
-        Lists all grib files retrieved from MARS with get_mars_data and
-        uses prepares data for the use in FLEXPART. Specific data fields
-        are converted to a different grid and the flux data are going to be
-        disaggregated. The data fields are collected by hour and stored in
-        a file with a specific FLEXPART relevant naming convention.
+    '''Converts the mars data into flexpart ready input files.
 
-    @Input:
-        ppid: int
-            Contains the ppid number of the current ECMWF job. If it is called
-            from this script, it is "None".
+    Specific data fields are converted to a different grid and the flux
+    data are going to be disaggregated. The data fields are collected by
+    hour and stored in a file with a specific FLEXPART relevant naming
+    convention.
 
-        c: instance of class ControlFile
-            Contains all the parameters of CONTROL file and
-            command line.
-            For more information about format and content of the parameter
-            see documentation.
+    Parameters
+    ----------
+    ppid : :obj:`int`
+        Contains the ppid number of the current ECMWF job. It will be None if
+        the method was called within this module.
 
-    @Return:
-        <nothing>
+    c : :obj:`ControlFile`
+        Contains all the parameters of CONTROL file and
+        command line.
+
+    Return
+    ------
+
     '''