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

source/python/classes/GribTools.py

@@ -66 +66 @@
     # --------------------------------------------------------------------------
     def __init__(self, filenames):
-        '''
-        @Description:
-            Initialise an object of GribTools and assign a list
-            of filenames.
-
-        @Input:
-            filenames: list of strings
-                A list of filenames.
-
-        @Return:
-            <nothing>
+        '''Initialise an object of GribTools and assign a list of filenames.
+
+        Parameters
+        ----------
+        filenames : :obj:`list` of :obj:`strings`
+             A list of filenames.
+
+        Return
+        ------
+
         '''
 
@@ -85 +84 @@
 
     def get_keys(self, keynames, wherekeynames=[], wherekeyvalues=[]):
-        '''
-        @Description:
-            get keyvalues for a given list of keynames
-            a where statement can be given (list of key and list of values)
-
-        @Input:
-            keynames: list of strings
-                List of keynames.
-
-            wherekeynames: list of strings, optional
-                Default value is an empty list.
-
-            wherekeyvalues: list of strings, optional
-                Default value is an empty list.
-
-        @Return:
-            return_list: list of strings
-                List of keyvalues for given keynames.
+        '''Get keyvalues for a given list of keynames a where statement
+        can be given (list of key and list of values)
+
+        Parameters
+        ----------
+        keynames : :obj:`list` of :obj:`string`
+            List of keynames.
+
+        wherekeynames : :obj:`list` of :obj:`string`, optional
+            Default value is an empty list.
+
+        wherekeyvalues : :obj:`list` of :obj:`string`, optional
+            Default value is an empty list.
+
+        Return
+        ------
+        return_list : :obj:`list` of :obj:`string`
+            List of keyvalues for given keynames.
         '''
 
@@ -144 +143 @@
     def set_keys(self, fromfile, keynames, keyvalues, wherekeynames=[],
                  wherekeyvalues=[], strict=False, filemode='w'):
-        '''
-        @Description:
-            Opens the file to read the grib messages and then write
-            them to a new output file. By default all messages are
-            written out. Also, the keyvalues of the passed list of
-            keynames are set or only those meeting the where statement.
-            (list of key and list of values).
-
-        @Input:
-            fromfile: string
-                Filename of the input file to read the grib messages from.
-
-            keynames: list of strings
-                List of keynames. Default is an empty list.
-
-            keyvalues: list of strings
-                List of keynames. Default is an empty list.
-
-            wherekeynames: list of strings, optional
-                Default value is an empty list.
-
-            wherekeyvalues: list of strings, optional
-                Default value is an empty list.
-
-            strict: boolean, optional
-                Decides if everything from keynames and keyvalues
-                is written out the grib file (False) or only those
-                meeting the where statement (True). Default is False.
-
-            filemode: string, optional
-                Sets the mode for the output file. Default is "w".
-
-        @Return:
-            <nothing>
+        '''Opens the file to read the grib messages and then write
+        them to a new output file. By default all messages are
+        written out. Also, the keyvalues of the passed list of
+        keynames are set or only those meeting the where statement.
+        (list of key and list of values).
+
+        Parameters
+        ----------
+        fromfile : :obj:`string`
+            Filename of the input file to read the grib messages from.
+
+        keynames : :obj:`list` of :obj:`string`
+            List of keynames. Default is an empty list.
+
+        keyvalues : :obj:`list` of :obj:`string`
+            List of keynames. Default is an empty list.
+
+        wherekeynames : :obj:`list` of :obj:`string`, optional
+            Default value is an empty list.
+
+        wherekeyvalues : :obj:`list` of :obj:`string`, optional
+            Default value is an empty list.
+
+        strict : :obj:`boolean`, optional
+            Decides if everything from keynames and keyvalues
+            is written out the grib file (False) or only those
+            meeting the where statement (True). Default is False.
+
+        filemode : :obj:`string`, optional
+            Sets the mode for the output file. Default is "w".
+
+        Return
+        ------
 
         '''
@@ -219 +217 @@
     def copy(self, filename_in, selectWhere=True,
              keynames=[], keyvalues=[], filemode='w'):
-        '''
-        Add the content of another input grib file to the objects file but
+        '''Add the content of another input grib file to the objects file but
         only messages corresponding to keys/values passed to the function.
         The selectWhere switch decides if to copy the keys equal to (True) or
         different to (False) the keynames/keyvalues list passed to the function.
 
-        @Input:
-            filename_in: string
-                Filename of the input file to read the grib messages from.
-
-            selectWhere: boolean, optional
-                Decides if to copy the keynames and values equal to (True) or
-                different to (False) the keynames/keyvalues list passed to the
-                function. Default is True.
-
-            keynames: list of strings, optional
-                List of keynames. Default is an empty list.
-
-            keyvalues: list of strings, optional
-                List of keynames. Default is an empty list.
-
-            filemode: string, optional
-                Sets the mode for the output file. Default is "w".
-
-        @Return:
-            <nothing>
+        Parameters
+        ----------
+        filename_in : :obj:`string`
+            Filename of the input file to read the grib messages from.
+
+        selectWhere : :obj:`boolean`, optional
+            Decides if to copy the keynames and values equal to (True) or
+            different to (False) the keynames/keyvalues list passed to the
+            function. Default is True.
+
+        keynames : :obj:`list` of :obj:`string`, optional
+            List of keynames. Default is an empty list.
+
+        keyvalues : :obj:`list` of :obj:`string`, optional
+            List of keynames. Default is an empty list.
+
+        filemode : :obj:`string`, optional
+            Sets the mode for the output file. Default is "w".
+
+        Return
+        ------
+
         '''
 
@@ -284 +283 @@
 
     def index(self, index_keys=["mars"], index_file="my.idx"):
-        '''
-        @Description:
-            Create index file from a list of files if it does not exist or
-            read an index file.
-
-        @Input:
-            index_keys: list of strings, optional
-                Contains the list of key parameter names from
-                which the index is to be created.
-                Default is a list with a single entry string "mars".
-
-            index_file: string, optional
-                Filename where the indices are stored.
-                Default is "my.idx".
-
-        @Return:
-            iid: integer
-                Grib index id.
+        '''Create index file from a list of files if it does not exist or
+        read an index file.
+
+        Parameters
+        ----------
+        index_keys: :obj:`list` of :obj:`string`, optional
+            Contains the list of key parameter names from
+            which the index is to be created.
+            Default is a list with a single entry string "mars".
+
+        index_file: :obj:`string`, optional
+            Filename where the indices are stored.
+            Default is "my.idx".
+
+        Return
+        ------
+        iid: :obj:`integer`
+            Grib index id.
         '''
         print("... index will be done")