Harmonize and update node descriptions

Author: koettert

knime_extension/src/nodes/calculation.py

@@ -327,18 +327,18 @@ def execute(self, exec_context: knext.ExecutionContext, input_1):
     name="Transformed geo table",
     description="Transformed Geo input table",
 )
+@knut.geo_node_description(
+    short_description="This node generate rectangles representing the envelope of each geometry.",
+    description="""This node generate rectangles representing the envelope of each geometry. 
+    That is, the point or smallest rectangular polygon (with sides parallel to the coordinate axes) 
+    that contains each of the geometries.""",
+    references={
+        "Envelop": "https://geopandas.org/en/stable/docs/reference/api/geopandas.GeoSeries.envelope.html",
+    },
+)
 class BoundingBoxNode:
-    """
-    This node generate rectangles representing the envelope of each geometry.
-    """
-
-    geo_col = knext.ColumnParameter(
-        "Geometry column",
-        "Select the geometry column to transform.",
-        # Allow only GeoValue compatible columns
-        column_filter=knut.is_geo,
-        include_row_key=False,
-        include_none_column=False,
+    geo_col = knut.geo_col_parameter(
+        description="Select the geometry column to compute the bounding box."
     )
 
     def configure(self, configure_context, input_schema_1):
@@ -373,21 +373,22 @@ def execute(self, exec_context: knext.ExecutionContext, input_1):
     description="Table with geometry column to transform",
 )
 @knext.output_table(
-    name="Transformed geo table",
+    name="Transformed Geo table",
     description="Transformed Geo input table",
 )
+@knut.geo_node_description(
+    short_description="This node generate the smallest convex Polygon containing all the points in each geometry.",
+    description="""This node generate the smallest convex Polygon containing all the points in each geometry.
+    The convex hull of a geometry is the smallest convex Polygon containing all the points in each geometry, 
+    unless the number of points in the geometric object is less than three. For two points, the convex hull 
+    collapses to a LineString; for 1, a Point.""",
+    references={
+        "Convex hull": "https://geopandas.org/en/stable/docs/reference/api/geopandas.GeoSeries.convex_hull.html",
+    },
+)
 class ConvexHullNode:
-    """
-    This node generate the smallest convex Polygon containing all the points in each geometry.
-    """
-
-    geo_col = knext.ColumnParameter(
-        "Geometry column",
-        "Select the geometry column to transform.",
-        # Allow only GeoValue compatible columns
-        column_filter=knut.is_geo,
-        include_row_key=False,
-        include_none_column=False,
+    geo_col = knut.geo_col_parameter(
+        description="Select the geometry column to compute the convex hull."
     )
 
     def configure(self, configure_context, input_schema_1):
@@ -425,18 +426,16 @@ def execute(self, exec_context: knext.ExecutionContext, input_1):
     name="Transformed geo table",
     description="Transformed Geo input table",
 )
+@knut.geo_node_description(
+    short_description="This node returns a geometry containing the union of all geometries in the input column.",
+    description="This node returns a geometry containing the union of all geometries in the input column.",
+    references={
+        "Unary union": "https://geopandas.org/en/stable/docs/reference/api/geopandas.GeoSeries.unary_union.html",
+    },
+)
 class UnaryUnionNode:
-    """
-    This node generate the smallest convex Polygon containing all the points in each geometry.
-    """
-
-    geo_col = knext.ColumnParameter(
-        "Geometry column",
-        "Select the geometry column to transform.",
-        # Allow only GeoValue compatible columns
-        column_filter=knut.is_geo,
-        include_row_key=False,
-        include_none_column=False,
+    geo_col = knut.geo_col_parameter(
+        description="Select the geometry column to compute the unary union."
     )
 
     def configure(self, configure_context, input_schema_1):

knime_extension/src/nodes/conversion.py

@@ -25,30 +25,16 @@
 # Conversion helper methods
 ########################################################################################
 
-DEFAULT_CRS = "epsg:4326"
-"""Default coordinate reference system."""
-
-__DEF_CRS_DESCRIPTION = """[Coordinate reference system (CRS)](https://en.wikipedia.org/wiki/Spatial_reference_system) column
-        Supports the following input types:
-        
-        - PROJ string
-        - JSON string with PROJ parameters
-        - CRS WKT string
-        - An authority string [i.e. 'epsg:4326']
-        - An EPSG integer code [i.e. 4326]
-        - A tuple of ('auth_name': 'auth_code') [i.e ('epsg', '4326')]
-        """
-
 
 def crs_input_parameter(
     label: str = "CRS",
-    description: str = __DEF_CRS_DESCRIPTION,
+    description: str = knut.DEF_CRS_DESCRIPTION,
 ) -> knext.StringParameter:
     """Returns a CRS (coordinate reference system) string input parameter."""
     return knext.StringParameter(
         label=label,
         description=description,
-        default_value=DEFAULT_CRS,
+        default_value=knut.DEFAULT_CRS,
     )
 
 
@@ -153,7 +139,7 @@ def execute(self, exec_context, input_table):
 class WKTtoGeoNode(_ToGeoConverter):
 
     input_column = knext.ColumnParameter(
-        label="WKT Column",
+        label="WKT column",
         description="[Well-known-text (WKT)](https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry) column to convert",
         column_filter=knut.is_string,
         include_row_key=False,
@@ -192,7 +178,7 @@ def __init__(self):
 # class WKBtoGeoNode(_ToGeoConverter):
 
 #     input_column = knext.ColumnParameter(
-#         label="WKB Column",
+#         label="WKB column",
 #         description="[Well-known-binary (WKB)](https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry) column to convert",
 #         column_filter=knut.is_binary,
 #         include_row_key=False,
@@ -227,7 +213,7 @@ def __init__(self):
 class GeoJSONtoGeoNode(_ToGeoConverter):
 
     input_column = knext.ColumnParameter(
-        label="GeoJSON Column",
+        label="GeoJSON column",
         description="[GeoJSON](https://en.wikipedia.org/wiki/GeoJSON) column to convert",
         column_filter=knut.is_string,
         include_row_key=False,
@@ -308,6 +294,13 @@ def configure(self, configure_context, input_schema_1):
             f"Output column '{_ToGeoConverter.DEF_GEO_COL_NAME}'  exists in input table",
         )
         validate_crs(self.crs)
+        from shapely.geometry import Point
+
+        return input_schema_1.append(
+            knext.Column(
+                ktype=knext.logical(Point), name=_ToGeoConverter.DEF_GEO_COL_NAME
+            )
+        )
 
     def execute(self, exec_context: knext.ExecutionContext, input_table):
         # https://geopandas.org/en/stable/docs/user_guide/projections.html#the-axis-order-of-a-crs
@@ -564,6 +557,8 @@ def execute(self, exec_context: knext.ExecutionContext, input_1):
         gs = gdf.loc[:, self.geo_col]
         # https://geopandas.org/en/stable/docs/user_guide/projections.html#the-axis-order-of-a-crs
         # In GeoPandas the coordinates are always stored as (x, y), and thus as (lon, lat) order, regardless of the CRS
-        gdf[self.col_lon] = gs.x
+        # However the standard order for EPSG:4326 is latitude, longitude which is why we use this order in the output
+        # Also the ISO 6709 standard (https://en.wikipedia.org/wiki/ISO_6709) uses this order
         gdf[self.col_lat] = gs.y
+        gdf[self.col_lon] = gs.x
         return knut.to_table(gdf, exec_context)

knime_extension/src/nodes/io.py

@@ -31,21 +31,23 @@
 )
 @knext.output_table(
     name="Geodata table",
-    description="Geodata from the input file path.",
+    description="Geodata from the input file.",
 )
 @knut.geo_node_description(
     short_description="Read single layer GeoFile.",
-    description="""This node reads a single geofile from the path to the file or URL with geopandas.read_file(). 
-    The support file formats contain the popular data type such as ESRI Shapefile (.shp), zipped Shapefiles(.zip),single-layer GeoPackage file, or GeoJSON.
-    The standard Lcoal File path in KNIME Explorer,e.g.,'E:\KNIMEworkspace\test.geojson', can work as a file path without quotaion marks.
+    description="""This node reads a single geospatial file from the path to the file or URL. 
+    The supported file formats are the popular data types such as ESRI Shapefile (.shp), zipped Shapefiles(.zip),
+    single-layer GeoPackage file, or GeoJSON.
+    Example of a standard local file path would be *C:/KNIMEworkspace/test.geojson*.
     """,
     references={
         "Reading Spatial Data": "https://geopandas.org/en/stable/docs/user_guide/io.html",
+        "Read file": "https://geopandas.org/en/stable/docs/reference/api/geopandas.read_file.html",
     },
 )
 class GeoFileReaderNode:
     data_url = knext.StringParameter(
-        "Input File Path",
+        "Input file path",
         "The file path for reading data.",
         "",
     )
@@ -78,9 +80,11 @@ def execute(self, exec_context: knext.ExecutionContext):
 )
 @knut.geo_node_description(
     short_description="Write single layer GeoFile.",
-    description="This node writes the data in the format of Shapefile or GeoJSON with geopandas.to_file().",
+    description="""This node writes the data in the format of Shapefile or GeoJSON. 
+    Example of a standard local file path would be *C:/KNIMEworkspace/test.geojson*.""",
     references={
         "Writing Spatial Data": "https://geopandas.org/en/stable/docs/user_guide/io.html",
+        "To file": "https://geopandas.org/en/stable/docs/reference/api/geopandas.GeoDataFrame.to_file.html",
     },
 )
 class GeoFileWriterNode:
@@ -94,13 +98,13 @@ class GeoFileWriterNode:
     )
 
     data_url = knext.StringParameter(
-        "Output file path and file name",
+        "Output file path",
         "The file path for writing data without the file format or extension.",
         "",
     )
 
     dataformat = knext.StringParameter(
-        "Output File Format",
+        "Output file format",
         "The file path to save the data in the format of .shp or .geojson.",
         "Shapefile",
         enum=["Shapefile", "GeoJSON"],
@@ -141,18 +145,19 @@ def execute(self, exec_context: knext.ExecutionContext, input_1):
 )
 @knut.geo_node_description(
     short_description="Read GeoPackage layer",
-    description="""This node reads the GeoPackage, GeoDatabase(GDB) data with geopandas.read_file(). 
+    description="""This node reads the GeoPackage, GeoDatabase(GDB) data. 
     Using this node needs to specify the layer name, if set empty or wrong, the node will read the first layer. 
     The number as a layer order can also be applied, such as 0, 1, or other integer numbers .
     The node will export the  names of all layers as a table, which can be utilized to revise the name of target layer.
     """,
     references={
         "Reading Spatial Data": "https://geopandas.org/en/stable/docs/user_guide/io.html",
+        "Read file": "https://geopandas.org/en/stable/docs/reference/api/geopandas.read_file.html",
     },
 )
 class GeoPackageReaderNode:
     data_url = knext.StringParameter(
-        "Input File Path",
+        "Input file path",
         "The file path for reading data.",
         "",
     )
@@ -168,21 +173,20 @@ def configure(self, configure_context):
         return None
 
     def execute(self, exec_context: knext.ExecutionContext):
-        layerlist=fiona.listlayers(self.data_url)
-        pnumber = pd.Series(range(0,100)).astype(str).to_list()
-        if self.data_layer in layerlist: 
+        layerlist = fiona.listlayers(self.data_url)
+        pnumber = pd.Series(range(0, 100)).astype(str).to_list()
+        if self.data_layer in layerlist:
             gdf = gp.read_file(self.data_url, layer=self.data_layer)
-        elif self.data_layer in pnumber : 
-            nlayer=int(self.data_layer)
-            gdf = gp.read_file(self.data_url,layer=nlayer)       
+        elif self.data_layer in pnumber:
+            nlayer = int(self.data_layer)
+            gdf = gp.read_file(self.data_url, layer=nlayer)
         else:
-            gdf = gp.read_file(self.data_url,layer=0)           
+            gdf = gp.read_file(self.data_url, layer=0)
         gdf = gdf.reset_index(drop=True)
-        listtable = pd.DataFrame({'layerlist': layerlist})
+        listtable = pd.DataFrame({"layerlist": layerlist})
         return knext.Table.from_pandas(gdf), knext.Table.from_pandas(listtable)
 
 
-
 ############################################
 # GeoPackage Writer
 ############################################
@@ -199,11 +203,12 @@ def execute(self, exec_context: knext.ExecutionContext):
 )
 @knut.geo_node_description(
     short_description="Write GeoPackage layer.",
-    description="""This node writes the data as a layer into a GeoPackage data with geopandas.to_file().
-    If the layer is already in the GeoPackage data, the orginal data of the target layer will be written by the new data. 
+    description="""This node writes the data as a layer into a GeoPackage data.
+    If the layer is already in the GeoPackage data, the original data of the target layer will be written by the new data. 
     """,
     references={
         "Writing Spatial Data": "https://geopandas.org/en/stable/docs/user_guide/io.html",
+        "To file": "https://geopandas.org/en/stable/docs/reference/api/geopandas.GeoDataFrame.to_file.html",
     },
 )
 class GeoPackageWriterNode:
@@ -217,7 +222,9 @@ class GeoPackageWriterNode:
     )
 
     data_url = knext.StringParameter(
-        "Input File Path", "The file path for saving data.", "",
+        "Input file path",
+        "The file path for saving data.",
+        "",
     )
 
     data_layer = knext.StringParameter(

knime_extension/src/nodes/locationanalysis.py

@@ -71,7 +71,7 @@ class PmedianNode:
 
     DemandPopu = knext.ColumnParameter(
         "Column for demand population",
-        "The populaiton of demand",
+        "The population of demand",
         # port_index=2,
         column_filter=knut.is_numeric,
         include_row_key=False,
@@ -425,16 +425,16 @@ def getIndex(s):
 )
 @knext.input_table(
     name="Input OD list with geometries ",
-    description="Table with geometry information of demand and supply ",
+    description="Table with geometry information of demand and supply",
 )
 @knext.output_table(
     name="Demand table with MCLP result",
     description="Demand table with assigned supply point and link",
 )
 @knut.pulp_node_description(
     short_description="Solve MCLP problem to Maximize Capacitated Coverage by setting an impedance cutoff.",
-    description="The MCLP model, maximum covering location problem (MCLP),  aims to Locate p facilities,"
-    + " and demand is covered ifit is within a specifieddistance (time) of a facility. "
+    description="The MCLP model, maximum covering location problem (MCLP), aims to Locate p facilities,"
+    + " and demand is covered if it is within a specified distance (time) of a facility. "
     + "The P-Median problem will be solved by PuLP package. ",
     references={
         "Pulp.Solver": "https://coin-or.github.io/pulp/guides/how_to_configure_solvers.html",
@@ -462,7 +462,7 @@ class MCLPNode:
 
     DemandPopu = knext.ColumnParameter(
         "Column for demand population",
-        "The populaiton of demand",
+        "The population of demand",
         # port_index=2,
         column_filter=knut.is_numeric,
         include_row_key=False,