vortex-nwp 2.0.0__py3-none-any.whl

vortex/nwp/data/climfiles.py

@@ -0,0 +1,521 @@
+"""
+Various resources to handle climatology files used in NWP models.
+"""
+
+from vortex.data.geometries import LonlatGeometry
+from vortex.data.outflow import StaticGeoResource, ModelGeoResource
+from vortex.syntax.stdattrs import month_deco
+from vortex.syntax.stddeco import namebuilding_insert, namebuilding_append
+from ..syntax.stdattrs import gvar, gdomain
+
+#: No automatic export
+__all__ = []
+
+
+@namebuilding_insert("radical", lambda s: "clim")
+class GenericClim(ModelGeoResource):
+    """Abstract class for a model climatology.
+
+    An HorizontalGeometry object is needed. A Genvkey can be given.
+    """
+
+    _abstract = True
+    _footprint = [
+        gvar,
+        dict(
+            info="Model climatology",
+            attr=dict(
+                kind=dict(values=["clim_model"]),
+                nativefmt=dict(
+                    values=["fa"],
+                    default="fa",
+                ),
+            ),
+        ),
+    ]
+
+    @property
+    def realkind(self):
+        return "clim_model"
+
+    @property
+    def truncation(self):
+        """Returns geometry's truncation."""
+        return self.geometry.truncation
+
+    def olive_basename(self):
+        """OLIVE specific naming convention."""
+        return "Const.Clim"
+
+
+class GlobalClim(GenericClim):
+    """Class for a model climatology of a global model.
+
+    A SpectralGeometry object is needed. A Genvkey can be given.
+    """
+
+    _footprint = dict(
+        info="Model climatology for Global Models",
+        attr=dict(
+            model=dict(values=["arpege"]),
+            gvar=dict(default="clim_[model]_[geometry::gco_grid_def]"),
+        ),
+    )
+
+
+class MonthlyGlobalClim(GlobalClim):
+    """Class for a monthly model climatology of a global model.
+
+    A SpectralGeometry object is needed. A Genvkey can be given.
+    """
+
+    _footprint = [
+        month_deco,
+        dict(
+            info="Monthly model climatology for Global Models",
+        ),
+    ]
+
+
+class ClimLAM(GenericClim):
+    """Class for a model climatology of a Local Area Model.
+
+    A SpectralGeometry object is needed. A Genvkey can be given
+    with a default name retrieved thanks to a GenvDomain object.
+    """
+
+    _footprint = [
+        gdomain,
+        dict(
+            info="Model climatology for Local Area Models",
+            attr=dict(
+                model=dict(
+                    values=["aladin", "arome", "alaro", "harmoniearome"]
+                ),
+                gvar=dict(default="clim_[geometry::gco_grid_def]"),
+            ),
+        ),
+    ]
+
+
+class MonthlyClimLAM(ClimLAM):
+    """Class for a monthly model climatology of a Local Area Model.
+
+    A SpectralGeometry object is needed. A Genvkey can be given
+    with a default name retrieved thanks to a GenvDomain object.
+    """
+
+    _footprint = [
+        month_deco,
+        dict(
+            info="Monthly model climatology for Local Area Models",
+        ),
+    ]
+
+
+class ClimBDAP(GenericClim):
+    """Class for a climatology of a BDAP domain.
+
+    A LonlatGeometry object is needed. A Genvkey can be given
+    with a default name retrieved thanks to a GenvDomain object.
+    """
+
+    _footprint = [
+        gdomain,
+        dict(
+            info="Bdap climatology",
+            attr=dict(
+                kind=dict(values=["clim_bdap"]),
+                geometry=dict(
+                    type=LonlatGeometry,
+                ),
+                gvar=dict(default="clim_dap_[gdomain]"),
+            ),
+        ),
+    ]
+
+    @property
+    def realkind(self):
+        return "clim_bdap"
+
+
+class MonthlyClimBDAP(ClimBDAP):
+    """Class for a monthly climatology of a BDAP domain.
+
+    A LonlatGeometry object is needed. A Genvkey can be given
+    with a default name retrieved thanks to a GenvDomain object.
+    """
+
+    _footprint = [
+        month_deco,
+        dict(
+            info="Monthly Bdap climatology",
+        ),
+    ]
+
+
+# Databases to generate clim files
+class GTOPO30DerivedDB(StaticGeoResource):
+    """
+    Class of a tar-zip file containing parameters derived from
+    GTOPO30 database, generated with old stuff.
+
+    A Genvkey can be given.
+    """
+
+    _footprint = [
+        gvar,
+        dict(
+            info="Database for GTOPO30-derived parameters.",
+            attr=dict(
+                kind=dict(
+                    values=["misc_orography"],
+                ),
+                source=dict(
+                    values=["GTOPO30"],
+                ),
+                geometry=dict(
+                    values=["global2m5"],
+                ),
+                gvar=dict(default="[source]_[kind]"),
+            ),
+        ),
+    ]
+
+    @property
+    def realkind(self):
+        return "misc_orography"
+
+
+class UrbanisationDB(StaticGeoResource):
+    """Class of a binary file containing urbanisation database.
+
+    A Genvkey can be given.
+    """
+
+    _footprint = [
+        gvar,
+        dict(
+            info="Database for urbanisation.",
+            attr=dict(
+                kind=dict(
+                    values=["urbanisation"],
+                ),
+                source=dict(
+                    type=str,
+                ),
+                geometry=dict(
+                    values=["global2m5"],
+                ),
+                gvar=dict(default="[source]_[kind]"),
+            ),
+        ),
+    ]
+
+    @property
+    def realkind(self):
+        return "urbanisation"
+
+
+class WaterPercentageDB(StaticGeoResource):
+    """Class of a binary file containing water percentage database.
+
+    A Genvkey can be given.
+    """
+
+    _footprint = [
+        gvar,
+        dict(
+            info="Database for water percentage.",
+            attr=dict(
+                kind=dict(
+                    values=["water_percentage"],
+                ),
+                source=dict(
+                    type=str,
+                ),
+                geometry=dict(
+                    values=["global2m5"],
+                ),
+                gvar=dict(default="[source]_[kind]"),
+            ),
+        ),
+    ]
+
+    @property
+    def realkind(self):
+        return "water_percentage"
+
+
+class SoilANdVegDB(StaticGeoResource):
+    """Class of a tar-zip file containing parameters derived from various databases.
+
+    A Genvkey can be given.
+    """
+
+    _footprint = [
+        gvar,
+        dict(
+            info="Database for Soil and Vegetation.",
+            attr=dict(
+                kind=dict(
+                    values=["soil_and_veg"],
+                ),
+                source=dict(
+                    type=str,
+                ),
+                geometry=dict(
+                    values=["global1dg", "europeb01"],
+                ),
+                gvar=dict(default="[source]_[kind]"),
+            ),
+        ),
+    ]
+
+    @property
+    def realkind(self):
+        return "soil_and_veg"
+
+
+class MonthlyLAIDB(StaticGeoResource):
+    """Class of a binary file containing monthly LAI derived from various databases.
+
+    A Genvkey can be given.
+    """
+
+    _footprint = [
+        gvar,
+        month_deco,
+        dict(
+            info="Database for monthly LAI.",
+            attr=dict(
+                kind=dict(
+                    values=["LAI"],
+                ),
+                source=dict(
+                    type=str,
+                ),
+                geometry=dict(
+                    values=["global1dg", "europeb01"],
+                ),
+                gvar=dict(default="[source]_[kind]"),
+            ),
+        ),
+    ]
+
+    @property
+    def realkind(self):
+        return "LAI"
+
+
+class MonthlyVegDB(StaticGeoResource):
+    """Class of a binary file containing monthly vegetation derived from various databases.
+
+    A Genvkey can be given.
+    """
+
+    _footprint = [
+        gvar,
+        month_deco,
+        dict(
+            info="Database for monthly vegetation.",
+            attr=dict(
+                kind=dict(
+                    values=["vegetation"],
+                ),
+                source=dict(
+                    type=str,
+                ),
+                geometry=dict(
+                    values=["global1dg", "europeb01"],
+                ),
+                gvar=dict(default="[source]_[kind]"),
+            ),
+        ),
+    ]
+
+    @property
+    def realkind(self):
+        return "vegetation"
+
+
+class SoilClimatologyDB(StaticGeoResource):
+    """
+    Class of a binary file containing climatologic soil parameters
+    (temperature, moisture, snow, ice) derived from various databases.
+
+    A Genvkey can be given.
+    """
+
+    _footprint = [
+        gvar,
+        dict(
+            info="Database for soil climatology parameters.",
+            attr=dict(
+                kind=dict(
+                    values=["soil_clim"],
+                ),
+                source=dict(
+                    type=str,
+                ),
+                geometry=dict(
+                    values=["globaln108", "global1dg"],
+                ),
+                gvar=dict(default="[source]_[kind]"),
+            ),
+        ),
+    ]
+
+    @property
+    def realkind(self):
+        return "soil_clim"
+
+
+class SurfGeopotentialDB(StaticGeoResource):
+    """
+    Class of a binary file containing Surface Geopotential derived from
+    various databases.
+
+    A Genvkey can be given.
+    """
+
+    _footprint = [
+        gvar,
+        dict(
+            info="Database for surface geopotential.",
+            attr=dict(
+                kind=dict(
+                    values=["surfgeopotential"],
+                ),
+                source=dict(
+                    type=str,
+                ),
+                geometry=dict(
+                    values=["global1dg"],
+                ),
+                gvar=dict(default="[source]_[kind]"),
+            ),
+        ),
+    ]
+
+    @property
+    def realkind(self):
+        return "surfgeopotential"
+
+
+class MonthlySoilClimatologyDB(SoilClimatologyDB):
+    """
+    Class of a binary file containing monthly climatologic soil parameters
+    (temperature, moisture, snow, ice) derived from various databases.
+
+    A Genvkey can be given.
+    """
+
+    _footprint = [
+        month_deco,
+        dict(
+            info="Database for monthly soil climatology parameters.",
+        ),
+    ]
+
+
+class MonthlyChemicalDB(StaticGeoResource):
+    """
+    Class of a binary file containing climatologic chemicals (ozone, aerosols)
+    parameters derived from various databases.
+
+    A Genvkey can be given.
+    """
+
+    _footprint = [
+        gvar,
+        month_deco,
+        dict(
+            info="Database for monthly chemicals.",
+            attr=dict(
+                kind=dict(
+                    values=["ozone", "aerosols"],
+                ),
+                source=dict(
+                    type=str,
+                ),
+                geometry=dict(
+                    values=["global2dg5", "global5x4"],
+                ),
+                gvar=dict(default="[source]_[kind]"),
+            ),
+        ),
+    ]
+
+    @property
+    def realkind(self):
+        return self.kind
+
+
+class GeometryIllustration(StaticGeoResource):
+    """Illustration of a domain geographic coverage."""
+
+    _footprint = dict(
+        info="Illustration of a domain geographic coverage.",
+        attr=dict(
+            kind=dict(
+                values=["geometry_plot"],
+            ),
+            nativefmt=dict(
+                values=["png", "pdf"],
+            ),
+        ),
+    )
+
+    @property
+    def realkind(self):
+        return "geometry_plot"
+
+
+@namebuilding_append("src", lambda s: [s.stat, s.level, s.nbfiles])
+class Stabal(ModelGeoResource):
+    """Spectral covariance operators.
+
+    Explanations for the ``stat`` attribute:
+        * bal: cross-variables balances
+        * cv: auto-correlations of the control variable
+        * cvt: ???
+
+    A GenvKey can be given.
+    """
+
+    _footprint = [
+        gvar,
+        dict(
+            info="Spectral covariance operators",
+            attr=dict(
+                kind=dict(
+                    values=["stabal"],
+                ),
+                stat=dict(
+                    values=["bal", "cv", "cvt"],
+                ),
+                level=dict(
+                    type=int,
+                    optional=True,
+                    default=96,
+                    values=[41, 96],
+                ),
+                nbfiles=dict(
+                    default=0,
+                    optional=True,
+                    type=int,
+                ),
+                gvar=dict(default="stabal[level]_[stat]"),
+            ),
+        ),
+    ]
+
+    @property
+    def realkind(self):
+        return "stabal"
+
+    @property
+    def truncation(self):
+        """Returns geometry's truncation."""
+        return self.geometry.truncation

vortex/nwp/data/configfiles.py

@@ -0,0 +1,153 @@
+"""
+Various configuration files (Namelists excepted).
+"""
+
+from vortex.data.outflow import StaticResource
+from ..syntax.stdattrs import gvar
+from vortex.data.contents import JsonDictContent, DataRaw
+from vortex.syntax.stddeco import namebuilding_append
+
+#: No automatic export
+__all__ = []
+
+
+@namebuilding_append("src", lambda self: [self.scope, self.source])
+class GenericConfig(StaticResource):
+    """Generic class to access a pack of configuration files."""
+
+    _abstract = True
+    _footprint = [
+        gvar,
+        dict(
+            info="Configuration file from a pack",
+            attr=dict(
+                kind=dict(values=["config"]),
+                gvar=dict(default="config_[scope]"),
+                scope=dict(info="The configuration pack purpose"),
+                source=dict(
+                    info="The config name within the config pack.",
+                ),
+            ),
+        ),
+    ]
+
+    @property
+    def realkind(self):
+        return "config"
+
+    def gget_urlquery(self):
+        """GGET specific query : ``extract``."""
+        return "extract=" + self.source
+
+
+class AsciiConfig(GenericConfig):
+    """Generic class to access a pack of ASCII configuration files."""
+
+    _footprint = dict(
+        info="ASCII Configuration file from a pack",
+        attr=dict(
+            nativefmt=dict(
+                values=[
+                    "ascii",
+                ]
+            ),
+            clscontents=dict(default=DataRaw),
+        ),
+    )
+
+
+class IniConfig(GenericConfig):
+    """Generic class to access a ini configuration file (e.g. for mkjob)."""
+
+    _footprint = dict(
+        info="Ini configuration file",
+        attr=dict(
+            nativefmt=dict(
+                values=[
+                    "ini",
+                ]
+            ),
+        ),
+    )
+
+
+class JsonConfig(GenericConfig):
+    """Generic class to access a pack of JSON configuration files."""
+
+    _footprint = dict(
+        info="JSON Configuration file from a pack",
+        attr=dict(
+            scope=dict(
+                outcast=[
+                    "oops",
+                ]
+            ),
+            nativefmt=dict(
+                values=[
+                    "json",
+                ]
+            ),
+            clscontents=dict(default=JsonDictContent),
+        ),
+    )
+
+
+class OopsJsonConfig(JsonConfig):
+    """Configuration files for OOPS, defining the oops objects to be built"""
+
+    _footprint = dict(
+        info="OOPS JSON Configuration file from a pack",
+        attr=dict(
+            scope=dict(
+                values=[
+                    "oops",
+                ],
+                outcast=[],
+            ),
+            objects=dict(
+                info="The OOPS objects to be built.",
+            ),
+            source=dict(
+                info="The config name within the config pack.",
+                optional=True,
+                default="[objects].json",
+            ),
+        ),
+    )
+
+
+class YamlConfig(GenericConfig):
+    """Generic class to access a pack of YAML configuration files."""
+
+    _footprint = dict(
+        info="YAML Configuration file from a pack",
+        attr=dict(
+            nativefmt=dict(
+                values=[
+                    "yaml",
+                ]
+            ),
+        ),
+    )
+
+
+class Bundle(StaticResource):
+    """Contains bundling of source codes."""
+
+    _footprint = [
+        gvar,
+        dict(
+            info="Contains bundling of source codes.",
+            attr=dict(
+                kind=dict(values=["bundle"]),
+                gvar=dict(
+                    default="bundle",
+                ),
+                nativefmt=dict(values=["yml", "yaml"]),
+            ),
+        ),
+    ]
+
+    @property
+    def realkind(self):
+        return "bundle"