Changeset ff99eae in flex_extract.git for python/prepare_flexpart.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/prepare_flexpart.py (moved) (moved from python/prepareFLEXPART.py) (12 diffs)

python/prepare_flexpart.py

@@ -2 +2 @@
 # -*- coding: utf-8 -*-
 #************************************************************************
-# TODO AP
-# - wieso cleanup in main wenn es in prepareflexpart bereits abgefragt wurde?
-#   doppelt gemoppelt?
+# ToDo AP
 # - wieso start=startm1 wenn basetime = 0 ?  wenn die fluxes nicht mehr
 #   relevant sind? verstehe ich nicht
@@ -29 +27 @@
 #        - added documentation
 #        - minor changes in programming style for consistence
-#        - BUG: removed call of cleanup-Function after call of
+#        - BUG: removed call of clean_up-Function after call of
 #               prepareFlexpart in main since it is already called in
 #               prepareFlexpart at the end!
 #        - created function main and moved the two function calls for
-#          arguments and prepareFLEXPART into it
+#          arguments and prepare_flexpart into it
 #
 # @License:
@@ -44 +42 @@
 #    This program prepares the final version of the grib files which are
 #    then used by FLEXPART. It converts the bunch of grib files extracted
-#    via getMARSdata by doing for example the necessary conversion to get
+#    via get_mars_data by doing for example the necessary conversion to get
 #    consistent grids or the disaggregation of flux data. Finally, the
 #    program combines the data fields in files per available hour with the
@@ -52 +50 @@
 # @Program Content:
 #    - main
-#    - prepareFLEXPART
+#    - prepare_flexpart
 #
 #*******************************************************************************
@@ -59 +57 @@
 # MODULES
 # ------------------------------------------------------------------------------
-import shutil
 import datetime
-#import time
 import os
 import inspect
 import sys
 import socket
-from argparse import ArgumentParser, ArgumentDefaultsHelpFormatter
 
-hostname = socket.gethostname()
-ecapi = 'ecmwf' not in hostname
+# software specific classes and modules from flex_extract
+from UioFiles import UioFiles
+from tools import interpret_args_and_control, clean_up
+from EcFlexpart import EcFlexpart
+
+ecapi = 'ecmwf' not in socket.gethostname()
 try:
     if ecapi:
@@ -77 +76 @@
 
 # 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)
+if LOCAL_PYTHON_PATH not in sys.path:
+    sys.path.append(LOCAL_PYTHON_PATH)
 
-# software specific classes and modules from flex_extract
-from UIOFiles import UIOFiles
-from Tools import interpret_args_and_control, cleanup
-from ECFlexpart import ECFlexpart
 # ------------------------------------------------------------------------------
 # FUNCTION
@@ -92 +87 @@
     '''
     @Description:
-        If prepareFLEXPART is called from command line, this function controls
+        If prepare_flexpart is called from command line, this function controls
         the program flow and calls the argumentparser function and
-        the prepareFLEXPART function for preparation of GRIB data for FLEXPART.
+        the prepare_flexpart function for preparation of GRIB data for FLEXPART.
 
     @Input:
@@ -103 +98 @@
     '''
     args, c = interpret_args_and_control()
-    prepareFLEXPART(args, c)
+    prepare_flexpart(args, c)
 
     return
 
-def prepareFLEXPART(args, c):
+def prepare_flexpart(args, c):
     '''
     @Description:
-        Lists all grib files retrieved from MARS with getMARSdata and
+        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
@@ -157 +152 @@
     # one day after the end date is needed
     startm1 = start - datetime.timedelta(days=1)
-    endp1 = end + datetime.timedelta(days=1)
+#    endp1 = end + datetime.timedelta(days=1)
 
     # get all files with flux data to be deaccumulated
-    inputfiles = UIOFiles('*OG_acc_SL*.' + c.ppid + '.*')
-    inputfiles.listFiles(c.inputdir)
+    inputfiles = UioFiles('*OG_acc_SL*.' + c.ppid + '.*')
+    inputfiles.list_files(c.inputdir)
 
     # create output dir if necessary
@@ -168 +163 @@
 
     # deaccumulate the flux data
-    flexpart = ECFlexpart(c, fluxes=True)
+    flexpart = EcFlexpart(c, fluxes=True)
     flexpart.write_namelist(c, 'fort.4')
     flexpart.deacc_fluxes(inputfiles, c)
 
-    print('Prepare ' + start.strftime("%Y%m%d") +
-          "/to/" + end.strftime("%Y%m%d"))
+    print 'Prepare ' + start.strftime("%Y%m%d") + \
+          "/to/" + end.strftime("%Y%m%d")
 
     # get a list of all files from the root inputdir
-    inputfiles = UIOFiles('????__??.*' + c.ppid + '.*')
-    inputfiles.listFiles(c.inputdir)
+    inputfiles = UioFiles('????__??.*' + c.ppid + '.*')
+    inputfiles.list_files(c.inputdir)
 
     # produce FLEXPART-ready GRIB files and
@@ -185 +180 @@
         start = startm1
 
-    flexpart = ECFlexpart(c, fluxes=False)
+    flexpart = EcFlexpart(c, fluxes=False)
     flexpart.create(inputfiles, c)
     flexpart.process_output(c)
@@ -192 +187 @@
     # otherwise delete temporary files
     if int(c.debug) != 0:
-        print('Temporary files left intact')
+        print 'Temporary files left intact'
     else:
-        cleanup(c)
+        clean_up(c)
 
     return