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

vortex/nwp/data/stores.py

@@ -25,31 +25,29 @@ class BdpeStore(Store):
     _footprint = [
         compressionpipeline,
         dict(
-            info = 'Access the BDPE database',
-            attr = dict(
-                scheme = dict(
-                    values   = ['bdpe'],
+            info="Access the BDPE database",
+            attr=dict(
+                scheme=dict(
+                    values=["bdpe"],
                 ),
-                netloc = dict(
-                    values   = ['bdpe.archive.fr'],
+                netloc=dict(
+                    values=["bdpe.archive.fr"],
                 ),
             ),
-            priority = dict(
-                level = footprints.priorities.top.DEFAULT
-            ),
+            priority=dict(level=footprints.priorities.top.DEFAULT),
         ),
     ]
 
     @property
     def realkind(self):
-        return 'bdpe'
+        return "bdpe"
 
     def bdpelocate(self, remote, options):
         """Reasonably close to whatever 'remote location' could mean.
 
         e.g.: ``bdpe://bdpe.archive.fr/EXPE/date/BDPE_num+term``
         """
-        return self.scheme + '://' + self.netloc + remote['path']
+        return self.scheme + "://" + self.netloc + remote["path"]
 
     def bdpecheck(self, remote, options):
         """Cannot check a BDPE call a priori."""
@@ -71,21 +69,27 @@ class BdpeStore(Store):
 
         # Check that local is a file (i.e not a virtual container)
         if not isinstance(local, str):
-            raise TypeError('The BDPE provider can not deal with virtual containers')
+            raise TypeError(
+                "The BDPE provider can not deal with virtual containers"
+            )
 
         # remote['path'] looks like '/OPER_SEC_DEV_True_10_3/20151105T0000P/BDPE_42+06:00'
-        _, targetmix, str_date, more = remote['path'].split('/')
-        p_target, f_target, domain, s_archive, timeout, retries = targetmix.split('_')
-        productid, str_term = more[5:].split('+')
+        _, targetmix, str_date, more = remote["path"].split("/")
+        p_target, f_target, domain, s_archive, timeout, retries = (
+            targetmix.split("_")
+        )
+        productid, str_term = more[5:].split("+")
 
         # the 'oper' domain is allowed only to the operational suite
-        if domain == 'oper':
-            if not vortex.ticket().glove.profile == 'oper':
-                logger.warning("Only profile 'oper' can use 'soprano_domain=oper'. Using 'dev' instead.")
-                domain = 'dev'
-
-        if str_date == 'most_recent':
-            bdpe_date = '/'
+        if domain == "oper":
+            if not vortex.ticket().glove.profile == "oper":
+                logger.warning(
+                    "Only profile 'oper' can use 'soprano_domain=oper'. Using 'dev' instead."
+                )
+                domain = "dev"
+
+        if str_date == "most_recent":
+            bdpe_date = "/"
         else:
             bdpe_date = date.Date(str_date).ymdhms
         bdpe_term = date.Time(str_term).fmtraw
@@ -93,7 +97,7 @@ class BdpeStore(Store):
             productid,  # id
             bdpe_date,  # date: yyyymmddhhmmss
             bdpe_term,  # term: HHHHmm
-            local,      # local filename
+            local,  # local filename
         ]
         extraenv = dict(
             BDPE_CIBLE_PREFEREE=p_target,
@@ -102,31 +106,37 @@ class BdpeStore(Store):
             BDPE_TIMEOUT=timeout,
             BDPE_RETRYS=retries,
         )
-        if s_archive == 'True':
-            extraenv['BDPE_LECTURE_ARCHIVE_AUTORISEE'] = 'oui'
+        if s_archive == "True":
+            extraenv["BDPE_LECTURE_ARCHIVE_AUTORISEE"] = "oui"
 
-        wsinterpreter = self.system.default_target.get('bdpe:wsclient_interpreter', None)
-        wscommand = self.system.default_target.get('bdpe:wsclient_path', None)
+        wsinterpreter = self.system.default_target.get(
+            "bdpe:wsclient_interpreter", None
+        )
+        wscommand = self.system.default_target.get("bdpe:wsclient_path", None)
         if wscommand is None:
-            raise RuntimeError('bdpe:wsclient_path has to be set in the target config')
+            raise RuntimeError(
+                "bdpe:wsclient_path has to be set in the target config"
+            )
 
         args.insert(0, wscommand)
         if wsinterpreter is not None:
             args.insert(0, wsinterpreter)
 
-        logger.debug('lirepe_cmd: %s', " ".join(args))
+        logger.debug("lirepe_cmd: %s", " ".join(args))
 
         with self.system.env.delta_context(**extraenv):
             rc = self.system.spawn(args, output=False, fatal=False)
         rc = rc and self.system.path.exists(local)
 
-        diagfile = local + '.diag'
+        diagfile = local + ".diag"
         if not rc:
-            logger.warning('Something went wrong with the following command: %s',
-                           " ".join(args))
-        if not rc or bdpe_date == '/':
+            logger.warning(
+                "Something went wrong with the following command: %s",
+                " ".join(args),
+            )
+        if not rc or bdpe_date == "/":
             if self.system.path.exists(diagfile):
-                logger.warning('The %s file is:', diagfile)
+                logger.warning("The %s file is:", diagfile)
                 self.system.cat(diagfile)
         if rc and self._actual_cpipeline:
             # Deal with compressed files in the BDPE using the optional attribute
@@ -136,10 +146,13 @@ class BdpeStore(Store):
             self._actual_cpipeline.file2uncompress(tempfile, local)
             rc = rc and self.system.path.exists(local)
             if not rc:
-                logger.warning('Something went wrong while uncompressing the file %s.', tempfile)
+                logger.warning(
+                    "Something went wrong while uncompressing the file %s.",
+                    tempfile,
+                )
 
         # Final step : deal with format specific packing
-        rc = rc and self.system.forceunpack(local, fmt=options.get('fmt'))
+        rc = rc and self.system.forceunpack(local, fmt=options.get("fmt"))
 
         if self.system.path.exists(diagfile):
             self.system.remove(diagfile)

vortex/nwp/data/surfex.py

@@ -10,7 +10,7 @@ from ..syntax.stdattrs import gvar
 __all__ = []
 
 
-@namebuilding_delete('src')
+@namebuilding_delete("src")
 class PGDRaw(ModelGeoResource):
     """
     SURFEX climatological resource.
@@ -18,34 +18,39 @@ class PGDRaw(ModelGeoResource):
 
     :note: OBSOLETE classes do not use.
     """
+
     _abstract = True
     _footprint = [
         gvar,
         dict(
-            info = 'Surfex climatological file',
-            attr = dict(
-                gvar = dict(
-                    default  = 'pgd_[nativefmt]',
+            info="Surfex climatological file",
+            attr=dict(
+                gvar=dict(
+                    default="pgd_[nativefmt]",
                 ),
-            )
-        )
+            ),
+        ),
     ]
-    _extension_remap = dict(netcdf='nc')
+    _extension_remap = dict(netcdf="nc")
 
     @property
     def realkind(self):
-        return 'pgd'
+        return "pgd"
 
     def olive_basename(self):
         """OLIVE specific naming convention."""
-        return 'PGDFILE-' + self.geometry.area + '.' + self.nativefmt
+        return "PGDFILE-" + self.geometry.area + "." + self.nativefmt
 
     def namebuilding_info(self):
         nbi = super().namebuilding_info()
         nbi.update(
             # will work only with the @cen namebuilder:
-            cen_rawbasename=('PGD_' + self.geometry.area + '.' +
-                             self._extension_remap.get(self.nativefmt, self.nativefmt))
+            cen_rawbasename=(
+                "PGD_"
+                + self.geometry.area
+                + "."
+                + self._extension_remap.get(self.nativefmt, self.nativefmt)
+            )
             # With the standard provider, the usual keys will be used...
         )
         return nbi
@@ -58,16 +63,17 @@ class PGDLFI(PGDRaw):
 
     :note: OBSOLETE classes do not use.
     """
+
     _footprint = dict(
-        info = 'Grid-point data consts',
-        attr = dict(
-            kind = dict(
-                values  = ['pgdlfi'],
+        info="Grid-point data consts",
+        attr=dict(
+            kind=dict(
+                values=["pgdlfi"],
             ),
-            nativefmt = dict(
-                default = 'lfi',
-            )
-        )
+            nativefmt=dict(
+                default="lfi",
+            ),
+        ),
     )
 
 
@@ -78,16 +84,17 @@ class PGDFA(PGDRaw):
 
     :note: OBSOLETE classes do not use.
     """
+
     _footprint = dict(
-        info = 'Grid-point data consts',
-        attr = dict(
-            kind = dict(
-                values  = ['pgdfa'],
+        info="Grid-point data consts",
+        attr=dict(
+            kind=dict(
+                values=["pgdfa"],
             ),
-            nativefmt = dict(
-                default = 'fa',
-            )
-        )
+            nativefmt=dict(
+                default="fa",
+            ),
+        ),
     )
 
 
@@ -98,52 +105,56 @@ class PGDNC(PGDRaw):
 
     :note: OBSOLETE classes do not use.
     """
+
     _footprint = dict(
-        info = 'Grid-point data consts',
-        attr = dict(
-            kind = dict(
-                values  = ['pgdnc'],
+        info="Grid-point data consts",
+        attr=dict(
+            kind=dict(
+                values=["pgdnc"],
             ),
-            nativefmt = dict(
-                default = 'netcdf',
-            )
-        )
+            nativefmt=dict(
+                default="netcdf",
+            ),
+        ),
     )
 
 
-@namebuilding_delete('src')
+@namebuilding_delete("src")
 class PGDWithGeo(ModelGeoResource):
     """
     SURFEX climatological resource.
     A Genvkey can be provided.
     """
+
     _footprint = [
         gvar,
         dict(
-            info = 'Surfex climatological file',
-            attr = dict(
-                kind = dict(
-                    values  = ['pgd', ],
+            info="Surfex climatological file",
+            attr=dict(
+                kind=dict(
+                    values=[
+                        "pgd",
+                    ],
                 ),
-                nativefmt = dict(
-                    values  = ['fa', 'lfi', 'netcdf', 'txt'],
-                    default = 'fa',
+                nativefmt=dict(
+                    values=["fa", "lfi", "netcdf", "txt"],
+                    default="fa",
                 ),
-                gvar = dict(
-                    default = 'pgd_[geometry::gco_grid_def]_[nativefmt]',
+                gvar=dict(
+                    default="pgd_[geometry::gco_grid_def]_[nativefmt]",
                 ),
-            )
-        )
+            ),
+        ),
     ]
-    _extension_remap = dict(netcdf='nc')
+    _extension_remap = dict(netcdf="nc")
 
     @property
     def realkind(self):
-        return 'pgd'
+        return "pgd"
 
     def olive_basename(self):
         """OLIVE specific naming convention."""
-        return 'PGDFILE-' + self.geometry.area + '.' + self.nativefmt
+        return "PGDFILE-" + self.geometry.area + "." + self.nativefmt
 
 
 class CoverParams(ModelGeoResource):
@@ -151,30 +162,29 @@ class CoverParams(ModelGeoResource):
     Class of a tar-zip set of coefficients for radiative transfers computations.
     A Genvkey can be given.
     """
+
     _footprint = [
         gvar,
         dict(
-            info = 'Coefficients of RRTM scheme',
-            attr = dict(
-                kind = dict(
-                    values   = ['coverparams', 'surfexcover'],
-                    remap    = dict(surfexcover = 'coverparams'),
+            info="Coefficients of RRTM scheme",
+            attr=dict(
+                kind=dict(
+                    values=["coverparams", "surfexcover"],
+                    remap=dict(surfexcover="coverparams"),
                 ),
-                source = dict(
-                    optional = True,
-                    default  = 'ecoclimap',
-                    values   = ['ecoclimap', 'ecoclimap1', 'ecoclimap2'],
+                source=dict(
+                    optional=True,
+                    default="ecoclimap",
+                    values=["ecoclimap", "ecoclimap1", "ecoclimap2"],
                 ),
-                gvar = dict(
-                    default  = '[source]_covers_param'
-                ),
-            )
-        )
+                gvar=dict(default="[source]_covers_param"),
+            ),
+        ),
     ]
 
     @property
     def realkind(self):
-        return 'coverparams'
+        return "coverparams"
 
 
 class IsbaParams(ModelGeoResource):
@@ -182,25 +192,24 @@ class IsbaParams(ModelGeoResource):
     Class of surface (vegetations, etc.) coefficients.
     A Genvkey can be given.
     """
+
     _footprint = [
         gvar,
         dict(
-            info = 'ISBA parameters',
-            attr = dict(
-                kind = dict(
-                    values   = ['isba', 'isbaan'],
-                    remap    = dict(isbaan = 'isba'),
-                ),
-                gvar = dict(
-                    default  = 'analyse_isba'
+            info="ISBA parameters",
+            attr=dict(
+                kind=dict(
+                    values=["isba", "isbaan"],
+                    remap=dict(isbaan="isba"),
                 ),
-            )
-        )
+                gvar=dict(default="analyse_isba"),
+            ),
+        ),
     ]
 
     @property
     def realkind(self):
-        return 'isba'
+        return "isba"
 
 
 class SandDB(ModelGeoResource):
@@ -208,26 +217,24 @@ class SandDB(ModelGeoResource):
     Class of a tar-zip (.dir/.hdr) file containing surface sand database.
     A Genvkey can be given.
     """
+
     _footprint = [
         gvar,
         dict(
-            info = 'Database for quantity of sand in soil',
-            attr = dict(
-                kind = dict(
-                    values   = ['sand'],
-                ),
-                source = dict(
+            info="Database for quantity of sand in soil",
+            attr=dict(
+                kind=dict(
+                    values=["sand"],
                 ),
-                gvar = dict(
-                    default  = '[source]_[kind]'
-                ),
-            )
-        )
+                source=dict(),
+                gvar=dict(default="[source]_[kind]"),
+            ),
+        ),
     ]
 
     @property
     def realkind(self):
-        return 'sand'
+        return "sand"
 
 
 class ClayDB(ModelGeoResource):
@@ -235,26 +242,24 @@ class ClayDB(ModelGeoResource):
     Class of a tar-zip (.dir/.hdr) file containing surface clay database.
     A Genvkey can be given.
     """
+
     _footprint = [
         gvar,
         dict(
-            info = 'Database for quantity of clay in soil',
-            attr = dict(
-                kind = dict(
-                    values   = ['clay'],
-                ),
-                source = dict(
+            info="Database for quantity of clay in soil",
+            attr=dict(
+                kind=dict(
+                    values=["clay"],
                 ),
-                gvar = dict(
-                    default  = '[source]_[kind]'
-                ),
-            )
-        )
+                source=dict(),
+                gvar=dict(default="[source]_[kind]"),
+            ),
+        ),
     ]
 
     @property
     def realkind(self):
-        return 'clay'
+        return "clay"
 
 
 class OrographyDB(ModelGeoResource):
@@ -262,26 +267,24 @@ class OrographyDB(ModelGeoResource):
     Class of a tar-zip (.dir/.hdr) file containing orography database.
     A Genvkey can be given.
     """
+
     _footprint = [
         gvar,
         dict(
-            info = 'Database for orography',
-            attr = dict(
-                kind = dict(
-                    values   = ['orography'],
-                ),
-                source = dict(
-                ),
-                gvar = dict(
-                    default  = '[source]_[kind]_[geometry::rnice_u]'
+            info="Database for orography",
+            attr=dict(
+                kind=dict(
+                    values=["orography"],
                 ),
-            )
-        )
+                source=dict(),
+                gvar=dict(default="[source]_[kind]_[geometry::rnice_u]"),
+            ),
+        ),
     ]
 
     @property
     def realkind(self):
-        return 'orography'
+        return "orography"
 
 
 class SurfaceTypeDB(ModelGeoResource):
@@ -289,26 +292,24 @@ class SurfaceTypeDB(ModelGeoResource):
     Class of a tar-zip (.dir/.hdr) file containing surface type database.
     A Genvkey can be given.
     """
+
     _footprint = [
         gvar,
         dict(
-            info = 'Database for surface type',
-            attr = dict(
-                kind = dict(
-                    values   = ['surface_type'],
+            info="Database for surface type",
+            attr=dict(
+                kind=dict(
+                    values=["surface_type"],
                 ),
-                source = dict(
-                ),
-                gvar = dict(
-                    default  = '[source]_[kind]'
-                ),
-            )
-        )
+                source=dict(),
+                gvar=dict(default="[source]_[kind]"),
+            ),
+        ),
     ]
 
     @property
     def realkind(self):
-        return 'surface_type'
+        return "surface_type"
 
 
 class BathymetryDB(ModelGeoResource):
@@ -316,23 +317,21 @@ class BathymetryDB(ModelGeoResource):
     Class of file containing bathymetry database.
     A Genvkey can be given.
     """
+
     _footprint = [
         gvar,
         dict(
-            info = 'Database for bathymetry',
-            attr = dict(
-                kind = dict(
-                    values   = ['bathymetry'],
-                ),
-                source = dict(
-                ),
-                gvar = dict(
-                    default  = '[source]_[kind]_[geometry::rnice_u]'
+            info="Database for bathymetry",
+            attr=dict(
+                kind=dict(
+                    values=["bathymetry"],
                 ),
-            )
-        )
+                source=dict(),
+                gvar=dict(default="[source]_[kind]_[geometry::rnice_u]"),
+            ),
+        ),
     ]
 
     @property
     def realkind(self):
-        return 'bathymetry'
+        return "bathymetry"

vortex/nwp/syntax/__init__.py

@@ -6,4 +6,4 @@ The most important usage is done by :class:`FootprintBase` derivated objects.
 #: No automatic export
 __all__ = []
 
-__tocinfoline__ = 'nwp module where standard attributes are defined.'
+__tocinfoline__ = "nwp module where standard attributes are defined."