Changeset 274f9ef in flex_extract.git for source/python/mods/get_mars_data.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/get_mars_data.py (modified) (3 diffs)

source/python/mods/get_mars_data.py

@@ -69 +69 @@
 # ------------------------------------------------------------------------------
 def main():
-    '''
-    @Description:
-        If get_mars_data is called directly from command line,
-
-        the program flow and calls the argumentparser function and
-        the get_mars_data function for retrieving EC data.
-
-    @Input:
-        <nothing>
-
-    @Return:
-        <nothing>
+    '''Controls the program to get data out of mars.
+
+    This is done if it is called directly from command line.
+    Then it also takes program call arguments and control file input.
+
+    Parameters
+    ----------
+
+    Return
+    ------
+
     '''
 
@@ -97 +96 @@
 
 def get_mars_data(c):
-    '''
-    @Description:
-        Retrieves the EC data needed for a FLEXPART simulation.
-        Start and end dates for retrieval period is set. Retrievals
-        are divided into smaller periods if necessary and datechunk parameter
-        is set.
-
-    @Input:
-        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.
-
-    @Return:
-        <nothing>
+    '''Retrieves the EC data needed for a FLEXPART simulation.
+
+    Start and end dates for retrieval period is set. Retrievals
+    are divided into smaller periods if necessary and datechunk parameter
+    is set.
+
+    Parameters
+    ----------
+    c : :obj:`ControlFile`
+        Contains all the parameters of CONTROL file and
+        command line.
+
+    Return
+    ------
+
     '''
 
@@ -206 +204 @@
 
 def do_retrievement(c, server, start, end, delta_t, fluxes=False):
-    '''
-    @Description:
-        Divides the complete retrieval period in smaller chunks and
-        retrieves the data from MARS.
-
-    @Input:
-        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.
-
-        server: instance of ECMWFService
-            The server connection to ECMWF
-
-        start: instance of datetime
-            The start date of the retrieval.
-
-        end: instance of datetime
-            The end date of the retrieval.
-
-        delta_t: instance of datetime
-            Delta_t +1 is the maximal time period of a single
-            retrieval.
-
-        fluxes: boolean, optional
-            Decides if the flux parameters are to be retrieved or
-            the rest of the parameter list.
-            Default value is False.
-
-    @Return:
-        <nothing>
+    '''Divides the complete retrieval period in smaller chunks and
+    retrieves the data from MARS.
+
+    Parameters
+    ----------
+    c : :obj:`ControlFile`
+        Contains all the parameters of CONTROL file and
+        command line.
+
+    server : :obj:`ECMWFService`
+            The server connection to ECMWF.
+
+    start : :obj:`datetime`
+        The start date of the retrieval.
+
+    end : :obj:`datetime`
+        The end date of the retrieval.
+
+    delta_t : :obj:`datetime`
+        Delta_t + 1 is the maximal time period of a single
+        retrieval.
+
+    fluxes : :obj:`boolean`, optional
+        Decides if the flux parameters are to be retrieved or
+        the rest of the parameter list.
+        Default value is False.
+
+    Return
+    ------
+
     '''