Changeset ff99eae in flex_extract.git for python/MarsRetrieval.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/MarsRetrieval.py (moved) (moved from python/MARSretrieval.py) (15 diffs)

python/MarsRetrieval.py

@@ -1 +1 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-#************************************************************************
-# TODO AP
-# -
-#************************************************************************
 #*******************************************************************************
 # @Author: Anne Fouilloux (University of Oslo)
@@ -13 +9 @@
 #
 #   November 2015 - Leopold Haimberger (University of Vienna):
-#        - optimized displayInfo
-#        - optimized dataRetrieve and seperate between python and shell
+#        - optimized display_info
+#        - optimized data_retrieve and seperate between python and shell
 #          script call
 #
@@ -37 +33 @@
 # @Class Content:
 #    - __init__
-#    - displayInfo
-#    - dataRetrieve
+#    - display_info
+#    - data_retrieve
+#
+# @Class Attributes:
+#    - server
+#    - marsclass
+#    - dtype
+#    - levtype
+#    - levelist
+#    - repres
+#    - date
+#    - resol
+#    - stream
+#    - area
+#    - time
+#    - step
+#    - expver
+#    - number
+#    - accuracy
+#    - grid
+#    - gaussian
+#    - target
+#    - param
 #
 #*******************************************************************************
@@ -48 +65 @@
 import os
 
-ecapi = True
-try:
-    import ecmwfapi
-except ImportError:
-    ecapi = False
-
 # ------------------------------------------------------------------------------
 # CLASS
 # ------------------------------------------------------------------------------
-class MARSretrieval:
+class MarsRetrieval(object):
     '''
     Class for submitting MARS retrievals.
@@ -68 +79 @@
     '''
 
-    def __init__(self, server, marsclass = "ei", type = "", levtype = "",
-                 levelist = "", repres = "", date = "", resol = "", stream = "",
-                 area = "", time = "", step = "", expver = "1", number = "",
-                 accuracy = "", grid = "", gaussian = "", target = "",
-                 param = ""):
+    def __init__(self, server, marsclass="ei", dtype="", levtype="",
+                 levelist="", repres="", date="", resol="", stream="",
+                 area="", time="", step="", expver="1", number="",
+                 accuracy="", grid="", gaussian="", target="",
+                 param=""):
         '''
         @Description:
-            Initialises the instance of the MARSretrieval class and
+            Initialises the instance of the MarsRetrieval class and
             defines and assigns a set of the necessary retrieval parameters
             for the FLEXPART input data.
@@ -84 +95 @@
 
         @Input:
-            self: instance of MARSretrieval
+            self: instance of MarsRetrieval
                 For description see class documentation.
 
@@ -96 +107 @@
                 Default is the ERA-Interim dataset "ei".
 
-            type: string, optional
+            dtype: string, optional
                 Determines the type of fields to be retrieved.
                 Selects between observations, images or fields.
@@ -275 +286 @@
         self.server = server
         self.marsclass = marsclass
-        self.type = type
+        self.dtype = dtype
         self.levtype = levtype
         self.levelist = levelist
@@ -296 +307 @@
 
 
-    def displayInfo(self):
+    def display_info(self):
         '''
         @Description:
@@ -302 +313 @@
 
         @Input:
-            self: instance of MARSretrieval
+            self: instance of MarsRetrieval
                 For description see class documentation.
 
@@ -314 +325 @@
         # with their corresponding values
         for item in attrs.items():
-            if item[0] in ('server'):
+            if item[0] in 'server':
                 pass
             else:
-                print(item[0] + ': ' + str(item[1]))
+                print item[0] + ': ' + str(item[1])
 
         return
 
-    def dataRetrieve(self):
+    def data_retrieve(self):
         '''
         @Description:
@@ -330 +341 @@
 
         @Input:
-            self: instance of MARSretrieval
+            self: instance of MarsRetrieval
                 For description see class documentation.
 
@@ -344 +355 @@
         s = 'ret'
         for k, v in attrs.iteritems():
-            if k in ('server'):
+            if k in 'server':
                 continue
             if k == 'marsclass':
@@ -360 +371 @@
                 self.server.execute(s, target)
             except:
-                print('MARS Request failed, \
-                    have you already registered at apps.ecmwf.int?')
+                print 'MARS Request failed, \
+                    have you already registered at apps.ecmwf.int?'
                 raise IOError
             if os.stat(target).st_size == 0:
-                print('MARS Request returned no data - please check request')
+                print 'MARS Request returned no data - please check request'
                 raise IOError
         # MARS request via extra process in shell
@@ -373 +384 @@
                                  stderr=subprocess.PIPE, bufsize=1)
             pout = p.communicate(input=s)[0]
-            print(pout.decode())
+            print pout.decode()
 
             if 'Some errors reported' in pout.decode():
-                print('MARS Request failed - please check request')
+                print 'MARS Request failed - please check request'
                 raise IOError
 
             if os.stat(target).st_size == 0:
-                print('MARS Request returned no data - please check request')
+                print 'MARS Request returned no data - please check request'
                 raise IOError