vortex-nwp 2.0.0b1__py3-none-any.whl → 2.1.0__py3-none-any.whl

vortex/nwp/algo/monitoring.py

@@ -14,51 +14,63 @@ __all__ = []
 logger = loggers.getLogger(__name__)
 
 
-class OdbMonitoring(Parallel, odb.OdbComponentDecoMixin, drhook.DrHookDecoMixin):
+class OdbMonitoring(
+    Parallel, odb.OdbComponentDecoMixin, drhook.DrHookDecoMixin
+):
     """Compute monitoring statistics."""
 
     _footprint = dict(
-        attr = dict(
-            kind = dict(
-                values = ['monitoring'],
+        attr=dict(
+            kind=dict(
+                values=["monitoring"],
             ),
-            npool = dict(
-                default = 1,
-                optional = True,
+            npool=dict(
+                default=1,
+                optional=True,
             ),
-            obs = dict(
-                values = ['all', 'used'],
+            obs=dict(
+                values=["all", "used"],
             ),
-            date = a_date,
-            model= a_model,
-            cutoff = a_cutoff,
-            start = dict(
-                type  = bool,
-                default = False,
-                optional = True,
+            date=a_date,
+            model=a_model,
+            cutoff=a_cutoff,
+            start=dict(
+                type=bool,
+                default=False,
+                optional=True,
             ),
-            cumul = dict(
-                type = bool,
-                default = True,
-                optional = True,
+            cumul=dict(
+                type=bool,
+                default=True,
+                optional=True,
             ),
-            extend = dict(
-                type = bool,
-                default = False,
-                optional = True,
+            extend=dict(
+                type=bool,
+                default=False,
+                optional=True,
             ),
-            stage = dict(
-                values = ['can', 'surf', 'surface', 'atm', 'atmospheric'],
-                remap = dict(can='surf', surface='surf', atmospheric='atm'),
-                info = 'The processing stage of the ODB base.',
+            stage=dict(
+                values=["can", "surf", "surface", "atm", "atmospheric"],
+                remap=dict(can="surf", surface="surf", atmospheric="atm"),
+                info="The processing stage of the ODB base.",
             ),
         )
     )
 
+    def _mpitool_attributes(self, opts):
+        conf_dict = super()._mpitool_attributes(opts)
+        conf_dict.update({"mplbased": True})
+        return conf_dict
+
     def _fix_nam_macro(self, rh, macro, value):
         """Set a given namelist macro and issue a log message."""
         rh.contents.setmacro(macro, value)
-        logger.info('Setup %s macro to %s in %s', macro, value, rh.container.actualpath())
+        logger.info(
+            "Setup %s macro to %s in %s",
+            macro,
+            value,
+            rh.container.actualpath(),
+        )
 
     def prepare(self, rh, opts):
         """Update some variables in the namelist and check the presence of the accumulated statistics file."""
@@ -69,31 +81,42 @@ class OdbMonitoring(Parallel, odb.OdbComponentDecoMixin, drhook.DrHookDecoMixin)
 
         # Virtual upper-air observations database
         obsatm_virt = [
-            x for x in self.lookupodb(fatal=False)
-            if (x.rh.resource.stage.startswith('matchup') or
-                x.rh.resource.stage.startswith('screening')) and x.rh.resource.part == 'virtual'
+            x
+            for x in self.lookupodb(fatal=False)
+            if (
+                x.rh.resource.stage.startswith("matchup")
+                or x.rh.resource.stage.startswith("screening")
+            )
+            and x.rh.resource.part == "virtual"
         ]
 
         # Single upper-air observations database
         obsatm_single = [
-            x for x in self.lookupodb(fatal=False)
-            if x.rh.resource.stage.startswith('matchup') or x.rh.resource.stage.startswith('screening')
+            x
+            for x in self.lookupodb(fatal=False)
+            if x.rh.resource.stage.startswith("matchup")
+            or x.rh.resource.stage.startswith("screening")
         ]
         if len(obsatm_single) > 1:
             obsatm_single = []
 
         # Surface observations database
         obssurf = [
-            x for x in self.lookupodb(fatal=False)
-            if x.rh.resource.stage.startswith('canari') and (x.rh.resource.part == 'surf' or
-                                                             x.rh.resource.part == 'ground')
+            x
+            for x in self.lookupodb(fatal=False)
+            if x.rh.resource.stage.startswith("canari")
+            and (
+                x.rh.resource.part == "surf" or x.rh.resource.part == "ground"
+            )
         ]
 
         # One database at a time
-        if not (obsatm_virt or obsatm_single) and self.stage == 'atm':
-            raise ValueError('Could not find any ODB matchup or screening ECMA database')
-        if not obssurf and self.stage == 'surf':
-            raise ValueError('Could not find any ODB surface ECMA database')
+        if not (obsatm_virt or obsatm_single) and self.stage == "atm":
+            raise ValueError(
+                "Could not find any ODB matchup or screening ECMA database"
+            )
+        if not obssurf and self.stage == "surf":
+            raise ValueError("Could not find any ODB surface ECMA database")
 
         # Set actual ODB paths
         if obsatm_virt:
@@ -104,8 +127,12 @@ class OdbMonitoring(Parallel, odb.OdbComponentDecoMixin, drhook.DrHookDecoMixin)
             ecma = obssurf.pop(0)
         ecma_path = sh.path.abspath(ecma.rh.container.localpath())
         self.odb.fix_db_path(ecma.rh.resource.layout, ecma_path)
-        self.env.IOASSIGN = sh.path.join(ecma_path, 'IOASSIGN')
-        logger.info('Setting ODB env %s = %s.', 'IOASSIGN', sh.path.join(ecma_path, 'IOASSIGN'))
+        self.env.IOASSIGN = sh.path.join(ecma_path, "IOASSIGN")
+        logger.info(
+            "Setting ODB env %s = %s.",
+            "IOASSIGN",
+            sh.path.join(ecma_path, "IOASSIGN"),
+        )
 
         # Let ancestors handling most of the env setting
         super().prepare(rh, opts)
@@ -113,69 +140,103 @@ class OdbMonitoring(Parallel, odb.OdbComponentDecoMixin, drhook.DrHookDecoMixin)
         # Force to start a new accumulated statistics file if first day and first hour of the month
         mnt_start = self.start
 
-        if not mnt_start and int(self.date.day) == 1 and int(self.date.hh) == 0 and not self.extend:
-            logger.info('First day and first hour of the month : force start attribute to True.')
+        if (
+            not mnt_start
+            and int(self.date.day) == 1
+            and int(self.date.hh) == 0
+            and not self.extend
+        ):
+            logger.info(
+                "First day and first hour of the month : force start attribute to True."
+            )
             mnt_start = True
 
         mnt_cumul = self.cumul
-        if self.cutoff == 'production':
+        if self.cutoff == "production":
             mnt_cumul = False
-            logger.info('No output accumulated statistics file will be produced because '
-                        'cutoff = production : force cumul to False')
+            logger.info(
+                "No output accumulated statistics file will be produced because "
+                "cutoff = production : force cumul to False"
+            )
 
         # Monitoring namelist
         namrh = self.context.sequence.effective_inputs(
-            role='Namelist',
-            kind='namelist',)
+            role="Namelist",
+            kind="namelist",
+        )
         if len(namrh) != 1:
-            logger.critical('There must be exactly one namelist for monitoring. Stop.')
-            raise ValueError('There must be exactly one namelist for monitoring. Stop.')
+            logger.critical(
+                "There must be exactly one namelist for monitoring. Stop."
+            )
+            raise ValueError(
+                "There must be exactly one namelist for monitoring. Stop."
+            )
         namrh = namrh[0].rh
 
         # Cumulated statistics file
         cumulrh = self.context.sequence.effective_inputs(
-            role='Cumulated monitoring statistics',
-            kind='accumulated_stats',
+            role="Cumulated monitoring statistics",
+            kind="accumulated_stats",
         )
 
         if len(cumulrh) > 1:
-            logger.critical('There must be at most one accumulated statistics file.Stop.')
-            raise ValueError('There must be one accumulated statistics file or none.Stop.')
+            logger.critical(
+                "There must be at most one accumulated statistics file.Stop."
+            )
+            raise ValueError(
+                "There must be one accumulated statistics file or none.Stop."
+            )
         else:
             if len(cumulrh) == 0:
                 if not mnt_start:
                     if mnt_cumul:
-                        logger.critical('There must be one input accumulated statistics file. Stop.')
-                        raise ValueError('There must be one input accumulated statistics file. Stop.')
+                        logger.critical(
+                            "There must be one input accumulated statistics file. Stop."
+                        )
+                        raise ValueError(
+                            "There must be one input accumulated statistics file. Stop."
+                        )
                     else:
-                        logger.info('No input accumulated statistics file is necessary.')
-                        logger.info('No output accumulated statistics file will be produced.')
+                        logger.info(
+                            "No input accumulated statistics file is necessary."
+                        )
+                        logger.info(
+                            "No output accumulated statistics file will be produced."
+                        )
                 else:
                     if mnt_cumul:
-                        logger.info('No input accumulated statistics file. It will be created by the binary.')
+                        logger.info(
+                            "No input accumulated statistics file. It will be created by the binary."
+                        )
                     else:
-                        logger.info('No output accumulated statistics file will be produced.')
+                        logger.info(
+                            "No output accumulated statistics file will be produced."
+                        )
             else:
                 cumulrh = cumulrh[0].rh
                 if not mnt_cumul:
-                    logger.info('No input accumulated statistics file is necessary(start=False).')
+                    logger.info(
+                        "No input accumulated statistics file is necessary(start=False)."
+                    )
                     cumulrh.container.clear()
                 else:
                     if mnt_start:
-                        logger.info('No input accumulated statistics file is necessary (start=True)')
+                        logger.info(
+                            "No input accumulated statistics file is necessary (start=True)"
+                        )
                         cumulrh.container.clear()
 
-        self._fix_nam_macro(namrh, 'JOUR', int(self.date.ymd))
-        self._fix_nam_macro(namrh, 'RES', int(self.date.hh))
+        self._fix_nam_macro(namrh, "JOUR", int(self.date.ymd))
+        self._fix_nam_macro(namrh, "RES", int(self.date.hh))
 
-        self._fix_nam_macro(namrh, 'LLADMON', mnt_cumul)
-        self._fix_nam_macro(namrh, 'LLADAJ', mnt_cumul and not mnt_start)
+        self._fix_nam_macro(namrh, "LLADMON", mnt_cumul)
+        self._fix_nam_macro(namrh, "LLADAJ", mnt_cumul and not mnt_start)
 
-        self._fix_nam_macro(namrh, 'LLFLAG', self.obs != 'all')
+        self._fix_nam_macro(namrh, "LLFLAG", self.obs != "all")
 
-        self._fix_nam_macro(namrh, 'LLARO', self.model == 'arome')
-        self._fix_nam_macro(namrh, 'LLVRP', self.model == 'varpack')
-        self._fix_nam_macro(namrh, 'LLCAN', self.stage == 'surf')
+        self._fix_nam_macro(namrh, "LLARO", self.model == "arome")
+        self._fix_nam_macro(namrh, "LLVRP", self.model == "varpack")
+        self._fix_nam_macro(namrh, "LLCAN", self.stage == "surf")
 
         if namrh.contents.dumps_needs_update:
             namrh.contents.rewrite(namrh.container)
@@ -189,13 +250,13 @@ class OdbMonitoring(Parallel, odb.OdbComponentDecoMixin, drhook.DrHookDecoMixin)
         allfiles = sh.ls()
         for f in allfiles:
             if self.system.path.getsize(f) == 0:
-                logger.info('Remove %s because size of %s is zero.', f, f)
+                logger.info("Remove %s because size of %s is zero.", f, f)
                 sh.remove(f)
 
-        obspoint_out = sh.ls('point.*')
+        obspoint_out = sh.ls("point.*")
         if obspoint_out:
-            dest = 'obslocationpack'
-            logger.info('Creating an OBSLOCATION pack: %s', dest)
+            dest = "obslocationpack"
+            logger.info("Creating an OBSLOCATION pack: %s", dest)
             sh.mkdir(dest)
             for fname in obspoint_out:
                 sh.mv(fname, dest)