Add category conversion

primap2/_aggregate.py

@@ -33,16 +33,15 @@ def select_no_scalar_dimension(
     """
     if sel is None:
         return obj
-    else:
-        sele: DatasetOrDataArray = obj.loc[sel]
-        if dim_names(obj) != dim_names(sele):
-            raise ValueError(
-                "The dimension of the selection doesn't match the dimension of the "
-                "orginal dataset. Likely you used a selection casting to a scalar "
-                "dimension, like sel={'axis': 'value'}. Please use "
-                "sel={'axis': ['value']} instead."
-            )
-        return sele
+    selection: DatasetOrDataArray = obj.loc[sel]
+    if dim_names(obj) != dim_names(selection):
+        raise ValueError(
+            "The dimension of the selection doesn't match the dimension of the "
+            "orginal dataset. Likely you used a selection casting to a scalar "
+            "dimension, like sel={'axis': 'value'}. Please use "
+            "sel={'axis': ['value']} instead."
+        )
+    return selection
 
 
 class DataArrayAggregationAccessor(BaseDataArrayAccessor):
@@ -52,11 +51,10 @@ def _reduce_dim(
         if dim is not None and reduce_to_dim is not None:
             raise ValueError("Only one of 'dim' and 'reduce_to_dim' may be supplied, not both.")
 
-        if dim is None:
-            if reduce_to_dim is not None:
-                if isinstance(reduce_to_dim, str):
-                    reduce_to_dim = [reduce_to_dim]
-                dim = set(self._da.dims) - set(reduce_to_dim)
+        if dim is None and reduce_to_dim is not None:
+            if isinstance(reduce_to_dim, str):
+                reduce_to_dim = [reduce_to_dim]
+            dim = set(self._da.dims) - set(reduce_to_dim)
 
         return dim
 

primap2/_downscale.py

@@ -41,21 +41,21 @@ def downscale_timeseries(
         ----------
         dim: str
           The name of the dimension which contains the basket and its contents, has to
-          be one of the dimensions in ``ds.dims``.
+          be one of the dimensions in ``da.dims``.
         basket: str
           The name of the super-category for which values are known at higher temporal
-          resolution and/or for a wider range. A value from ``ds[dimension]``.
+          resolution and/or for a wider range. A value from ``da[dimension]``.
         basket_contents: list of str
           The name of the sub-categories. The sum of all sub-categories equals the
-          basket. Values from ``ds[dimension]``.
+          basket. Values from ``da[dimension]``.
         check_consistency: bool, default True
           If for all points where the basket and all basket_contents are defined,
           it should be checked if the sum of the basket_contents actually equals
           the basket. A ``ValueError`` is raised if the consistency check fails.
         sel: Selection dict, optional
           If the downscaling should only be done on a subset of the Dataset while
           retaining all other values unchanged, give a selection dictionary. The
-          downscaling will be done on ``ds.loc[sel]``.
+          downscaling will be done on ``da.loc[sel]``.
         skipna_evaluation_dims: list of str, optional
           Dimensions which should be evaluated to determine if NA values should be
           skipped entirely if missing fully. By default, no NA values are skipped.

primap2/_selection.py

@@ -53,7 +53,22 @@ def resolve_not(
 
 
 def translate(item: KeyT, translations: typing.Mapping[typing.Hashable, str]) -> KeyT:
-    """Translate primap2 short names into xarray names."""
+    """Translates a single str key or the keys of a dict using the given translations.
+
+    If a key is not found in the translations, return it untranslated.
+
+    Parameters
+    ----------
+    item : str or dict with str keys
+        The input to translate. Either a str or a dict with str keys.
+    translations : dict
+        The translations to apply.
+
+    Returns
+    -------
+    translated : str or dict with str keys
+        The same type as the input item, but translated.
+    """
     if isinstance(item, str):
         if item in translations:
             return translations[item]

primap2/accessors.py

@@ -3,6 +3,7 @@
 import xarray as xr
 
 from ._aggregate import DataArrayAggregationAccessor, DatasetAggregationAccessor
+from ._convert import DataArrayConversionAccessor
 from ._data_format import DatasetDataFormatAccessor
 from ._downscale import DataArrayDownscalingAccessor, DatasetDownscalingAccessor
 from ._fill_combine import DataArrayFillAccessor, DatasetFillAccessor
@@ -37,6 +38,7 @@ class PRIMAP2DatasetAccessor(
 class PRIMAP2DataArrayAccessor(
     DataArrayAggregationAccessor,
     DataArrayAliasSelectionAccessor,
+    DataArrayConversionAccessor,
     DataArrayDownscalingAccessor,
     DataArrayMergeAccessor,
     DataArrayOverviewAccessor,

primap2/tests/data/BURDI_conversion.csv

@@ -0,0 +1,40 @@
+# references: non_annex1_data repo
+# last_update: 2024-10-14
+BURDI,IPCC2006_PRIMAP,comment
+1,1
+1.A,1.A
+1.A.1,1.A.1
+1.A.2,1.A.2
+1.A.3,1.A.3
+1.A.4,1.A.4
+1.A.5,1.A.5
+1.B,1.B
+1.B.1,1.B.1
+1.B.2,1.B.2
+2 + 3,2
+2.A,2.A
+2.B + 2.E,2.B
+2.C,2.C
+2.F,2.F
+2.G + 2.D, 2.H
+3,2.D
+4,M.AG
+4.A,3.A.1
+4.B,3.A.2
+4.C,3.C.7
+4.D + 4.C + 4.E + 4.F + 4.G,3.C
+4.E,3.C.1.c
+4.F,3.C.1.b
+4.G,3.C.8
+5,M.LULUCF
+6,4
+6.A,4.A
+6.B,4.D
+6.C,4.C
+6.D,4.E
+24540,0
+15163,M.0.EL
+14637,M.BK
+14424,M.BK.A
+14423,M.BK.M, leaving 14638 --> M.BIO out for now, as it's not in climate categories
+7,5, 5.A-D ignored as not fitting 2006 cats

primap2/tests/data/simple_categorisation_a.yaml

@@ -0,0 +1,35 @@
+name: A
+title: Simple Categorization
+comment: A simple example categorization without relationships between categories
+references: doi:00000/00000
+institution: PIK
+last_update: 2021-02-23
+hierarchical: no
+version: 1
+categories:
+  1:
+    title: Category 1
+    comment: The first category
+    alternative_codes:
+      - A
+      - CatA
+    info:
+      important_data:
+        - A
+        - B
+        - C
+      other_important_thing: ABC
+  2:
+    title: Category 2
+    comment: The second category
+    alternative_codes:
+      - B
+      - CatB
+  3:
+    title: Category 3
+    comment: The third category
+    alternative_codes:
+      - C
+      - CatC
+  unnumbered:
+    title: The unnumbered category

primap2/tests/data/simple_categorisation_b.yaml

@@ -0,0 +1,27 @@
+name: B
+title: Simple Categorization
+comment: A simple example categorization without relationships between categories
+references: doi:00000/00000
+institution: PIK
+last_update: 2021-02-23
+hierarchical: no
+version: 1
+categories:
+  1:
+    title: Category 1
+    comment: The first category
+    alternative_codes:
+      - A
+      - CatA
+    info:
+      important_data:
+        - A
+        - B
+        - C
+      other_important_thing: ABC
+  2:
+    title: Category 2
+    comment: The second category
+    alternative_codes:
+      - B
+      - CatB

primap2/tests/data/simple_conversion.csv

@@ -0,0 +1,5 @@
+# references: test
+# last_update: 2024-10-14
+A,B,comment
+1,1, no comment
+2+3,2