Add DOI support and enhance dataset metadata structure

.zenodo.json

@@ -1,22 +1,28 @@
 {
     "creators": [
         {
-            "orcid": "0000-0003-3891-5444",
+            "orcid": "0000-0001-6541-2768",
             "affiliation": "ACCESS-NRI",
-            "name": "Beucher, Romain"
+            "name": "Bird, Lawrence"
         },
         {
+            "orcid": "0000-0002-5238-6115",
             "affiliation": "ACCESS-NRI",
-            "name": "Carouge, Claire"
+            "name": "Kin Jun Hew, Justin"
+        },
+        {
+            "orcid": "0000-0002-2320-4239",
+            "affiliation": "ACCESS-NRI",
+            "name": "Tetley, Michael G."
         }
     ],
 
     "license": "Apache-2.0",
 
-    "title": "ACCESS-NRI Template",
-    "decription": "Template repository for ACCESS-NRI, test",
+    "title": "ACCESS-NRI ccdtools",
+    "description": "Python API for the ACCESS-NRI Cryosphere Community Datapool (CCD)",
 
-    "keywords": ["Climate", "Science", "ACCESS-NRI", "NCI"],
+    "keywords": ["Cryosphere", "Ice sheet modelling", "Climate", "Science", "ACCESS-NRI", "NCI"],
 
     "communities": [
         {"identifier": "access-nri"}

src/ccdtools/catalog.py

@@ -315,7 +315,8 @@ def _list_datasets(self):
             DataFrame with columns: ``dataset``, ``display_name``, ``description``,
             ``tags``, ``version``, ``subdataset``, ``path``, ``full_path``,
             ``extension``, ``skip_lines``, ``no_data_value``, ``ignore_dirs``,
-            ``ignore_files``, ``loader``, ``resolutions``, ``static_patterns``.
+            ``ignore_files``, ``loader``, ``resolutions``, ``static_patterns``,
+            ``doi``.
         """
 
         # Initialize list to hold dataset records
@@ -356,6 +357,7 @@ def _list_datasets(self):
                         loader = self._resolve_metadata(meta, subds_meta, version, "loader", "default")
                         resolutions = self._resolve_metadata(meta, subds_meta, version, "resolutions")
                         static_patterns = self._resolve_metadata(meta, subds_meta, version, "static_patterns", [])
+                        doi = self._resolve_metadata(meta, subds_meta, version, "doi", None)
 
                         # Normalise lists as needed
                         ignore_dirs = self._normalise_list(ignore_dirs)
@@ -389,6 +391,7 @@ def _list_datasets(self):
                             "loader": loader,
                             "resolutions": resolutions,
                             "static_patterns": static_patterns,
+                            "doi": doi,
                         })
 
             # VERSIONED DATASETS (no subdatasets)
@@ -406,6 +409,7 @@ def _list_datasets(self):
                     loader = self._resolve_metadata(meta, None, version, "loader", "default")
                     resolutions = self._resolve_metadata(meta, None, version, "resolutions")
                     static_patterns = self._resolve_metadata(meta, None, version, "static_patterns", [])
+                    doi = self._resolve_metadata(meta, None, version, "doi", None)
 
                     # Normalise lists as needed
                     ignore_dirs = self._normalise_list(ignore_dirs)
@@ -437,6 +441,7 @@ def _list_datasets(self):
                         "loader": loader,
                         "resolutions": resolutions,
                         "static_patterns": static_patterns,
+                        "doi": doi,
                     })
 
         return pd.DataFrame(records)
@@ -1077,6 +1082,13 @@ def help(self, dataset = None, version = None):
 
         print(f"\nVersion: {version}")
 
+        # Extract row for metadata access
+        row = subset.iloc[0]
+        doi = row.get("doi", None)
+        print(f"DOI: {doi}")
+
+
+
         # 4. Subdatasets
         # ------------------------------------------------------------------
         # If subdatasets exist, list them
@@ -1090,7 +1102,6 @@ def help(self, dataset = None, version = None):
 
         # 5. Capabilities (based on row metadata)
         # ------------------------------------------------------------------
-        row = subset.iloc[0]
 
         print("\nSupported catalog keywords:")
         print(f"  - subdataset : {'yes' if not subset.subdataset.isna().all() else 'no'}")

src/ccdtools/config/datasets.yaml

@@ -13,6 +13,10 @@ datasets:
       - bed uncertainty
       - ice mask
     extension: nc
+    doi:
+      v1: 10.5067/C2GFER6PTOS4
+      v2: 10.5067/E1QL9HFQ7A8M
+      v3: 10.5067/FPSU0V1MWUB6
 
   bedmap:
     display_name: Bedmap
@@ -29,14 +33,17 @@ datasets:
           subpath: geospatial_data
           extension: gpkg
           no_data_value: -9999
+          doi: 10.5285/925ac4ec-2a9d-461a-bfaa-6314eb0888c8
         points:
           subpath: point_data
           extension: csv
           skip_lines: 18
           no_data_value: -9999
+          doi: 10.5285/f64815ec-4077-4432-9f55-0ce230f46029
         gridded:
           subpath: gridded_data
           extension: tif
+          doi: 10.5285/908BB17F-467C-42BF-AE00-F03BB0FEEA23
       v2:
         geospatial:
           subpath: geospatial_data
@@ -73,6 +80,7 @@ datasets:
             - bm3_streamlines_pt
 
   measures_its_live_antarctica_annual_ice_mask:
+    doi: 10.000/ABCD
     display_name: ITS_LIVE Annual 240 m Ice Sheet Extent Mask - 1997 to 2021
     path: /g/data/av17/access-nri/cryosphere-data-pool/elevation_geometry/measures_its_live_antarctic_annual_240m_ice_sheet_extent_masks_1997_2021
     description: Annual ice sheet extent masks for Antarctica from ITS_LIVE at 240 m resolution, covering the years 1997 to 2021. Ice thickness and velocity data used to determine the presence of ice are also provided.
@@ -84,6 +92,7 @@ datasets:
     extension: nc
 
   measures_its_live_antarctic_grounded_ice_sheet_elevation_change:
+    doi: 10.000/ABCD
     display_name: ITS_LIVE Antarctic Ice Sheet grounded ice elevation change
     path: /g/data/av17/access-nri/cryosphere-data-pool/elevation_geometry/measures_its_live_antarctic_grounded_ice_sheet_elevation_change
     description: ITS_LIVE Antarctic Ice Sheet grounded ice elevation change
@@ -94,6 +103,7 @@ datasets:
     extension: nc
 
   measures_its_live_antarctic_quarterly_ice_shelf_height_change:
+    doi: 10.000/ABCD
     display_name: ITS_LIVE Antarctic Ice Shelf quarterly height change and basal melt rates - 1992 to 2017
     path: /g/data/av17/access-nri/cryosphere-data-pool/elevation_geometry/measures_its_live_antarctic_quarterly_1920m_ice_shelf_height_change_and_basal_melt_rates_1992_2017
     description: ITS_LIVE Antarctic Ice Shelf quarterly height change and basal melt rates - 1992 to 2017
@@ -108,6 +118,7 @@ datasets:
 
   # GEOSPTATIAL DATASETS
   measures_antarctic_boundaries:
+    doi: 10.000/ABCD
     display_name: Antarctic Boundaries for IPY 2007-2009 from Satellite Radar
     path: /g/data/av17/access-nri/cryosphere-data-pool/geospatial/measures_antarctic_boundaries_for_ipy_2007_2009_from_satellite_radar
     description: Antarctic coastline, grounding line, and ice front positions derived from satellite radar data for the International Polar Year 2007-2009.
@@ -149,6 +160,7 @@ datasets:
           extension: tif
 
   measures_antarctic_grounding_line:
+    doi: 10.000/ABCD
     display_name: Antarctic Grounding Line from Differential Satellite Radar Interferometry
     path: /g/data/av17/access-nri/cryosphere-data-pool/geospatial/measures_antarctic_grounding_line_from_differential_satellite_radar_interferometry
     description: Grounding line positions for Antarctica derived from differential satellite radar interferometry.
@@ -161,6 +173,7 @@ datasets:
 
   # BASAL FORCING DATASETS
   antarctic_geothermal_heat_flow_model_aq1:
+    doi: 10.000/ABCD
     display_name: Antarctic Geothermal Heat Flow Model AQ1
     path: /g/data/av17/access-nri/cryosphere-data-pool/basal_forcing/antarctic_geothermal_heat_flow_model_aq1
     description: Geothermal heat flow model for Antarctica (AQ1) providing estimates of basal heat flux beneath the Antarctic ice sheet.
@@ -178,6 +191,7 @@ datasets:
 
   # ICE VELOCITY DATASETS
   measures_annual_antarctic_ice_velocity_maps:
+    doi: 10.000/ABCD
     path: /g/data/av17/access-nri/cryosphere-data-pool/ice_velocity/measures_annual_antarctic_ice_velocity_maps
     display_name: MEaSUREs Annual Antarctic Ice Velocity Maps
     description: Annual ice velocity maps for Antarctica from the MEaSUREs program, providing ice flow velocities at various resolutions.
@@ -188,6 +202,7 @@ datasets:
     loader: measures_velocity
 
   measures_insar_based_ice_velocity_maps_of_central_antarctica:
+    doi: 10.000/ABCD
     path: /g/data/av17/access-nri/cryosphere-data-pool/ice_velocity/measures_insar_based_ice_velocity_maps_of_central_antarctica
     display_name: InSAR-based Ice Velocity Maps of Central Antarctica
     description: Ice velocity maps for central Antarctica derived from Interferometric Synthetic Aperture Radar (InSAR) data.
@@ -199,6 +214,7 @@ datasets:
     loader: measures_velocity
 
   measures_insar_based_antarctica_ice_velocity_map:
+    doi: 10.000/ABCD
     path: /g/data/av17/access-nri/cryosphere-data-pool/ice_velocity/measures_insar_based_antarctica_ice_velocity_map
     display_name: InSAR-based Antarctica Ice Velocity Map
     description: High-resolution ice velocity map for Antarctica derived from Interferometric Synthetic Aperture Radar (InSAR) data.
@@ -209,6 +225,7 @@ datasets:
     extension: nc
 
   measures_insar_based_ice_velocity_of_the_amundsen_sea_embayment:
+    doi: 10.000/ABCD
     path: /g/data/av17/access-nri/cryosphere-data-pool/ice_velocity/measures_insar_based_ice_velocity_of_the_amundsen_sea_embayment
     display_name: InSAR-based Ice Velocity of the Amundsen Sea Embayment
     description: Ice velocity data for the Amundsen Sea Embayment region of Antarctica derived from Interferometric Synthetic Aperture Radar (InSAR) measurements.
@@ -219,6 +236,7 @@ datasets:
     extension: nc
 
   measures_phase_based_antarctica_ice_velocity_map:
+    doi: 10.000/ABCD
     path: /g/data/av17/access-nri/cryosphere-data-pool/ice_velocity/measures_phase_based_antarctica_ice_velocity_map
     display_name: Phase-based Antarctica Ice Velocity Map
     description: High-resolution ice velocity map for Antarctica derived from phase-based measurements.
@@ -228,6 +246,7 @@ datasets:
     extension: nc
 
   measures_its_live_regional_glacier_and_ice_sheet_surface_velocities:
+    doi: 10.000/ABCD
     path: /g/data/av17/access-nri/cryosphere-data-pool/ice_velocity/measures_its_live_regional_glacier_and_ice_sheet_surface_velocities
     display_name: ITS_LIVE Regional Glacier and Ice Sheet Surface Velocities
     description: ITS_LIVE regional glacier and ice sheet surface velocities for Antarctica and Greenland.
@@ -321,6 +340,7 @@ datasets:
 
   # SURFACE FORCING DATASETS
   racmo2.3p2_monthly_27km_1979-2022:
+    doi: 10.000/ABCD
     path: /g/data/av17/access-nri/cryosphere-data-pool/surface_forcing/racmo2.3p2_monthly_27km_1979-2022
     display_name: RACMO2.3p2 Monthly Surface Mass Balance and Climate Data at 27 km Resolution (1979-2022)
     description: Regional Atmospheric Climate Model (RACMO) version 2.3p2 monthly surface mass balance and climate data for Antarctica at 27 km resolution, covering the years 1979 to 2022.
@@ -330,6 +350,7 @@ datasets:
       - climate data
       - racmo
     extension: nc
+
     loader: racmo
     ignore_files:
     # Ignore static mask files that do not integrate with variable files well
@@ -338,6 +359,7 @@ datasets:
         - TotIS_RACMO_ANT27_IMBIE2.nc
 
   racmo2.4p1_monthly_11km_1979-2023:
+    doi: 10.000/ABCD
     path: /g/data/av17/access-nri/cryosphere-data-pool/surface_forcing/racmo2.4p1_monthly_11km_1979-2023
     display_name: RACMO2.4p1 Monthly Surface Mass Balance and Climate Data at 11 km Resolution (1979-2023)
     description: Regional Atmospheric Climate Model (RACMO) version 2.4p1 monthly surface mass balance and climate data for Antarctica at 11 km resolution, covering the years 1979 to 2023.