CMORizer ESACCI-PERMAFROST

doc/sphinx/source/input.rst

@@ -245,6 +245,7 @@ A list of the datasets for which a CMORizers is available is provided in the fol
 
 .. tabularcolumns:: |p{3cm}|p{6cm}|p{3cm}|p{3cm}|
 
+
 +----------------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
 | Dataset                                | Variables (MIP)                                                                                      | Tier | Script language |
 +========================================+======================================================================================================+======+=================+
@@ -338,6 +339,8 @@ A list of the datasets for which a CMORizers is available is provided in the fol
 +----------------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
 | ESACCI-OZONE  [#note5]_                | toz, o3 (AERmon)                                                                                     |   2  | Python          |
 +----------------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
+| ESACCI-PERMAFROST                      | alt, gtd, pfr (Lyr, frequency: yr)                                                                   |   2  | Python          |
++----------------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
 | ESACCI-SEAICE                          | siconc (SIday, SImon)                                                                                |   2  | Python          |
 +----------------------------------------+------------------------------------------------------------------------------------------------------+------+-----------------+
 | ESACCI-SEA-SURFACE-SALINITY            | sos (Omon)                                                                                           |   2  | Python          |

esmvaltool/cmorizers/data/cmor_config/ESACCI-PERMAFROST.yml

@@ -0,0 +1,29 @@
+---
+# Common global attributes for CMORizer output
+attributes:
+  dataset_id: ESACCI-PERMAFROST
+  version: 'v5.0NH'
+  tier: 2
+  type: sat
+  project_id: OBS6
+  source: 'ftp://dap.ceda.ac.uk/neodc/esacci/permafrost'
+  reference: "esacci-permafrost"
+  comment: ""
+
+# Variables to CMORize
+variables:
+  alt:
+    mip: Lyr
+    raw: ALT
+    file: 'ESACCI-PERMAFROST-L4-ALT-*-AREA4_PP-{year}-fv05.0.nc'
+    weights_dir: './esacci-permafrost-weights'
+  gtd:
+    mip: Lyr
+    raw: [GST, T1m, T2m, T5m, T10m]
+    file: 'ESACCI-PERMAFROST-L4-GTD-*-AREA4_PP-{year}-fv05.0.nc'
+    weights_dir: './esacci-permafrost-weights'
+  pfr:
+    mip: Lyr
+    raw: PFR
+    file: 'ESACCI-PERMAFROST-L4-PFR-*-AREA4_PP-{year}-fv05.0.nc'
+    weights_dir: './esacci-permafrost-weights'

esmvaltool/cmorizers/data/datasets.yml

@@ -570,6 +570,17 @@ datasets:
             Version = "v0008"
       Put all files under a single directory (no subdirectories with years).
 
+  ESACCI-PERMAFROST:
+    tier: 2
+    source: ftp://dap.ceda.ac.uk/neodc/esacci/permafrost/data
+    last_access: 2026-02-18
+    info: |
+      Download the data from:
+        active_layer_thickness/L4/area4/pp/v05.0/northern_hemisphere/<yyyy>/
+        ground_temperature/L4/area4/pp/v05.0/northern_hemisphere/<yyyy>/
+        permafrost_extent/L4/area4/pp/v05.0/northern_hemisphere/<yyyy>/
+      Put all files in a single directory.
+
   ESACCI-SEAICE:
     tier: 2
     source: ftp://anon-ftp.ceda.ac.uk/neodc/esacci/sea_ice/data/

esmvaltool/cmorizers/data/downloaders/datasets/esacci_permafrost.py

@@ -0,0 +1,73 @@
+"""Script to download ESACCI-PERMAFROST."""
+
+import datetime
+import logging
+
+from dateutil import relativedelta
+
+from esmvaltool.cmorizers.data.downloaders.wget import WGetDownloader
+
+logger = logging.getLogger(__name__)
+
+
+def download_dataset(
+    original_data_dir,
+    dataset,
+    dataset_info,
+    start_date,
+    end_date,
+    overwrite,
+) -> None:
+    """Download dataset.
+
+    Parameters
+    ----------
+    original_data_dir : Path
+        Directory where original data will be stored.
+    dataset : str
+        Name of the dataset
+    dataset_info : dict
+         Dataset information from the datasets.yml file
+    start_date : datetime
+        Start of the interval to download
+    end_date : datetime
+        End of the interval to download
+    overwrite : bool
+        Overwrite already downloaded files
+    """
+    if start_date is None:
+        start_date = datetime.datetime(1997, 1, 1, tzinfo=datetime.UTC)
+    if end_date is None:
+        end_date = datetime.datetime(2023, 12, 31, tzinfo=datetime.UTC)
+
+    downloader = WGetDownloader(
+        original_data_dir=original_data_dir,
+        dataset=dataset,
+        dataset_info=dataset_info,
+        overwrite=overwrite,
+    )
+
+    version = "v05.0"
+
+    path = "https://dap.ceda.ac.uk/neodc/esacci/permafrost/data/"
+
+    ccivars = [
+        "active_layer_thickness",
+        "ground_temperature",
+        "permafrost_extent",
+    ]
+
+    # download cci variables active layer thickness, ground temperature and
+    # permafrost extent
+    loop_date = start_date
+    while loop_date <= end_date:
+        for var in ccivars:
+            folder = (
+                path
+                + f"{var}/L4/area4/pp/{version}/northern_hemisphere/{loop_date.year}/"
+            )
+            downloader.download_folder(
+                folder,
+                wget_options=["-e robots=off", "--no-parent", "--accept=nc"],
+            )
+        loop_date += relativedelta.relativedelta(years=1)

esmvaltool/cmorizers/data/downloaders/ftp.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import fnmatch
 import ftplib
 import logging
 import os
@@ -260,6 +261,26 @@ def dataset_name(self):
         """
         return self.dataset.lower().replace("-", "_")
 
+    def download_files(self, filename, path=None):
+        """Download file(s).
+
+        Parameters
+        ----------
+        filename : str
+            Name of file (w/o path) to download (wildcards are allowed)
+        path : str
+            Path of file(s) to download (optional)
+        """
+        if path is not None:
+            self.set_cwd(path)
+        files = self._client.nlst()
+        matching_files = fnmatch.filter(files, filename)
+        if len(matching_files) != 0:
+            for file in matching_files:
+                super().download_file(file)
+        else:
+            logger.info("No files %s found.", filename)
+
     def download_year(self, year):
         """Download a specific year.
 
@@ -269,3 +290,21 @@ def download_year(self, year):
             Year to download
         """
         self.download_folder(str(year))
+
+    def file_exists(self, filename, path=None):
+        """Check if a file exists.
+
+        Parameters
+        ----------
+        filename : str
+            Name of file (w/o path) to check (wildcards are allowed)
+        path : str
+            Path of file to check (optional)
+        """
+        if path is not None:
+            self.set_cwd(path)
+        files = self._client.nlst()
+        matching_files = fnmatch.filter(files, filename)
+        if len(matching_files) != 0:
+            return True
+        return False