vortex-nwp 2.1.3__tar.gz → 2.3.0__tar.gz

{vortex_nwp-2.1.3/src/vortex_nwp.egg-info → vortex_nwp-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vortex-nwp
-Version: 2.1.3
+Version: 2.3.0
 Summary: A Python library to write Numerical Weather Prediction pipelines components
 Author-email: The Vortex Team <vortex.support@meteo.fr>
 License: CECILL-C
@@ -14,6 +14,7 @@ Requires-Dist: footprints
 Requires-Dist: taylorism
 Requires-Dist: tomli
 Requires-Dist: arpifs_listings
+Requires-Dist: importlib_metadata; python_version < "3.8"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: sphinx-book-theme; extra == "docs"
@@ -21,6 +22,8 @@ Requires-Dist: sphinx-copybutton; extra == "docs"
 Provides-Extra: dev
 Requires-Dist: ruff==0.9.1; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
+Provides-Extra: git
+Requires-Dist: pygit2; extra == "git"
 Dynamic: license-file
 
 ## vortex

{vortex_nwp-2.1.3 → vortex_nwp-2.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vortex-nwp"
-version = "2.1.3"
+version = "2.3.0"
 description = "A Python library to write Numerical Weather Prediction pipelines components"
 readme = "README.md"
 requires-python = ">=3.7"
@@ -18,12 +18,18 @@ classifiers = [
     "License :: CeCILL-C Free Software License Agreement (CECILL-C)",
 ]
 dependencies = [
-    "bronx", "footprints", "taylorism", "tomli", "arpifs_listings",
+    "bronx",
+    "footprints",
+    "taylorism",
+    "tomli",
+    "arpifs_listings",
+    "importlib_metadata; python_version < '3.8'",
 ]
 
 [project.optional-dependencies]
 docs = ["sphinx", "sphinx-book-theme", "sphinx-copybutton"]
 dev = ["ruff==0.9.1", "pytest"]
+git = ["pygit2"]
 
 [tool.setuptools.packages.find]
 where = ["src"]

{vortex_nwp-2.1.3 → vortex_nwp-2.3.0}/src/vortex/__init__.py

@@ -50,13 +50,14 @@ from .toolbox import promise as promise
 from .toolbox import diff as diff
 from .toolbox import defaults as defaults
 from .toolbox import algo as task
+from .toolbox import VortexForceComplete as VortexForceComplete
 
 from . import nwp as nwp  # footprints import
 
-__version__ = "2.1.3"
+__version__ = "2.3.0"
 __prompt__ = "Vortex v-" + __version__ + ":"
 
-__nextversion__ = "2.1.4"
+__nextversion__ = "2.3.1"
 __tocinfoline__ = "VORTEX core package"
 
 __all__ = [

{vortex_nwp-2.1.3 → vortex_nwp-2.3.0}/src/vortex/algo/components.py

@@ -1548,12 +1548,25 @@ class Expresso(ExecutableAlgoComponent):
         attr=dict(
             interpreter=dict(
                 info="The interpreter needed to run the script.",
-                values=["current", "awk", "ksh", "bash", "perl", "python"],
+                values=[
+                    "current",
+                    "awk",
+                    "ksh",
+                    "bash",
+                    "perl",
+                    "python",
+                    "singularity",
+                ],
             ),
             interpreter_path=dict(
                 info="The interpreter command.",
                 optional=True,
             ),
+            interpreter_args=dict(
+                info="Some options to pass to the expresso",
+                optional=True,
+                default="",
+            ),
             engine=dict(values=["exec", "launch"]),
         ),
     )
@@ -1581,11 +1594,16 @@ class Expresso(ExecutableAlgoComponent):
                     )
 
     def _interpreter_args_fix(self, rh, opts):
+        cmd_opts = shlex.split(self.interpreter_args)
+
         absexec = self.absexcutable(rh.container.localpath())
         if self.interpreter == "awk":
-            return ["-f", absexec]
+            return [*cmd_opts, "-f", absexec]
+        if self.interpreter == "singularity":
+            return ["run", *cmd_opts, absexec]
         else:
             return [
+                *cmd_opts,
                 absexec,
             ]
 

{vortex_nwp-2.1.3 → vortex_nwp-2.3.0}/src/vortex/algo/mpitools.py

@@ -544,10 +544,6 @@ class MpiTool(footprints.FootprintBase):
         """When group are defined, associate each MPI rank with a "real" slot."""
         if self._ranks_map_cache is None:
             self._complex_ranks_map = False
-            if not self.envelope:
-                raise RuntimeError(
-                    "Ranks mapping should always be used within an envelope."
-                )
             # First deal with bingroups
             ranks_map = dict()
             has_bin_groups = not all([b.group is None for b in self.binaries])
@@ -624,7 +620,7 @@ class MpiTool(footprints.FootprintBase):
             if self._complex_ranks_map or do_bin_distribution:
                 if not self.envelope:
                     raise RuntimeError(
-                        "Ranks mapping shoudl always be used within an envelope."
+                        "Ranks mapping should always be used within an envelope."
                     )
             if do_bin_distribution:
                 if not self._supports_manual_ranks_mapping:
@@ -1404,7 +1400,10 @@ class SRun(MpiTool):
             ),
             optmap=dict(
                 default=footprints.FPDict(
-                    nn="nodes", nnp="ntasks-per-node", np="ntasks"
+                    nn="nodes",
+                    nnp="ntasks-per-node",
+                    np="ntasks",
+                    openmp="cpus-per-task",
                 )
             ),
             slurmversion=dict(type=int, optional=True),

{vortex_nwp-2.1.3 → vortex_nwp-2.3.0}/src/vortex/data/abstractstores.py

@@ -14,7 +14,12 @@ from bronx.system import hash as hashutils
 import footprints
 
 from vortex import sessions
-from vortex.config import from_config, ConfigurationError, is_defined
+from vortex.config import (
+    from_config,
+    ConfigurationError,
+    is_defined,
+    get_from_config_w_default,
+)
 from vortex.syntax.stdattrs import (
     hashalgo,
     hashalgo_avail_list,
@@ -438,6 +443,7 @@ class MultiStore(footprints.FootprintBase):
             attr=dict(
                 scheme=dict(alias=("protocol",)),
                 netloc=dict(type=Namespace, alias=("domain", "namespace")),
+                username=dict(type=str),
                 refillstore=dict(
                     type=bool,
                     optional=True,
@@ -792,6 +798,9 @@ class ArchiveStore(Store):
                 netloc=dict(
                     values=["open.archive.fr"],
                 ),
+                username=dict(
+                    type=str,
+                ),
                 storehash=dict(
                     values=hashalgo_avail_list,
                 ),
@@ -843,6 +852,13 @@ class ArchiveStore(Store):
     def underlying_archive_kind(self):
         return "std"
 
+    @property
+    def archive_entry(self):
+        pattern = get_from_config_w_default(
+            section="storage", key="rootdir", default="~/vortex"
+        )
+        return pattern.replace("%usr%", self.username)
+
     @property
     def actual_storage(self):
         """This archive network name (potentially read form the configuration file)."""
@@ -894,6 +910,7 @@ class ArchiveStore(Store):
                 storage=self.actual_storage,
                 tube=self.actual_storetube,
                 readonly=self.readonly,
+                entry=self.archive_entry,
             )
             self._archives_object_stack.add(self._archive)
         return self._archive
@@ -909,25 +926,12 @@ class ArchiveStore(Store):
 
     archive = property(_get_archive, _set_archive, _del_archive)
 
-    def _inarchiveformatpath(self, remote):
-        # Remove extra slashes
-        formatted = remote["path"].lstrip(self.system.path.sep)
-        # Store head ?
-        if self.storehead:
-            formatted = self.system.path.join(self.storehead, formatted)
-        # Store root (if specified)
-        pathroot = remote.get("root", self.storeroot)
-        if pathroot is not None:
-            formatted = self.system.path.join(pathroot, formatted)
-        return formatted
-
     def inarchivecheck(self, remote, options):
         """Use the archive object to check if **remote** exists."""
         # Try to delete the md5 file but ignore errors...
         if self._hash_check_or_delete(self.inarchivecheck, remote, options):
             return self.archive.check(
-                self._inarchiveformatpath(remote),
-                username=remote.get("username", None),
+                remote["path"],
                 fmt=options.get("fmt", "foo"),
                 compressionpipeline=self._actual_cpipeline,
             )
@@ -937,8 +941,7 @@ class ArchiveStore(Store):
     def inarchivelocate(self, remote, options):
         """Use the archive object to obtain **remote** physical location."""
         return self.archive.fullpath(
-            self._inarchiveformatpath(remote),
-            username=remote.get("username", None),
+            remote["path"],
             fmt=options.get("fmt", "foo"),
             compressionpipeline=self._actual_cpipeline,
         )
@@ -946,15 +949,13 @@ class ArchiveStore(Store):
     def inarchivelist(self, remote, options):
         """Use the archive object to list available files."""
         return self.archive.list(
-            self._inarchiveformatpath(remote),
-            username=remote.get("username", None),
+            remote["path"],
         )
 
     def inarchiveprestageinfo(self, remote, options):
         """Returns the prestaging informations"""
         return self.archive.prestageinfo(
-            self._inarchiveformatpath(remote),
-            username=remote.get("username", None),
+            remote["path"],
             fmt=options.get("fmt", "foo"),
             compressionpipeline=self._actual_cpipeline,
         )
@@ -965,16 +966,15 @@ class ArchiveStore(Store):
             "inarchiveget on %s://%s/%s (to: %s)",
             self.scheme,
             self.netloc,
-            self._inarchiveformatpath(remote),
+            remote["path"],
             local,
         )
         rc = self.archive.retrieve(
-            self._inarchiveformatpath(remote),
+            remote["path"],
             local,
             intent=options.get("intent", ARCHIVE_GET_INTENT_DEFAULT),
             fmt=options.get("fmt", "foo"),
             info=options.get("rhandler", None),
-            username=remote["username"],
             compressionpipeline=self._actual_cpipeline,
         )
         return rc and self._hash_get_check(
@@ -987,16 +987,15 @@ class ArchiveStore(Store):
             "inarchiveearlyget on %s://%s/%s (to: %s)",
             self.scheme,
             self.netloc,
-            self._inarchiveformatpath(remote),
+            remote["path"],
             local,
         )
         rc = self.archive.earlyretrieve(
-            self._inarchiveformatpath(remote),
+            remote["path"],
             local,
             intent=options.get("intent", ARCHIVE_GET_INTENT_DEFAULT),
             fmt=options.get("fmt", "foo"),
             info=options.get("rhandler", None),
-            username=remote["username"],
             compressionpipeline=self._actual_cpipeline,
         )
         return rc
@@ -1007,17 +1006,16 @@ class ArchiveStore(Store):
             "inarchivefinaliseget on %s://%s/%s (to: %s)",
             self.scheme,
             self.netloc,
-            self._inarchiveformatpath(remote),
+            remote["path"],
             local,
         )
         rc = self.archive.finaliseretrieve(
             result_id,
-            self._inarchiveformatpath(remote),
+            remote["path"],
             local,
             intent=options.get("intent", ARCHIVE_GET_INTENT_DEFAULT),
             fmt=options.get("fmt", "foo"),
             info=options.get("rhandler", None),
-            username=remote["username"],
             compressionpipeline=self._actual_cpipeline,
         )
         return rc and self._hash_get_check(
@@ -1030,16 +1028,15 @@ class ArchiveStore(Store):
             "inarchiveput to %s://%s/%s (from: %s)",
             self.scheme,
             self.netloc,
-            self._inarchiveformatpath(remote),
+            remote["path"],
             local,
         )
         rc = self.archive.insert(
-            self._inarchiveformatpath(remote),
+            remote["path"],
             local,
             intent=ARCHIVE_PUT_INTENT,
             fmt=options.get("fmt", "foo"),
             info=options.get("rhandler"),
-            username=remote["username"],
             compressionpipeline=self._actual_cpipeline,
             enforcesync=options.get("enforcesync", False),
             usejeeves=options.get("delayed", None),
@@ -1051,15 +1048,14 @@ class ArchiveStore(Store):
             "inarchivedelete on %s://%s/%s",
             self.scheme,
             self.netloc,
-            self._inarchiveformatpath(remote),
+            remote["path"],
         )
         # Try to delete the md5 file but ignore errors...
         self._hash_check_or_delete(self.inarchivedelete, remote, options)
         return self.archive.delete(
-            self._inarchiveformatpath(remote),
+            remote["path"],
             fmt=options.get("fmt", "foo"),
             info=options.get("rhandler", None),
-            username=remote["username"],
             compressionpipeline=self._actual_cpipeline,
         )
 
@@ -1081,6 +1077,9 @@ class CacheStore(Store):
             netloc=dict(
                 values=["open.cache.fr"],
             ),
+            username=dict(
+                type=str,
+            ),
             storehash=dict(
                 values=hashalgo_avail_list,
             ),
@@ -1130,7 +1129,7 @@ class CacheStore(Store):
     def _get_cache(self):
         if not self._cache:
             self._cache = footprints.proxy.caches.default(
-                entry=self.location,
+                entry=self.cache_entry,
                 rtouch=self.rtouch,
                 rtouchskip=self.rtouchskip,
                 readonly=self.readonly,
@@ -1255,6 +1254,7 @@ class PromiseStore(footprints.FootprintBase):
         attr=dict(
             scheme=dict(alias=("protocol",)),
             netloc=dict(type=Namespace, alias=("domain", "namespace")),
+            username=dict(type=str),
             storetrack=dict(
                 type=bool,
                 default=True,
@@ -1282,12 +1282,14 @@ class PromiseStore(footprints.FootprintBase):
             scheme=self.proxyscheme,
             netloc=self.prstorename,
             storetrack=self.storetrack,
+            username=self.username,
         )
         if self.promise is None:
             logger.critical(
-                "Could not find store scheme <%s> netloc <%s>",
+                "Could not find store scheme <%s> netloc <%s> username <%s>",
                 self.proxyscheme,
                 self.prstorename,
+                self.username,
             )
             raise ValueError("Could not get a Promise Store")
 
@@ -1296,12 +1298,14 @@ class PromiseStore(footprints.FootprintBase):
             scheme=self.proxyscheme,
             netloc=self.netloc,
             storetrack=self.storetrack,
+            username=self.username,
         )
         if self.other is None:
             logger.critical(
-                "Could not find store scheme <%s> netloc <%s>",
+                "Could not find store scheme <%s> netloc <%s> username <%s>",
                 self.proxyscheme,
                 self.netloc,
+                self.username,
             )
             raise ValueError("Could not get an Other Store")
 

{vortex_nwp-2.1.3 → vortex_nwp-2.3.0}/src/vortex/data/executables.py

@@ -106,6 +106,34 @@ class Script(Executable):
             return self.rawopts
 
 
+class SingularityImage(Executable):
+    """Singularity container image executable."""
+
+    _footprint = dict(
+        attr=dict(
+            kind=dict(
+                values=["image"],
+            ),
+            cmd=dict(
+                info="Command to run inside the container",
+                optional=True,
+                default="",
+            ),
+        ),
+    )
+
+    @property
+    def realkind(self):
+        return "image"
+
+    # Called by AlgoComponent.spawn_command_line
+    def command_line(self, **opts):
+        return " ".join(
+            ["--{:s} {:s}".format(opt, val) for opt, val in opts.items()]
+            + [self.cmd]
+        )
+
+
 class GnuScript(Executable):
     """Basic interpreted executable with standard command line arguments."""
 

{vortex_nwp-2.1.3 → vortex_nwp-2.3.0}/src/vortex/data/geometries.ini

@@ -659,6 +659,13 @@ area       = indonesie1
 resolution = 2.50
 runit      = km
 
+[asscomindonesie2sp]
+info       = Arome asscom14 - indonesie2 spectral geometry
+kind       = projected
+area       = indonesie2
+resolution = 2.50
+runit      = km
+
 [lace20km]
 info       = Coupling grid for LACE partners
 kind       = projected
@@ -673,6 +680,13 @@ area       = lace
 resolution = 8.0
 runit      = km
 
+[lace47]
+info       = LACE canari domain
+kind       = projected
+area       = lace47
+resolution = 4.71
+runit      = km
+
 [afgt20km]
 info       = Coupling grid for afgt-Praha
 kind       = projected
@@ -1201,15 +1215,15 @@ nlon       = 641
 [paris1s100]
 info       = PARIS 0.01
 kind       = lonlat
-area       = paris1s100
+area       = PARIS1S100
 resolution = 0.01
-nlat       = 221
-nlon       = 336
+nlat       = 187
+nlon       = 279
 
 [medalp1s100]
 info       = MEDALP 0.01
 kind       = lonlat
-area       = medalp1s100
+area       = MEDALP1S100
 resolution = 0.01
 nlat       = 481
 nlon       = 501
@@ -1677,6 +1691,17 @@ nlat       = 172800
 latmax     = 83.999
 latmin     = -55.999
 
+[srtm_01s]
+info       = alternative to no_arctics7.5s used to create arome-500m PGD clim
+kind       = lonlat
+area       = srtm
+resolution = 1
+runit      = s
+nlon       = 999
+nlat       = 999
+latmax     = 999
+latmin     = 999
+
 [europe_sw3s]
 kind       = lonlat
 area       = europe_sw
@@ -2468,39 +2493,39 @@ nlon       = 896
 resolution = 0.05
 runit      = deg
 
-[hycom3dmedoc]
-info       = Shom HYCOM3D Med-occidental at 1/60
+[hycom3dmednowe]
+info       = Shom HYCOM3D Med-NorthWest at 1/60
 kind       = lonlat
-area       = medoc
-nlat       = 331
-nlon       = 661
+area       = mednowe
+nlat       = 437
+nlon       = 761
 resolution = 0.017
 runit      = deg
 
-[hycom3dmedor]
-info       = Shom HYCOM3D Med-oriental at 1/60
+[hycom3dmedsowe]
+info       = Shom HYCOM3D Med-SouthWest at 1/60
 kind       = lonlat
-area       = medor
-nlat       = 437
-nlon       = 645
+area       = medsowe
+nlat       = 481
+nlon       = 1080
 resolution = 0.017
 runit      = deg
 
-[hycom3dmedio]
-info       = Shom HYCOM3D Med-ionian at 1/60
+[hycom3dmedea]
+info       = Shom HYCOM3D Med-East at 1/60
 kind       = lonlat
-area       = medio
-nlat       = 557
-nlon       = 781
+area       = medea
+nlat       = 706
+nlon       = 855
 resolution = 0.017
 runit      = deg
 
-[hycom3dgibal]
-info       = Shom HYCOM3D Gibraltair Strait-Alboran Sea at 1/60
+[hycom3dmedinte]
+info       = Shom HYCOM3D Med-Interior at 1/60
 kind       = lonlat
-area       = gibal
-nlat       = 361
-nlon       = 571
+area       = medinte
+nlat       = 935
+nlon       = 781
 resolution = 0.017
 runit      = deg
 
@@ -2575,6 +2600,13 @@ area       = corsica
 resolution = 2.5
 runit      = km
 
+[nl2500]
+info       = HARMONIE-AROME 2.5km NL domain for DAVAI
+kind       = projected
+area       = nl
+resolution = 2.5
+runit      = km
+
 [cors1s40]
 info       = Corsica 0.025 deg
 kind       = lonlat
@@ -2669,6 +2701,39 @@ area       = chmh2325
 resolution = 2.33
 runit      = km
 
+[armcu]
+info       = MUSC Single point ARMCU
+kind       = unstructured
+area       = armcu
+
+[global31c1]
+info       = ARPEGE T31C1.0 geometry (from Mitraillette tests)
+kind       = gauss
+area       = france
+truncation = 31
+stretching = 1.0
+
+[global30c24]
+info       = ARPEGE T30C2.4 geometry (from Mitraillette tests)
+kind       = gauss
+area       = france
+truncation = 30
+stretching = 2.4
+
+[portugal21km]
+info       = Mitraillette Portugal grid
+kind       = projected
+area       = portugal
+resolution = 21.3
+runit      = km
+
+[occitanie4km]
+info       = Mitraillette Occitanie grid
+kind       = projected
+area       = occitanie
+resolution = 4.4
+runit      = km
+
 #R ===================
 #R Combined geometries
 #R ===================

{vortex_nwp-2.1.3 → vortex_nwp-2.3.0}/src/vortex/data/geometries.py

@@ -759,13 +759,30 @@ hgeometry_deco = footprints.DecorativeFootprint(
 # Load default geometries when the module is first imported
 
 
-def load(inifile="@geometries.ini", refresh=False, verbose=True):
+def _get_user_config_dir():
+    """Get the user's vortex configuration directory.
+
+    This function is separated out to make it easier to mock in tests.
+    """
+    from pathlib import Path
+    from vortex.tools.env import Environment
+
+    env = Environment(active=False)
+    return Path(env.HOME) / ".vortexrc"
+
+
+def load(
+    inifile="@geometries.ini",
+    refresh=False,
+    verbose=True,
+    _user_config_dir=None,
+):
     """Load a set of pre-defined geometries from a configuration file.
 
     The class that will be instantiated depends on the "kind" keyword..
-    """
-    from vortex import sessions
 
+    :param _user_config_dir: Override user config directory (for testing)
+    """
     iniconf = configparser.ConfigParser()
 
     # Load from vortex distribution
@@ -776,10 +793,10 @@ def load(inifile="@geometries.ini", refresh=False, verbose=True):
         iniconf.read_file(fh)
 
     # Load from user's config directory if it exists
-    glove = sessions.current().glove
-    local = sessions.system()
-    user_geometries = glove.configrc + "/geometries.ini"
-    if local.path.exists(user_geometries):
+    if _user_config_dir is None:
+        _user_config_dir = _get_user_config_dir()
+    user_geometries = _user_config_dir / "geometries.ini"
+    if user_geometries.exists():
         with open(user_geometries, encoding="utf-8") as fh:
             iniconf.read_file(fh)
 

{vortex_nwp-2.1.3 → vortex_nwp-2.3.0}/src/vortex/data/handlers.py

@@ -485,6 +485,7 @@ class Handler:
             return footprints.proxy.store(
                 scheme=self._uridata.pop("scheme"),
                 netloc=self._uridata.pop("netloc"),
+                username=self._uridata.pop("username"),
                 **stopts,
             )
         else: