Context Navigation

-                      r0934db1
+                      r274f9ef
     # --------------------------------------------------------------------------
     def __init__(self, c, fluxes=False):
+        '''
+        @Description:
+            Creates an object/instance of EcFlexpart with the
+            associated settings of its attributes for the retrieval.
+        @Input:
+            self: instance of EcFlexpart
+                The current object of the class.
+            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.
+            fluxes: boolean, optional
+                Decides if the flux parameter settings are stored or
+                the rest of the parameter list.
+                Default value is False.
+        @Return:
+            <nothing>
+        '''Creates an object/instance of EcFlexpart with the associated
+        settings of its attributes for the retrieval.
+        Parameters:
+        -----------
+        c : :obj:`ControlFile`
+            Contains all the parameters of CONTROL file and
+            command line.
+        fluxes : :obj:`boolean`, optional
+            Decides if the flux parameter settings are stored or
+            the rest of the parameter list.
+            Default value is False.
+        Return
+        ------
         '''
         # set a counter for the number of mars requests generated
 …
     def _mk_targetname(self, ftype, param, date):
         '''
         @Description:
+            Creates the filename for the requested grib data to be stored in.
             This name is passed as the "target" parameter in the request.
         @Input:
             ftype: string
+                Shortcut name of the type of the field. E.g. AN, FC, PF, ...
             param: string
                 Shortcut of the grid type. E.g. SH__ML, SH__SL, GG__ML,
+                GG__SL, OG__ML, OG__SL, OG_OROLSM_SL, OG_acc_SL
             date: string
+                The date period of the grib data to be stored in this file.
         @Return:
             targetname: string
                 The target filename for the grib data.
+        '''Creates the filename for the requested grib data to be stored in.
+        This name is passed as the "target" parameter in the request.
+        Parameters
+        ----------
+        ftype : :obj:`string`
+            Shortcut name of the type of the field. E.g. AN, FC, PF, ...
+        param : :obj:`string`
+            Shortcut of the grid type. E.g. SH__ML, SH__SL, GG__ML,
+            GG__SL, OG__ML, OG__SL, OG_OROLSM_SL, OG_acc_SL
+        date : :obj:`string`
+            The date period of the grib data to be stored in this file.
+        Return
+        ------
+        targetname : :obj:`string`
+            The target filename for the grib data.
         '''
         targetname = (self.inputdir + '/' + ftype + param + '.' + date + '.' +
 …
     def _start_retrievement(self, request, par_dict):
+        '''
+        @Description:
+            Creates the Mars Retrieval and prints or submits the request
+            depending on the status of the request variable.
+        @Input:
+            self: instance of EcFlexpart
+                The current object of the class.
+            request: integer
+                Selects the mode of retrieval.
+: Retrieves the data from ECMWF.
+: Prints the mars requests to an output file.
+: Retrieves the data and prints the mars request.
+            par_dict: dictionary
+                Contains all parameter which have to be set for creating the
+                Mars Retrievals. The parameter are:
+                marsclass, dataset, stream, type, levtype, levelist, resol,
+                gaussian, accuracy, grid, target, area, date, time, number,
+                step, expver, param
+        @Return:
+            <nothing>
+        '''Creates the Mars Retrieval and prints or submits the request
+        depending on the status of the request variable.
+        Parameters
+        ----------
+        request : :obj:`integer`
+            Selects the mode of retrieval.
+: Retrieves the data from ECMWF.
+: Prints the mars requests to an output file.
+: Retrieves the data and prints the mars request.
+        par_dict : :obj:`dictionary`
+            Contains all parameter which have to be set for creating the
+            Mars Retrievals. The parameter are:
+            marsclass, dataset, stream, type, levtype, levelist, resol,
+            gaussian, accuracy, grid, target, area, date, time, number,
+            step, expver, param
+        Return
+        ------
         '''
         # increase number of mars requests
 …
     def _mk_index_values(self, inputdir, inputfiles, keys):
         '''
         @Description:
+            Creates an index file for a set of grib parameter keys.
             The values from the index keys are returned in a list.
         @Input:
             keys: dictionary
+                List of parameter names which serves as index.
             inputfiles: instance of UioFiles
+                Contains a list of files.
         @Return:
             iid: grib_index
                 This is a grib specific index structure to access
                 messages in a file.
             index_vals: list
                 Contains the values from the keys used for a distinct selection
                 of grib messages in processing  the grib files.
                 Content looks like e.g.:
                 index_vals[0]: ('20171106', '20171107', '20171108') ; date
                 index_vals[1]: ('0', '1200', '1800', '600') ; time
                 index_vals[2]: ('0', '12', '3', '6', '9') ; stepRange
+        '''Creates an index file for a set of grib parameter keys.
+        The values from the index keys are returned in a list.
+        Parameters
+        ----------
+        keys : :obj:`dictionary`
+            List of parameter names which serves as index.
+        inputfiles : :obj:`UioFiles`
+            Contains a list of files.
+        Return
+        ------
+        iid : :obj:`grib_index`
+            This is a grib specific index structure to access
+            messages in a file.
+        index_vals : :obj:`list`
+            Contains the values from the keys used for a distinct selection
+            of grib messages in processing  the grib files.
+            Content looks like e.g.:
+            index_vals[0]: ('20171106', '20171107', '20171108') ; date
+            index_vals[1]: ('0', '1200', '1800', '600') ; time
+            index_vals[2]: ('0', '12', '3', '6', '9') ; stepRange
         '''
         iid = None
 …
     def retrieve(self, server, dates, public, request, inputdir='.'):
+        '''
+        @Description:
+            Finalizing the retrieval information by setting final details
+            depending on grid type.
+            Prepares MARS retrievals per grid type and submits them.
+        @Input:
+            self: instance of EcFlexpart
+                The current object of the class.
+            server: instance of ECMWFService or ECMWFDataServer
+                The connection to the ECMWF server. This is different
+                for member state users which have full access and non
+                member state users which have only access to the public
+                data sets. The decision is made from command line argument
+                "public"; for public access its True (ECMWFDataServer)
+                for member state users its False (ECMWFService)
+            dates: string
+                Contains start and end date of the retrieval in the format
+                "YYYYMMDD/to/YYYYMMDD"
+            request: integer
+                Selects the mode of retrieval.
+: Retrieves the data from ECMWF.
+: Prints the mars requests to an output file.
+: Retrieves the data and prints the mars request.
+            inputdir: string, optional
+                Path to the directory where the retrieved data is about
+                to be stored. The default is the current directory ('.').
+        @Return:
+            <nothing>
+        '''Finalizing the retrieval information by setting final details
+        depending on grid type.
+        Prepares MARS retrievals per grid type and submits them.
+        Parameters
+        ----------
+        server : :obj:`ECMWFService` or :obj:`ECMWFDataServer`
+            The connection to the ECMWF server. This is different
+            for member state users which have full access and non
+            member state users which have only access to the public
+            data sets. The decision is made from command line argument
+            "public"; for public access its True (ECMWFDataServer)
+            for member state users its False (ECMWFService)
+        dates : :obj:`string`
+            Contains start and end date of the retrieval in the format
+            "YYYYMMDD/to/YYYYMMDD"
+        request : :obj:`integer`
+            Selects the mode of retrieval.
+: Retrieves the data from ECMWF.
+: Prints the mars requests to an output file.
+: Retrieves the data and prints the mars request.
+        inputdir : :obj:`string`, optional
+            Path to the directory where the retrieved data is about
+            to be stored. The default is the current directory ('.').
+        Return
+        ------
         '''
         self.dates = dates
 …
     def write_namelist(self, c):
+        '''
+        @Description:
+            Creates a namelist file in the temporary directory and writes
+            the following values to it: maxl, maxb, mlevel,
+            mlevelist, mnauf, metapar, rlo0, rlo1, rla0, rla1,
+            momega, momegadiff, mgauss, msmooth, meta, metadiff, mdpdeta
+        @Input:
+            self: instance of EcFlexpart
+                The current object of the class.
+            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.
+            filename: string
+        '''Creates a namelist file in the temporary directory and writes
+        the following values to it: maxl, maxb, mlevel,
+        mlevelist, mnauf, metapar, rlo0, rlo1, rla0, rla1,
+        momega, momegadiff, mgauss, msmooth, meta, metadiff, mdpdeta
+        Parameters
+        ----------
+        c : :obj:`ControlFile`
+            Contains all the parameters of CONTROL file and
+            command line.
+        filename : :obj:`string`
                 Name of the namelist file.
+        @Return:
+            <nothing>
+        Return
+        ------
         '''
 …
     def deacc_fluxes(self, inputfiles, c):
+        '''
+        @Description:
+            Goes through all flux fields in ordered time and de-accumulate
+            the fields. Afterwards the fields are disaggregated in time.
+            Different versions of disaggregation is provided for rainfall
+            data (darain, modified linear) and the surface fluxes and
+            stress data (dapoly, cubic polynomial).
+        @Input:
+            self: instance of EcFlexpart
+                The current object of the class.
+            inputfiles: instance of UioFiles
+                Contains a list of files.
+            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>
+        '''Goes through all flux fields in ordered time and de-accumulate
+        the fields. Afterwards the fields are disaggregated in time.
+        Different versions of disaggregation is provided for rainfall
+        data (darain, modified linear) and the surface fluxes and
+        stress data (dapoly, cubic polynomial).
+        Parameters
+        ----------
+        inputfiles : :obj:`UioFiles`
+            Contains a list of files.
+        c : :obj:`ControlFile`
+            Contains all the parameters of CONTROL file and
+            command line.
+        Return
+        ------
         '''
 …
     def create(self, inputfiles, c):
+        '''
+        @Description:
+            This method is based on the ECMWF example index.py
+            https://software.ecmwf.int/wiki/display/GRIB/index.py
+            An index file will be created which depends on the combination
+            of "date", "time" and "stepRange" values. This is used to iterate
+            over all messages in each grib file which were passed through the
+            parameter "inputfiles" to seperate specific parameters into fort.*
+            files. Afterwards the FORTRAN program is called to convert
+            the data fields all to the same grid and put them in one file
+            per unique time step (combination of "date", "time" and
+            "stepRange").
+        @Input:
+            self: instance of EcFlexpart
+                The current object of the class.
+            inputfiles: instance of UioFiles
+                Contains a list of files.
+            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>
+        '''An index file will be created which depends on the combination
+        of "date", "time" and "stepRange" values. This is used to iterate
+        over all messages in each grib file which were passed through the
+        parameter "inputfiles" to seperate specific parameters into fort.*
+        files. Afterwards the FORTRAN program is called to convert
+        the data fields all to the same grid and put them in one file
+        per unique time step (combination of "date", "time" and
+        "stepRange").
+        Note
+        ----
+        This method is based on the ECMWF example index.py
+        https://software.ecmwf.int/wiki/display/GRIB/index.py
+        Parameters
+        ----------
+        inputfiles : :obj:`UioFiles`
+            Contains a list of files.
+        c : :obj:`ControlFile`
+            Contains all the parameters of CONTROL file and
+            command line.
+        Return
+        ------
         '''
 …
     def process_output(self, c):
+        '''
+        @Description:
+            The grib files are postprocessed depending on the selection in
+            CONTROL file. The resulting files are moved to the output
+            directory if its not equal to the input directory.
+            The following modifications might be done if
+            properly switched in CONTROL file:
+            GRIB2 - Conversion to GRIB2
+            ECTRANS - Transfer of files to gateway server
+            ECSTORAGE - Storage at ECMWF server
+        @Input:
+            self: instance of EcFlexpart
+                The current object of the class.
+            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>
+        '''The grib files are postprocessed depending on the selection in
+        CONTROL file. The resulting files are moved to the output
+        directory if its not equal to the input directory.
+        The following modifications might be done if
+        properly switched in CONTROL file:
+        GRIB2 - Conversion to GRIB2
+        ECTRANS - Transfer of files to gateway server
+        ECSTORAGE - Storage at ECMWF server
+        Parameters
+        ----------
+        c : :obj:`ControlFile`
+            Contains all the parameters of CONTROL file and
+            command line.
+        Return
+        ------
         '''
 …
     def prepare_fp_files(self, c):
+        '''
+        @Description:
+            Conversion of GRIB files to FLEXPART binary format.
+        @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>
+        '''Conversion of GRIB files to FLEXPART binary format.
+        Parameters
+        ----------
+        c : :obj:`ControlFile`
+            Contains all the parameters of CONTROL file and
+            command line.
+        Return
+        ------
         '''
         # generate AVAILABLE file

Note: See TracChangeset for help on using the changeset viewer.

Context Navigation

Changeset 274f9ef in flex_extract.git for source/python/classes/EcFlexpart.py

Legend:

source/python/classes/EcFlexpart.py

Download in other formats: