Docstring improvements

logo/ogdatlab.svg

@@ -1,85 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!-- Created with Inkscape (http://www.inkscape.org/) -->
-
-<svg
-   xmlns:dc="http://purl.org/dc/elements/1.1/"
-   xmlns:cc="http://creativecommons.org/ns#"
-   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
-   xmlns:svg="http://www.w3.org/2000/svg"
-   xmlns="http://www.w3.org/2000/svg"
-   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
-   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
-   width="970"
-   height="240"
-   viewBox="0 0 970.00001 240"
-   id="svg2"
-   version="1.1"
-   inkscape:version="0.91 r13725"
-   sodipodi:docname="ogdatlab.svg">
-  <defs
-     id="defs4" />
-  <sodipodi:namedview
-     id="base"
-     pagecolor="#ffffff"
-     bordercolor="#666666"
-     borderopacity="1.0"
-     inkscape:pageopacity="0.0"
-     inkscape:pageshadow="2"
-     inkscape:zoom="0.7"
-     inkscape:cx="500.03524"
-     inkscape:cy="-28.517649"
-     inkscape:document-units="px"
-     inkscape:current-layer="layer1"
-     showgrid="false"
-     units="px"
-     showguides="true"
-     inkscape:guide-bbox="true"
-     inkscape:window-width="1311"
-     inkscape:window-height="1175"
-     inkscape:window-x="1051"
-     inkscape:window-y="98"
-     inkscape:window-maximized="0">
-    <sodipodi:guide
-       position="435.71429,127.14286"
-       orientation="0,1"
-       id="guide4443" />
-  </sodipodi:namedview>
-  <metadata
-     id="metadata7">
-    <rdf:RDF>
-      <cc:Work
-         rdf:about="">
-        <dc:format>image/svg+xml</dc:format>
-        <dc:type
-           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
-        <dc:title></dc:title>
-      </cc:Work>
-    </rdf:RDF>
-  </metadata>
-  <g
-     inkscape:label="Layer 1"
-     inkscape:groupmode="layer"
-     id="layer1"
-     transform="translate(0,-812.36214)">
-    <text
-       xml:space="preserve"
-       style="font-style:normal;font-weight:normal;font-size:40px;line-height:125%;font-family:sans-serif;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#d40000;fill-opacity:1;stroke:none;stroke-width:2.5999999;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-       x="484.28574"
-       y="993.79071"
-       id="text4144"
-       sodipodi:linespacing="125%"><tspan
-         sodipodi:role="line"
-         id="tspan4146"
-         x="484.28574"
-         y="993.79071"
-         style="font-style:normal;font-variant:normal;font-weight:900;font-stretch:normal;font-size:180px;font-family:'Source Sans Pro';-inkscape-font-specification:'Source Sans Pro Heavy';fill:#d40000;stroke:none;stroke-width:2.5999999;stroke-miterlimit:4;stroke-dasharray:none">OG<tspan
-   style="letter-spacing:-25px"
-   id="tspan4191">D</tspan><tspan
-   style="font-style:normal;font-variant:normal;font-weight:300;font-stretch:normal;font-size:90px;font-family:'Source Sans Pro';-inkscape-font-specification:'Source Sans Pro Light';fill:#999999;stroke:none"
-   id="tspan4159">.<tspan
-   style="-inkscape-font-specification:'Source Sans Pro';font-family:'Source Sans Pro';font-weight:normal;font-style:normal;font-stretch:normal;font-variant:normal;font-size:102.5px"
-   id="tspan4441">AT</tspan></tspan><tspan
-   style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:168.75px;font-family:'Source Sans Pro';-inkscape-font-specification:'Source Sans Pro Bold';fill:#999999;stroke:none"
-   id="tspan4163"> Lab</tspan></tspan></text>
-  </g>
-</svg>

notebooks/utils/converting.py

@@ -8,7 +8,7 @@ def location_to_gdf(location, address=None):
     
     Parameters
     ----------
-    location : GeoPy.Location
+    location : geopy.Location
         Location info to be used as the GeoDataFrame geometry
     address : string
         Optional address string to be stored in the GeoDataFrame column 'address'

notebooks/utils/dataaccess.py

@@ -25,7 +25,7 @@ def get_elevation(point):
     
     Parameters
     ----------
-    point : Shapely Point
+    point : shapely.Point
         Point in EPSG:3857 
     """
     x = point.x

notebooks/utils/plotting.py

@@ -1,4 +1,14 @@
 def hvplot_with_buffer(gdf, buffer_size, *args, **kwargs):
+    """
+    Convenience function for plotting a GeoPandas point GeoDataFrame using point markers plus buffer polygons
+    
+    Parameters
+    ----------
+    gdf : geopandas.Geodataframe
+        point GeoDataFrame to plot
+    buffer_size : numeric
+        size of the buffer in meters (measured in EPSG:31287)
+    """
     buffered = gdf.to_crs('epsg:31287').buffer(buffer_size)
     buffered = gdf.copy().set_geometry(buffered).to_crs('epsg:4326')