Merge pull request #27 from crim-ca/refactor-typings-extra-configs

Refactor typings + extra configs forwarding

Author: allixender

README.md

@@ -11,15 +11,15 @@ GNU AFFERO GENERAL PUBLIC LICENSE
 - [DGGRID Version 8.3 on GitHub](https://github.com/sahrk/DGGRID)
 - [DGGRID User Manual](https://github.com/sahrk/DGGRID/blob/d08e10d761f7bedd72a253ab1057458f339de51e/dggridManualV81b.pdf)
 
-You need the ddgrid tool compiled available on the system.
+You need the `dggrid` tool compiled available on the system.
 
-Besides some lowlevel access influence the dggrid operations' metafile creation, a few highlevel functions are integrated to work with the more comfortable geopython libraries, like shapely and geopandas
+Besides some low-level access influence the dggrid operations' metafile creation, a few high-level functions are integrated to work with the more comfortable geopython libraries, like shapely and geopandas
 
 - grid_cell_polygons_for_extent(): fill extent/subset with cells at resolution (clip or world)
 - grid_cell_polygons_from_cellids(): geometry_from_cellid for dggs at resolution (from id list)
 - grid_cellids_for_extent(): get_all_indexes/cell_ids for dggs at resolution (clip or world)
 - cells_for_geo_points(): poly_outline for point/centre at resolution
-- address_transform():  conversion betwenn cell_id address types, like SEQNUM, Z7, or Q2DI
+- address_transform():  conversion between cell_id address types, like SEQNUM, Z7, or Q2DI
 
 
 ```python
@@ -29,7 +29,7 @@ import shapely
 from dggrid4py import DGGRIDv7
 
 
-# create an inital instance that knows where the dggrid tool lives, configure temp workspace and log/stdout output
+# create an initial instance that knows where the dggrid tool lives, configure temp workspace and log/stdout output
 # if you have 
 dggrid_instance = DGGRIDv7(executable='<path_to>/dggrid', working_dir='.', capture_logs=False, silent=False, tmp_geo_out_legacy=False, debug=False)
 
@@ -42,10 +42,10 @@ gdf1.to_file('isea4t_5.shp')
 gdf_centroids = dggrid_instance.grid_cell_centroids_for_extent(dggs_type='ISEA7H', resolution=4, mixed_aperture_level=None, clip_geom=None)
 
 # clip extent
-clip_bound = shapely.geometry.box(20.2,57.00, 28.4,60.0 )
+clip_bound = shapely.geometry.box(20.2,57.00, 28.4,60.0)
 
 # ISEA7H grid at resolution 9, for extent of provided WGS84 rectangle into GeoDataFrame to Shapefile
-gdf3 = dggrid_instance.grid_cell_polygons_for_extent('ISEA7H', 9, clip_geom=est_bound)
+gdf3 = dggrid_instance.grid_cell_polygons_for_extent('ISEA7H', 9, clip_geom=clip_bound)
 print(gdf3.head())
 gdf3.to_file('grids/est_shape_isea7h_9.shp')
 
@@ -55,6 +55,8 @@ print(df1.head(8))
 df1.to_csv('isea7h_8_stats.csv', index=False)
 
 # generate the DGGS grid cells that would cover a GeoDataFrame of points, return Polygons with cell IDs as GeoDataFrame
+points = [shapely.Point(20.5, 57.5), shapely.Point(21.0, 58.0)]
+geodf_points_wgs84 = geopandas.GeoDataFrame({'name': ['A', 'B']}, geometry=points, crs='EPSG:4326')
 gdf4 = dggrid_instance.cells_for_geo_points(geodf_points_wgs84, False, 'ISEA7H', 5)
 print(gdf4.head())
 gdf4.to_file('polycells_from_points_isea7h_5.shp')
@@ -65,15 +67,15 @@ print(gdf5.head())
 gdf5.to_file('geopoint_cellids_from_points_isea4h_8.shp')
 
 # generate DGGS grid cell polygons based on 'cell_id_list' (a list or np.array of provided cell_ids)
-gdf6 = dggrid_instance.grid_cell_polygons_from_cellids(cell_id_list=[1, 4, 8], 'ISEA7H', 5)
+gdf6 = dggrid_instance.grid_cell_polygons_from_cellids(cell_id_list=[1, 4, 8], dggs_type='ISEA7H', resolution=5)
 print(gdf6.head())
 gdf6.to_file('from_seqnums_isea7h_5.shp')
 
 # v0.2.6 API update split at dateline for cartesian GIS tools
 gdf7 = dggrid_instance.grid_cell_polygons_for_extent('ISEA7H', 3, split_dateline=True)
 gdf7.to_file('global_isea7h_3_interrupted.shp')
 
-gdf_z1 = dggrid_instance.grid_cell_polygons_for_extent('IGEO7', 5, clip_geom=est_bound, output_address_type='Z7_STRING')
+gdf_z1 = dggrid_instance.grid_cell_polygons_for_extent('IGEO7', 5, clip_geom=clip_bound, output_address_type='Z7_STRING')
 print(gdf_z1.head(3))
 
 df_z1 = dggrid_instance.guess_zstr_resolution(gdf_z1['name'].values, 'IGEO7', input_address_type='Z7_STRING')
@@ -94,7 +96,7 @@ if you don't have a special local distribution of the dggrid-tool or if you didn
 
 ```python
 
-from dggrid4py import tool
+from dggrid4py import DGGRIDv7, tool
 
 dggrid_exec = tool.get_portable_executable(".")
 dggrid_instance_portable = DGGRIDv7(executable=dggrid_exec, working_dir='.', capture_logs=False, silent=True, has_gdal=False, tmp_geo_out_legacy=True, debug=False)
@@ -125,4 +127,3 @@ working on an updated conda package. Currently DGGRID v8.3 is available on conda
 ## greater context DGGS in Earth Sciences and GIS
 
 Some reading to be excited about: [discourse.pangeo.io](https://discourse.pangeo.io/t/discrete-global-grid-systems-dggs-use-with-pangeo/2274)
-