dggrid4py 0.5.1.dev0__tar.gz → 0.5.3__tar.gz

{dggrid4py-0.5.1.dev0 → dggrid4py-0.5.3}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: dggrid4py
-Version: 0.5.1.dev0
+Version: 0.5.3
 Summary: a Python library to run highlevel functions of DGGRIDv7 and v8
 License-Expression: AGPL-3.0-or-later
 License-File: LICENSE
 Keywords: python,GIS,DGGS,DGGRID,hexagons,grids,spatial statistics,IGEO7
 Author: Alexander Kmoch
 Author-email: alexander.kmoch@ut.ee
-Requires-Python: >=3.9, <4.0.0
+Requires-Python: >=3.10, <4.0.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Education
@@ -20,11 +20,12 @@ Classifier: Operating System :: Unix
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Topic :: Scientific/Engineering :: GIS
 Requires-Dist: fiona (>=1.8.0,<2.0.0)
-Requires-Dist: geopandas (>=0.9.0,<=1.1.0)
-Requires-Dist: numpy (>=1.22.0,<=2.3.0)
-Requires-Dist: pandas (>=1.4.0,<2.4.0)
-Requires-Dist: pygeodesy (==25.10.10)
-Requires-Dist: shapely (>=1.8.0,<=2.1.0)
+Requires-Dist: geopandas (>=0.9.0,<2.0.0)
+Requires-Dist: numpy (>=1.22.0,<3.0.0)
+Requires-Dist: pandas (>=1.4.0,<3.0.0)
+Requires-Dist: pygeodesy (>=25.10.10,<26.0.0)
+Requires-Dist: pyogrio (>=0.11.1,<0.12.0)
+Requires-Dist: shapely (>=1.8.0,<3.0.0)
 Description-Content-Type: text/markdown
 
 # dggrid4py - a Python library to run highlevel functions of DGGRID

{dggrid4py-0.5.1.dev0 → dggrid4py-0.5.3}/dggrid4py/__init__.py

@@ -13,4 +13,4 @@ import dggrid4py.igeo7 as igeo7
 import dggrid4py.tool as tool
 from .auxlat import geoseries_to_authalic, geoseries_to_geodetic, geodetic_to_authalic, authalic_to_geodetic
 
-__version__ = "0.5.1-dev"
+__version__ = "0.5.3"

{dggrid4py-0.5.1.dev0 → dggrid4py-0.5.3}/dggrid4py/dggrid_runner.py

@@ -189,7 +189,7 @@ DggsOutputCellLabelTypeT = DggsOutputCellLabelTypeV7T | DggsOutputCellLabelTypeV
 DggsCellOutputControlT = Literal["OUTPUT_ALL", "OUTPUT_OCCUPIED"]
 cell_output_controls = get_args(DggsCellOutputControlT)
 
-DggsInputAddressTypeT = Literal[
+DggsInputAddressTypeV7T = Literal[
     'GEO', # geodetic coordinates -123.36 43.22 20300 Roseburg
     'Q2DI', # quad number and (i, j) coordinates on that quad
     'SEQNUM', # DGGS index - linear address (1 to size-of-DGG), not supported for parameter input_address_type if dggs_aperture_type is SEQUENCE
@@ -204,7 +204,36 @@ DggsInputAddressTypeT = Literal[
     'ZORDER', # index system ZORDER especially useful for ISEA3H, ISEA4H and mixed aperture
     'ZORDER_STRING'  # numerical digits representation of ZORDER (as characters, not an integer)
 ]
-input_address_types = get_args(DggsInputAddressTypeT)
+input_address_types_v7 = get_args(DggsInputAddressTypeV7T)
+
+DggsInputAddressTypeV8T = Literal[
+    'GEO', # geodetic coordinates -123.36 43.22 20300 Roseburg
+    'Q2DI', # quad number and (i, j) coordinates on that quad
+    'SEQNUM', # DGGS index - linear address (1 to size-of-DGG), not supported for parameter input_address_type if dggs_aperture_type is SEQUENCE
+    'INTERLEAVE', # digit-interleaved form of Q2DI, only supported for parameter output_address_type; only available for hexagonal aperture 3 and 4 grids
+    'PLANE', # (x, y) coordinates on unfolded ISEA plane,  only supported for parameter output_address_type;
+    'Q2DD', # quad number and (x, y) coordinates on that quad
+    'PROJTRI', # PROJTRI - triangle number and (x, y) coordinates within that triangle on the ISEA plane
+    'VERTEX2DD', # vertex number, triangle number, and (x, y) coordinates on ISEA plane
+    'AIGEN',  # Arc/Info Generate file format
+    'HIERNDX',
+]
+input_address_types_v8 = get_args(DggsInputAddressTypeV8T)
+
+DggsInputAddressTypeT = DggsInputAddressTypeV7T | DggsInputAddressTypeV8T
+
+input_extra_fields_v7 = {}
+
+DggsInputHierNdxSystemT = Literal['Z3', 'Z7', 'ZORDER']
+input_hier_ndx_systems = get_args(DggsInputHierNdxSystemT)
+
+DggsInputHierNdxFormT = Literal['INT64', 'DIGIT_STRING']
+input_hier_ndx_forms = get_args(DggsInputHierNdxFormT)
+
+input_extra_fields_v8 = {
+    'input_hier_ndx_system': input_hier_ndx_systems,
+    'input_hier_ndx_form': input_hier_ndx_forms,
+}
 
 ### CUSTOM args
 DggsProjectionT = Literal["ISEA", "FULLER"]
@@ -270,8 +299,11 @@ DggridMetaConfigT = TypedDict(
         "clip_cell_res": int,
         "clip_cell_addresses": str,
         "clip_region_files": str,
+        "clip_cell_densification": int,
         "clipper_scale_factor": float,
         "input_address_type": DggsInputAddressTypeT,
+        "input_hier_ndx_form": DggsInputHierNdxFormT,
+        "input_hier_ndx_system": DggsInputHierNdxSystemT,
         "input_delimiter": str,
         "input_file_name": str,
         "input_files": str,
@@ -298,6 +330,7 @@ DggridMetaConfigT = TypedDict(
         "output_cell_label_type": DggsOutputCellLabelTypeT,
         "output_count": bool,
         "output_count_field_name": str,
+        "output_num_classes": bool,
         "output_delimiter": str,
         "output_file_name": str,
         "output_first_seqnum": int,
@@ -332,6 +365,13 @@ def __getattr__(name):  # for backward compatibility helper/warning
             DeprecationWarning
         )
         return output_address_types_v7
+    if name == 'input_address_types':
+        warnings.warn(
+            "Definitions 'input_address_types' has been deprecated. "
+            "Use the 'DGGRID.input_address_types' of desired version!",
+            DeprecationWarning
+        )
+        return output_address_types_v7
     raise AttributeError(f"module {__name__} has no attribute {name}")
 
 
@@ -513,11 +553,18 @@ class Dggs:
         'dggs_vert0_lat': 'pole_lat_deg',
         'dggs_vert0_lon': 'pole_lon_deg',
         'dggs_num_aperture_4_res': 'mixed_aperture_level',
+        'res': 'resolution',
         # Add more aliases as needed
     }, init=False, repr=False)
 
-    def _resolve_key(self, key: str) -> str:
+    def _resolve_key(self, key: str, strict: bool = False) -> str | None:
         # If key is an alias, return canonical; else if it's a canonical, return as is
+        if strict:
+            if key in self._aliases:
+                return self._aliases[key]
+            elif key in self.__dataclass_fields__:
+                return key
+            return None
         return self._aliases.get(key, key)
 
     def set_par(self, par_key: str, par_value: DggridMetaConfigParameterT):
@@ -550,6 +597,19 @@ class Dggs:
     def metafile(self) -> DggridMetafileT:
         return copy.copy(dg_grid_meta(self))
 
+    def update(self, strict=False, **kwargs):
+        """
+        Back propagate keyword parameters if they can be mapped to an attribute handled by this class.
+
+        :param strict:
+            If True, only keys that match existing attributes will be set.
+            If False, unknown keys will be set with provided name.
+        """
+        for key, value in kwargs.items():
+            found = self._resolve_key(key, strict=strict)
+            if found:
+                self.set_par(found, value)
+
     def dg_closest_res_to_area (self, area, resround,metric,show_info=True):
         raise ValueError('not yet implemented')
 
@@ -603,6 +663,16 @@ class DGGRID(abc.ABC):
     def output_extra_fields(self) -> dict[str, Iterable[DggridMetaConfigParameterT]]:
         raise NotImplementedError
 
+    @property
+    @abc.abstractmethod
+    def input_address_types(self) -> Iterable[DggsInputAddressTypeT]:
+        raise NotImplementedError
+
+    @property
+    @abc.abstractmethod
+    def input_extra_fields(self) -> dict[str, Iterable[DggridMetaConfigParameterT]]:
+        raise NotImplementedError
+
     def check_output_extra_fields(
         self,
         output_conf: DggridMetaConfigT | dict[str, DggridMetaConfigParameterT],
@@ -616,6 +686,19 @@ class DGGRID(abc.ABC):
                 output_conf_extra[conf] = out
         return output_conf_extra
 
+    def check_input_extra_fields(
+        self,
+        input_conf: DggridMetaConfigT | dict[str, DggridMetaConfigParameterT],
+    ) -> DggridMetaConfigT:
+        input_conf_extra: DggridMetaConfigT = {}
+        for conf, allowed in self.input_extra_fields.items():
+            if conf in input_conf:
+                _in = input_conf[conf]
+                if _in not in allowed:
+                    raise ValueError(f"input_conf '{conf}' has invalid value '{_in}'. Allowed are {allowed}")
+                input_conf_extra[conf] = _in
+        return input_conf_extra
+
     def check_gdal_support(self):
         if self.has_gdal:
             print(f"GDAL types should be possible: has GDAL={self.has_gdal}")
@@ -728,6 +811,7 @@ class DGGRID(abc.ABC):
         metafile = []
         metafile.append("dggrid_operation " + dggrid_operation)
 
+        dggs.update(**subset_conf, **output_conf)
         dggs_config_meta = dggs.metafile
 
         for cmd in dggs_config_meta:
@@ -771,8 +855,11 @@ class DGGRID(abc.ABC):
         else:
             raise ValueError('something is not correct in subset_conf')
 
-        if 'input_address_type' in subset_conf.keys() and subset_conf.get('input_address_type', 'NOPE') in input_address_types:
+        if 'input_address_type' in subset_conf.keys() and subset_conf.get('input_address_type', 'NOPE') in self.input_address_types:
             metafile.append("input_address_type " + subset_conf['input_address_type'])
+            for elem in self.input_extra_fields:
+                if elem in subset_conf:
+                    metafile.append(f"{elem} {subset_conf[elem]}")
 
         # join grid gen params add to metafile
 
@@ -867,7 +954,7 @@ class DGGRID(abc.ABC):
         self,
         dggs: Dggs,
         subset_conf: DggridMetaConfigT,
-        **output_conf_extra: DggridMetaConfigParameterT,
+        **conf_extra: DggridMetaConfigParameterT,
     ) -> DggridApiOutputT:
         """
         Address Conversion. Transform a file of locations from one address form (such as longitude/latitude) to another (such as DGG cell indexes).
@@ -885,7 +972,7 @@ class DGGRID(abc.ABC):
         if (
             'input_file_name' in subset_conf.keys() and
             'input_address_type' in subset_conf.keys() and
-            subset_conf['input_address_type'] in input_address_types
+            subset_conf['input_address_type'] in self.input_address_types
         ):
             for elem in filter(lambda x: x.startswith('input_') , subset_conf.keys()):
                 metafile.append(f"{elem} " + str(subset_conf[elem]))
@@ -893,24 +980,33 @@ class DGGRID(abc.ABC):
             raise ValueError('no input filename or type given')
 
         # join grid gen params add to metafile
-        subset_conf.update(specify_resolution(**output_conf_extra))
-        subset_conf.update(specify_orient_type_args(**output_conf_extra))
-        subset_conf.update(specify_topo_aperture(**output_conf_extra))
+        subset_conf.update(specify_resolution(**conf_extra))
+        subset_conf.update(specify_orient_type_args(**conf_extra))
+        subset_conf.update(specify_topo_aperture(**conf_extra))
+
+        input_extras = self.check_input_extra_fields(conf_extra)
+        subset_conf.update(input_extras)
+        if subset_conf:
+            for elem, value in subset_conf.items():
+                metafile.append(f"{elem} " + str(value))
 
         # transform output_types
+        output_conf = {}
         if (
-            'output_file_name' in output_conf.keys() and
-            'output_address_type' in output_conf.keys() and
-            output_conf['output_address_type'] in self.output_address_types
+            'output_file_name' in conf_extra.keys() and
+            'output_address_type' in conf_extra.keys() and
+            conf_extra['output_address_type'] in self.output_address_types
         ):
-            for elem in filter(lambda x: x.startswith('output_') , output_conf.keys()):
-                metafile.append(f"{elem} " + str(output_conf[elem]))
+            for elem in filter(lambda x: x.startswith('output_') , conf_extra.keys()):
+                output_conf[elem] = conf_extra[elem]
+                metafile.append(f"{elem} " + str(conf_extra[elem]))
         else:
             raise ValueError('no output filename or type given')
 
-        output_extras = self.check_output_extra_fields(output_conf_extra)
+        output_extras = self.check_output_extra_fields(conf_extra)
         if output_extras:
             for elem, value in output_extras.items():
+                output_conf[elem] = value
                 metafile.append(f"{elem} " + str(value))
 
         result = self.run(metafile)
@@ -930,7 +1026,7 @@ class DGGRID(abc.ABC):
         self,
         dggs: Dggs,
         subset_conf: DggridMetaConfigT,
-        **output_conf_extra: DggridMetaConfigParameterT,
+        **conf_extra: DggridMetaConfigParameterT,
     ) -> DggridApiOutputT:
         """
         Point Value Binning. Bin a set of floating-point values associated with point locations into the cells of a DGG,
@@ -972,7 +1068,7 @@ class DGGRID(abc.ABC):
         if (
             'input_file_name' in subset_conf.keys() and
             'input_address_type' in subset_conf.keys() and
-            subset_conf['input_address_type'] in input_address_types
+            subset_conf['input_address_type'] in self.input_address_types
         ):
             for elem in filter(lambda x: x.startswith('input_') , subset_conf.keys()):
                 metafile.append(f"{elem} " + subset_conf[elem])
@@ -980,24 +1076,33 @@ class DGGRID(abc.ABC):
             raise ValueError('no input filename or type given')
 
         # join grid gen params add to metafile
-        subset_conf.update(specify_resolution(**output_conf_extra))
-        subset_conf.update(specify_orient_type_args(**output_conf_extra))
-        subset_conf.update(specify_topo_aperture(**output_conf_extra))
+        subset_conf.update(specify_resolution(**conf_extra))
+        subset_conf.update(specify_orient_type_args(**conf_extra))
+        subset_conf.update(specify_topo_aperture(**conf_extra))
+
+        input_extras = self.check_input_extra_fields(conf_extra)
+        subset_conf.update(input_extras)
+        if subset_conf:
+            for elem, value in subset_conf.items():
+                metafile.append(f"{elem} " + str(value))
 
         # transform output_types
+        output_conf = {}
         if (
-            'output_file_name' in output_conf.keys() and
-            'output_address_type' in output_conf.keys() and
-            output_conf['output_address_type'] in self.output_address_types
+            'output_file_name' in conf_extra.keys() and
+            'output_address_type' in conf_extra.keys() and
+            conf_extra['output_address_type'] in self.output_address_types
         ):
-            for elem in filter(lambda x: x.startswith('output_') , output_conf.keys()):
-                metafile.append(f"{elem} " + output_conf[elem])
+            for elem in filter(lambda x: x.startswith('output_') , conf_extra.keys()):
+                output_conf[elem] = conf_extra[elem]
+                metafile.append(f"{elem} " + conf_extra[elem])
         else:
             raise ValueError('no output filename or type given')
 
-        output_extras = self.check_output_extra_fields(output_conf_extra)
+        output_extras = self.check_output_extra_fields(conf_extra)
         if output_extras:
             for elem, value in output_extras.items():
+                output_conf[elem] = conf_extra[elem]
                 metafile.append(f"{elem} " + str(value))
 
         result = self.run(metafile)
@@ -1017,7 +1122,7 @@ class DGGRID(abc.ABC):
         self,
         dggs: Dggs,
         subset_conf: DggridMetaConfigT,
-        **output_conf_extra: DggridMetaConfigParameterT,
+        **conf_extra: DggridMetaConfigParameterT,
     ) -> DggridApiOutputT:
         """
         Presence/Absence Binning. Given a set of input files, each containing point locations associated with a particular class, DGGRID outputs,
@@ -1036,7 +1141,7 @@ class DGGRID(abc.ABC):
         if (
             'input_file_name' in subset_conf.keys() and
             'input_address_type' in subset_conf.keys() and
-            subset_conf['input_address_type'] in input_address_types
+            subset_conf['input_address_type'] in self.input_address_types
         ):
             for elem in filter(lambda x: x.startswith('input_') , subset_conf.keys()):
                 metafile.append(f"{elem} " + subset_conf[elem])
@@ -1044,25 +1149,45 @@ class DGGRID(abc.ABC):
             raise ValueError('no input filename or type given')
 
         # join grid gen params add to metafile
-        subset_conf.update(specify_resolution(**output_conf_extra))
-        subset_conf.update(specify_orient_type_args(**output_conf_extra))
-        subset_conf.update(specify_topo_aperture(**output_conf_extra))
+        subset_conf.update(specify_resolution(**conf_extra))
+        subset_conf.update(specify_orient_type_args(**conf_extra))
+        subset_conf.update(specify_topo_aperture(**conf_extra))
+
+        input_extras = self.check_input_extra_fields(conf_extra)
+        subset_conf.update(input_extras)
+        if subset_conf:
+            for elem, value in subset_conf.items():
+                metafile.append(f"{elem} " + str(value))
+
+        # pre-patch elements before integrating them to the metafile
+        if "output_delimiter" in conf_extra:
+            delim = conf_extra["output_delimiter"] or " "
+            delim = f'"{delim}"' if '"' not in delim else delim
+            conf_extra["output_delimiter"] = delim
+        if "cell_output_control" in conf_extra and conf_extra["cell_output_control"] not in cell_output_controls:
+            raise ValueError(f"cell_output_control must be one of: {cell_output_controls}")
+        for field in ["output_count", "output_num_classes"]:
+            if field in conf_extra:
+                conf_extra[field] = str(conf_extra[field]).upper()  # bool or string-like bool
 
         # transform output_types
+        output_conf = {}
         if (
-            'output_file_name' in output_conf.keys() and
-            'output_address_type' in output_conf.keys() and
-            output_conf['output_address_type'] in self.output_address_types
+            'output_file_name' in conf_extra.keys() and
+            'output_address_type' in conf_extra.keys() and
+            conf_extra['output_address_type'] in self.output_address_types
         ):
-            for elem in filter(lambda x: x.startswith('output_') , output_conf.keys()):
-                metafile.append(f"{elem} " + output_conf[elem])
+            for elem in filter(lambda x: x.startswith('output_') or x.startswith('cell_output_'), conf_extra.keys()):
+                output_conf[elem] = conf_extra[elem]
+                metafile.append(f"{elem} " + conf_extra[elem])
         else:
             raise ValueError('no output filename or type given')
 
-        output_extras = self.check_output_extra_fields(output_conf_extra)
+        output_extras = self.check_output_extra_fields(conf_extra)
         if output_extras:
             for elem, value in output_extras.items():
-                metafile.append(f"{elem} " + str(value))
+                output_conf[elem] = conf_extra[elem]
+                metafile.append(f"{elem} {value!s}")
 
         result = self.run(metafile)
 
@@ -1184,7 +1309,7 @@ class DGGRID(abc.ABC):
         clip_geom: "AnyGeometry" = None,
         split_dateline: bool = False,
         output_address_type: DggsOutputAddressTypeT | None = None,
-        **output_conf_extra: DggridMetaConfigParameterT,
+        **conf_extra: DggridMetaConfigParameterT,
     ) -> gpd.GeoDataFrame:
         """
         generates a DGGS grid and returns all the cells as GeoDataFrame with geometry type Polygon
@@ -1194,6 +1319,7 @@ class DGGRID(abc.ABC):
         tmp_id = uuid.uuid4()
         tmp_dir = self.working_dir
         dggs = dgselect(dggs_type = dggs_type, res= resolution, mixed_aperture_level=mixed_aperture_level)
+        dggs.update(**conf_extra, strict=True)
 
         subset_conf: DggridMetaConfigT = { 'update_frequency': 100000, 'clip_subset_type': 'WHOLE_EARTH' }
 
@@ -1213,11 +1339,14 @@ class DGGRID(abc.ABC):
                     'clip_subset_type': cast(DggsClipSubsetTypeT, self.tmp_geo_out['legacy_driver'].upper())
                 })
 
-        subset_conf.update(specify_resolution(**output_conf_extra))
-        subset_conf.update(specify_orient_type_args(**output_conf_extra))
-        subset_conf.update(specify_topo_aperture(**output_conf_extra))
+        subset_conf.update(specify_resolution(**conf_extra))
+        subset_conf.update(specify_orient_type_args(**conf_extra))
+        subset_conf.update(specify_topo_aperture(**conf_extra))
+
+        input_extras = self.check_input_extra_fields(conf_extra)
+        subset_conf.update(input_extras)
 
-        output_extras = self.check_output_extra_fields(output_conf_extra)
+        output_extras = self.check_output_extra_fields(conf_extra)
         output_conf: DggridMetaConfigT = {
             'cell_output_type': 'GDAL',
             'point_output_type': 'NONE',
@@ -1278,7 +1407,7 @@ class DGGRID(abc.ABC):
         mixed_aperture_level: int = None,
         clip_geom: "AnyGeometry" = None,
         output_address_type: DggsOutputAddressTypeT | None = None,
-        **output_conf_extra: DggridMetaConfigParameterT,
+        **conf_extra: DggridMetaConfigParameterT,
     ) -> gpd.GeoDataFrame:
         """
         generates a DGGS grid and returns all the cell's centroid as GeoDataFrame with geometry type Point
@@ -1288,6 +1417,7 @@ class DGGRID(abc.ABC):
         tmp_id = uuid.uuid4()
         tmp_dir = self.working_dir
         dggs = dgselect(dggs_type = dggs_type, res= resolution, mixed_aperture_level=mixed_aperture_level)
+        dggs.update(**conf_extra, strict=True)
 
         subset_conf: DggridMetaConfigT = { 'update_frequency': 100000, 'clip_subset_type': 'WHOLE_EARTH' }
 
@@ -1307,11 +1437,14 @@ class DGGRID(abc.ABC):
                     'clip_subset_type': cast(DggsClipSubsetTypeT, self.tmp_geo_out['legacy_driver'].upper())
                 })
 
-        subset_conf.update(specify_resolution(**output_conf_extra))
-        subset_conf.update(specify_orient_type_args(**output_conf_extra))
-        subset_conf.update(specify_topo_aperture(**output_conf_extra))
+        subset_conf.update(specify_resolution(**conf_extra))
+        subset_conf.update(specify_orient_type_args(**conf_extra))
+        subset_conf.update(specify_topo_aperture(**conf_extra))
+
+        input_extras = self.check_input_extra_fields(conf_extra)
+        subset_conf.update(input_extras)
 
-        output_extras = self.check_output_extra_fields(output_conf_extra)
+        output_extras = self.check_output_extra_fields(conf_extra)
         output_conf: DggridMetaConfigT = {
             'point_output_type': 'GDAL',
             'cell_output_type': 'NONE',
@@ -1373,7 +1506,7 @@ class DGGRID(abc.ABC):
         clip_cell_res: int = 1,
         input_address_type: DggsInputAddressTypeT = 'SEQNUM',
         output_address_type: DggsOutputAddressTypeT = 'SEQNUM',
-        **output_conf_extra: DggridMetaConfigParameterT,
+        **conf_extra: DggridMetaConfigParameterT,
     ) -> gpd.GeoDataFrame:
         """
         generates a DGGS grid and returns all the cells as GeoDataFrame with geometry type Polygon
@@ -1383,6 +1516,7 @@ class DGGRID(abc.ABC):
         tmp_id = uuid.uuid4()
         tmp_dir = self.working_dir
         dggs = dgselect(dggs_type = dggs_type, res= resolution, mixed_aperture_level=mixed_aperture_level)
+        dggs.update(**conf_extra, strict=True)
 
         subset_conf: DggridMetaConfigT = { 'update_frequency': 100000, 'clip_subset_type': clip_subset_type }
         seq_df = None
@@ -1400,8 +1534,8 @@ class DGGRID(abc.ABC):
             # TODO, for Z3, Z7, ZORDER can potentially also be COARSE_CELLS / aka parent cells?
             # clip_subset_type should INPUT_ADDRESS_TYPE for the equivalent of SEQNUM (tp use input_address_type Z3 ...), or COARSE_CELLS as an actual parent cell type clip (also for Z3 ..)
             if (
-                input_address_type in ['Z3', 'Z3_STRING', 'Z7', 'Z7_STRING', 'ZORDER', 'ZORDER_STRING']
-                and output_address_type in ['Z3', 'Z3_STRING', 'Z7', 'Z7_STRING', 'ZORDER', 'ZORDER_STRING']
+                input_address_type in self.input_address_types
+                and output_address_type in self.output_address_types
             ):
                 subset_conf.update(
                     {
@@ -1419,12 +1553,21 @@ class DGGRID(abc.ABC):
                             'clip_cell_addresses' : " ".join([str(address) for address in cell_id_list])
                         }
                     )
+                    if "clip_cell_densification" in conf_extra:
+                        subset_conf.update(
+                            {
+                                'clip_cell_densification' : conf_extra['clip_cell_densification']
+                            }
+                        )
 
-        subset_conf.update(specify_resolution(**output_conf_extra))
-        subset_conf.update(specify_orient_type_args(**output_conf_extra))
-        subset_conf.update(specify_topo_aperture(**output_conf_extra))
+        subset_conf.update(specify_resolution(**conf_extra))
+        subset_conf.update(specify_orient_type_args(**conf_extra))
+        subset_conf.update(specify_topo_aperture(**conf_extra))
 
-        output_extras = self.check_output_extra_fields(output_conf_extra)
+        input_extras = self.check_input_extra_fields(conf_extra)
+        subset_conf.update(input_extras)
+
+        output_extras = self.check_output_extra_fields(conf_extra)
         output_conf: DggridMetaConfigT = {
             'cell_output_type': 'GDAL',
             'point_output_type': 'NONE',
@@ -1510,7 +1653,7 @@ class DGGRID(abc.ABC):
         clip_cell_res: int = 1,
         input_address_type: DggsInputAddressTypeT = 'SEQNUM',
         output_address_type: DggsOutputAddressTypeT = 'SEQNUM',
-        **output_conf_extra: DggridMetaConfigParameterT,
+        **conf_extra: DggridMetaConfigParameterT,
     ):
         """
         generates a DGGS grid and returns all the cell's centroid as GeoDataFrame with geometry type Point
@@ -1520,6 +1663,7 @@ class DGGRID(abc.ABC):
         tmp_id = uuid.uuid4()
         tmp_dir = self.working_dir
         dggs = dgselect(dggs_type = dggs_type, res= resolution, mixed_aperture_level=mixed_aperture_level)
+        dggs.update(**conf_extra, strict=True)
 
         subset_conf: DggridMetaConfigT = { 'update_frequency': 100000, 'clip_subset_type': clip_subset_type }
         seq_df = None
@@ -1538,8 +1682,8 @@ class DGGRID(abc.ABC):
             # TODO, for Z3, Z7, ZORDER can potentially also be COARSE_CELLS / aka parent cells?
             # clip_subset_type should INPUT_ADDRESS_TYPE for the equivalent of SEQNUM (tp use input_address_type Z3 ...), or COARSE_CELLS as an actual parent cell type clip (also for Z3 ..)
             if (
-                input_address_type in ['Z3', 'Z3_STRING', 'Z7', 'Z7_STRING', 'ZORDER', 'ZORDER_STRING']
-                and output_address_type in ['Z3', 'Z3_STRING', 'Z7', 'Z7_STRING', 'ZORDER', 'ZORDER_STRING']
+                input_address_type in self.input_address_types
+                and output_address_type in self.output_address_types
             ):
                 subset_conf.update(
                     {
@@ -1558,11 +1702,13 @@ class DGGRID(abc.ABC):
                         }
                     )
 
-        subset_conf.update(specify_resolution(**output_conf_extra))
-        subset_conf.update(specify_orient_type_args(**output_conf_extra))
-        subset_conf.update(specify_topo_aperture(**output_conf_extra))
+        subset_conf.update(specify_resolution(**conf_extra))
+        subset_conf.update(specify_orient_type_args(**conf_extra))
+        subset_conf.update(specify_topo_aperture(**conf_extra))
 
-        output_extras = self.check_output_extra_fields(output_conf_extra)
+        input_extras = self.check_input_extra_fields(conf_extra)
+        subset_conf.update(input_extras)
+        output_extras = self.check_output_extra_fields(conf_extra)
         output_conf: DggridMetaConfigT = {
             'point_output_type': 'GDAL',
             'cell_output_type': 'NONE',
@@ -1633,7 +1779,7 @@ class DGGRID(abc.ABC):
         mixed_aperture_level: int = None,
         clip_geom: "AnyGeometry" = None,
         output_address_type: DggsOutputAddressTypeT | None = None,
-        **output_conf_extra: DggridMetaConfigParameterT,
+        **conf_extra: DggridMetaConfigParameterT,
     ) -> pd.DataFrame:
         """
         generates a DGGS grid and returns all the cellids as a pandas dataframe
@@ -1644,6 +1790,7 @@ class DGGRID(abc.ABC):
         tmp_id = uuid.uuid4()
         tmp_dir = self.working_dir
         dggs = dgselect(dggs_type = dggs_type, res= resolution, mixed_aperture_level=mixed_aperture_level)
+        dggs.update(**conf_extra, strict=True)
 
         subset_conf = { 'update_frequency': 100000, 'clip_subset_type': 'WHOLE_EARTH' }
 
@@ -1663,11 +1810,14 @@ class DGGRID(abc.ABC):
                     'clip_subset_type': cast(DggsClipSubsetTypeT, self.tmp_geo_out['legacy_driver'].upper())
                 })
 
-        subset_conf.update(specify_resolution(**output_conf_extra))
-        subset_conf.update(specify_orient_type_args(**output_conf_extra))
-        subset_conf.update(specify_topo_aperture(**output_conf_extra))
+        subset_conf.update(specify_resolution(**conf_extra))
+        subset_conf.update(specify_orient_type_args(**conf_extra))
+        subset_conf.update(specify_topo_aperture(**conf_extra))
+
+        input_extras = self.check_input_extra_fields(conf_extra)
+        subset_conf.update(input_extras)
 
-        output_extras = self.check_output_extra_fields(output_conf_extra)
+        output_extras = self.check_output_extra_fields(conf_extra)
         output_conf: DggridMetaConfigT = {
             'point_output_type': 'TEXT',
             'cell_output_type': 'NONE',
@@ -1715,7 +1865,7 @@ class DGGRID(abc.ABC):
         mixed_aperture_level: int = None,
         split_dateline: bool = False,
         output_address_type: DggsOutputAddressTypeT | None = None,
-        **output_conf_extra: DggridMetaConfigParameterT,
+        **conf_extra: DggridMetaConfigParameterT,
     ) -> gpd.GeoDataFrame:
         """
         takes a GeoDataFrame with point geometry and optional additional value columns and returns:
@@ -1725,9 +1875,10 @@ class DGGRID(abc.ABC):
         tmp_id = uuid.uuid4()
         tmp_dir = self.working_dir
         dggs = dgselect(dggs_type = dggs_type, res= resolution, mixed_aperture_level=mixed_aperture_level)
+        dggs.update(**conf_extra, strict=True)
 
         cols = set(geodf_points_wgs84.columns.tolist())
-        cols = cols - set('geometry')
+        cols = cols - {'geometry'}
         geodf_points_wgs84['lon'] = geodf_points_wgs84['geometry'].x
         geodf_points_wgs84['lat'] = geodf_points_wgs84['geometry'].y
         cols_ordered = ['lon', 'lat']
@@ -1741,11 +1892,14 @@ class DGGRID(abc.ABC):
             'input_address_type': 'GEO',
             'input_delimiter': "\" \""
         }
-        subset_conf.update(specify_resolution(**output_conf_extra))
-        subset_conf.update(specify_orient_type_args(**output_conf_extra))
-        subset_conf.update(specify_topo_aperture(**output_conf_extra))
+        subset_conf.update(specify_resolution(**conf_extra))
+        subset_conf.update(specify_orient_type_args(**conf_extra))
+        subset_conf.update(specify_topo_aperture(**conf_extra))
+
+        input_extras = self.check_input_extra_fields(conf_extra)
+        subset_conf.update(input_extras)
 
-        output_extras = self.check_output_extra_fields(output_conf_extra)
+        output_extras = self.check_output_extra_fields(conf_extra)
         output_conf = {
             'output_file_name': str( (Path(tmp_dir) / f"{output_address_type}_{tmp_id}.txt").resolve()),
             'output_address_type': 'SEQNUM',
@@ -1781,15 +1935,19 @@ class DGGRID(abc.ABC):
             return geodf_points_wgs84
         else:
             # grid_gen from seqnums
+            dggs_conf = dggs.to_dict()
             gdf = self.grid_cell_polygons_from_cellids(
                 cell_id_list=cell_id_list,
-                dggs_type=dggs_type,
+                # dggs_type=dggs_type,  passed via dggs_conf
                 resolution=resolution,
                 mixed_aperture_level=mixed_aperture_level,
                 input_address_type=output_address_type,
-                output_address_type=self.output_address_types,
+                output_address_type=output_address_type,
+                **dggs_conf,  # ensure any extra parameters are passed on
             )
             try:
+                # avoid conflict between input 'name' column and generated 'name' Zone ID
+                gdf.rename(columns={'name': 'zone'}, inplace=True)
                 for col in cols_ordered:
                     gdf[col] = geodf_points_wgs84[col].values
             except Exception:
@@ -1809,7 +1967,7 @@ class DGGRID(abc.ABC):
         mixed_aperture_level: int = None,
         input_address_type: DggsInputAddressTypeT = 'SEQNUM',
         output_address_type: DggsOutputAddressTypeT = 'SEQNUM',
-        **output_conf_extra: DggridMetaConfigParameterT,
+        **conf_extra: DggridMetaConfigParameterT,
     ) -> pd.DataFrame:
         """
             generates the DGGS for the input cell_ids and returns all the transformed cell_ids
@@ -1818,11 +1976,12 @@ class DGGRID(abc.ABC):
         tmp_id = uuid.uuid4()
         tmp_dir = self.working_dir
         dggs = dgselect(dggs_type = dggs_type, res= resolution, mixed_aperture_level=mixed_aperture_level)
+        dggs.update(**conf_extra, strict=True)
 
         if cell_id_list is None or len(cell_id_list) <= 0:
             raise ValueError("Expecting cell_id_list to transform.")
 
-        if not input_address_type in input_address_types:
+        if not input_address_type in self.input_address_types:
             raise ValueError(f"unknown input_address_type: {input_address_type}")
 
         if not output_address_type in self.output_address_types:
@@ -1837,7 +1996,10 @@ class DGGRID(abc.ABC):
             'input_delimiter': "\" \""
         }
 
-        output_extras = self.check_output_extra_fields(output_conf_extra)
+        input_extras = self.check_input_extra_fields(conf_extra)
+        subset_conf.update(input_extras)
+
+        output_extras = self.check_output_extra_fields(conf_extra)
         output_conf: DggridMetaConfigT = {
             'output_file_name': str( (Path(tmp_dir) / f"temp_out_{output_address_type}_{tmp_id}.txt").resolve()),
             'output_address_type': output_address_type,
@@ -1867,12 +2029,24 @@ class DGGRIDv7(DGGRID):
     version = 7
     output_address_types: DggsOutputAddressTypeV7T = output_address_types_v7
     output_extra_fields = output_extra_fields_v7
+    input_address_types: DggsInputAddressTypeV7T = input_address_types_v7
+    input_extra_fields = input_extra_fields_v7
 
 
 class DGGRIDv8(DGGRID):
     version = 8
     output_address_types: DggsOutputAddressTypeV8T = output_address_types_v8
     output_extra_fields = output_extra_fields_v8
+    input_address_types: DggsInputAddressTypeV8T = input_address_types_v8
+    input_extra_fields = input_extra_fields_v8
+
+
+class AnyDGGRID(DGGRID):
+    version = 0
+    output_address_types: DggsOutputAddressTypeT = list(set(output_address_types_v7) | set(output_address_types_v8))
+    output_extra_fields = list(set(output_extra_fields_v7) | set(output_extra_fields_v8))
+    input_address_types: DggsInputAddressTypeT = list(set(input_address_types_v7) | set(input_address_types_v8))
+    input_extra_fields = list(set(input_extra_fields_v7) | set(input_extra_fields_v8))
 
 
 #############################################################
@@ -2029,7 +2203,7 @@ def specify_resolution(
     if dggs_proj is None or dggs_res_specify_type is None:
         return {}
 
-    if not proj_spec in list(dggs_projections) or not dggs_res_specify_type in dggs_res_specify_types:
+    if not dggs_proj in list(dggs_projections) or not dggs_res_specify_type in dggs_res_specify_types:
         raise ValueError("base projection (ISEA or FULLER) or resolution spec unknown")
 
     if dggs_res_specify_type == "SPECIFIED":

{dggrid4py-0.5.1.dev0 → dggrid4py-0.5.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dggrid4py"
-version = "0.5.1-dev"
+version = "0.5.3"
 description = "a Python library to run highlevel functions of DGGRIDv7 and v8"
 authors = [
   { name = "Alexander Kmoch", email = "alexander.kmoch@ut.ee" },
@@ -26,16 +26,18 @@ classifiers = [
   "Operating System :: POSIX :: Linux",
   "Topic :: Scientific/Engineering :: GIS"
 ]
-requires-python = ">=3.9, <4.0.0"
+requires-python = ">=3.10, <4.0.0"
 
 [tool.poetry.dependencies]
-python = ">=3.9, <4.0.0"
-numpy = ">=1.22.0, <=2.3.0"
-pandas = ">=1.4.0, <2.4.0"
+python = ">=3.10, <4.0.0"
+numpy = ">=1.22.0, <3.0.0"
+pandas = ">=1.4.0, <3.0.0"
 fiona = ">=1.8.0, <2.0.0"
-shapely = ">=1.8.0, <=2.1.0"
-geopandas = ">=0.9.0, <=1.1.0"
-pygeodesy = "25.10.10"
+shapely = ">=1.8.0, <3.0.0"
+geopandas = ">=0.9.0, <2.0.0"
+pygeodesy = "^25.10.10"
+pyogrio = "^0.11.1"
+
 
 
 [tool.poetry.group.dev.dependencies]
@@ -48,7 +50,8 @@ pytest = "*"
 [tool.poetry.group.docs.dependencies]
 sphinx = ">=7.1.2, <8.3.0"
 sphinx-rtd-theme = ">=1.3.0rc1, <4.0.0"
-myst-parser = ">=3.0.0, <5.0.0"
+# myst-parser requires Python 3.10+
+myst-parser = "^4.0.1"
 
 
 [build-system]