Changeset ff99eae in flex_extract.git for python/get_mars_data.py

Timestamp:

Jun 1, 2018, 8:34:59 PM (6 years ago)

Author:

Anne Philipp <anne.philipp@…>

Branches:

master, ctbto, dev

Children:

e1228f3

Parents:

ccab809

Message:

completed application of pep8 style guide and pylint investigations. added documentation almost everywhere

File:

• python/get_mars_data.py (moved) (moved from python/getMARSdata.py) (15 diffs)

python/get_mars_data.py

@@ -1 +1 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-#************************************************************************
-# TODO AP
-# - add function docstrings!!!!
-#************************************************************************
 #*******************************************************************************
 # @Author: Anne Fouilloux (University of Oslo)
@@ -13 +9 @@
 #
 #    November 2015 - Leopold Haimberger (University of Vienna):
-#        - moved the getEIdata program into a function "getMARSdata"
+#        - moved the getEIdata program into a function "get_mars_data"
 #        - moved the AgurmentParser into a seperate function
 #        - adatpted the function for the use in flex_extract
-#        - renamed file to getMARSdata
+#        - renamed file to get_mars_data
 #
 #    February 2018 - Anne Philipp (University of Vienna):
@@ -42 +38 @@
 # @Program Content:
 #    - main
-#    - getMARSdata
+#    - get_mars_data
 #
 #*******************************************************************************
@@ -54 +50 @@
 import inspect
 try:
-    ecapi=True
+    ecapi = True
     import ecmwfapi
 except ImportError:
-    ecapi=False
+    ecapi = False
+
+# software specific classes and modules from flex_extract
+from tools import my_error, normal_exit, interpret_args_and_control
+from EcFlexpart import EcFlexpart
+from UioFiles import UioFiles
 
 # add path to pythonpath so that python finds its buddies
-localpythonpath = os.path.dirname(os.path.abspath(
+LOCAL_PYTHON_PATH = os.path.dirname(os.path.abspath(
     inspect.getfile(inspect.currentframe())))
-if localpythonpath not in sys.path:
-    sys.path.append(localpythonpath)
-
-# software specific classes and modules from flex_extract
-from ControlFile import ControlFile
-from Tools import myerror, normalexit, \
-                          interpret_args_and_control
-from ECFlexpart import ECFlexpart
-from UIOFiles import UIOFiles
+if LOCAL_PYTHON_PATH not in sys.path:
+    sys.path.append(LOCAL_PYTHON_PATH)
 
 # ------------------------------------------------------------------------------
@@ -78 +72 @@
     '''
     @Description:
-        If getMARSdata is called from command line, this function controls
+        If get_mars_data is called from command line, this function controls
         the program flow and calls the argumentparser function and
-        the getMARSdata function for retrieving EC data.
+        the get_mars_data function for retrieving EC data.
 
     @Input:
@@ -89 +83 @@
     '''
     args, c = interpret_args_and_control()
-    getMARSdata(args, c)
-    normalexit(c)
+    get_mars_data(c)
+    normal_exit(c)
 
     return
 
-def getMARSdata(args, c):
+def get_mars_data(c):
     '''
     @Description:
@@ -103 +97 @@
 
     @Input:
-        args: instance of ArgumentParser
-            Contains the commandline arguments from script/program call.
-
         c: instance of class ControlFile
             Contains all the parameters of CONTROL file, which are e.g.:
@@ -126 +117 @@
         os.makedirs(c.inputdir)
 
-    print("Retrieving EC data!")
-    print("start date %s " % (c.start_date))
-    print("end date %s " % (c.end_date))
+    print "Retrieving EC data!"
+    print "start date %s " % (c.start_date)
+    print "end date %s " % (c.end_date)
 
     if ecapi:
@@ -160 +151 @@
     # --------------  flux data ------------------------------------------------
     print 'removing old flux content of ' + c.inputdir
-    tobecleaned = UIOFiles('*_acc_*.' + str(os.getppid()) + '.*.grb')
-    tobecleaned.listFiles(c.inputdir)
-    tobecleaned.deleteFiles()
+    tobecleaned = UioFiles('*_acc_*.' + str(os.getppid()) + '.*.grb')
+    tobecleaned.list_files(c.inputdir)
+    tobecleaned.delete_files()
 
     # if forecast for maximum one day (upto 23h) are to be retrieved,
@@ -172 +163 @@
         while day < endp1:
             # retrieve MARS data for the whole period
-            flexpart = ECFlexpart(c, fluxes=True)
+            flexpart = EcFlexpart(c, fluxes=True)
             tmpday = day + datechunk - datetime.timedelta(days=1)
             if tmpday < endp1:
@@ -186 +177 @@
                 flexpart.retrieve(server, dates, c.inputdir)
             except IOError:
-                myerror(c, 'MARS request failed')
+                my_error(c, 'MARS request failed')
 
             day += datechunk
@@ -199 +190 @@
         while day <= end:
             # retrieve MARS data for the whole period
-            flexpart = ECFlexpart(c, fluxes=True)
+            flexpart = EcFlexpart(c, fluxes=True)
             tmpday = day + datechunk - datetime.timedelta(days=1)
             if tmpday < end:
@@ -213 +204 @@
                 flexpart.retrieve(server, dates, c.inputdir)
             except IOError:
-                myerror(c, 'MARS request failed')
+                my_error(c, 'MARS request failed')
 
             day += datechunk
@@ -219 +210 @@
     # --------------  non flux data --------------------------------------------
     print 'removing old non flux content of ' + c.inputdir
-    tobecleaned = UIOFiles('*__*.' + str(os.getppid()) + '.*.grb')
-    tobecleaned.listFiles(c.inputdir)
-    tobecleaned.deleteFiles()
+    tobecleaned = UioFiles('*__*.' + str(os.getppid()) + '.*.grb')
+    tobecleaned.list_files(c.inputdir)
+    tobecleaned.delete_files()
 
     day = start
     while day <= end:
-            # retrieve all non flux MARS data for the whole period
-            flexpart = ECFlexpart(c, fluxes=False)
-            tmpday = day + datechunk - datetime.timedelta(days=1)
-            if tmpday < end:
-                dates = day.strftime("%Y%m%d") + "/to/" + \
-                        tmpday.strftime("%Y%m%d")
-            else:
-                dates = day.strftime("%Y%m%d") + "/to/" + \
-                        end.strftime("%Y%m%d")
-
-            print "retrieve " + dates + " in dir " + c.inputdir
-
-            try:
-                flexpart.retrieve(server, dates, c.inputdir)
-            except IOError:
-                myerror(c, 'MARS request failed')
-
-            day += datechunk
+        # retrieve all non flux MARS data for the whole period
+        flexpart = EcFlexpart(c, fluxes=False)
+        tmpday = day + datechunk - datetime.timedelta(days=1)
+        if tmpday < end:
+            dates = day.strftime("%Y%m%d") + "/to/" + \
+                    tmpday.strftime("%Y%m%d")
+        else:
+            dates = day.strftime("%Y%m%d") + "/to/" + \
+                    end.strftime("%Y%m%d")
+
+        print "retrieve " + dates + " in dir " + c.inputdir
+
+        try:
+            flexpart.retrieve(server, dates, c.inputdir)
+        except IOError:
+            my_error(c, 'MARS request failed')
+
+        day += datechunk
 
     return
@@ -248 +239 @@
 if __name__ == "__main__":
     main()
-