Built site for gh-pages

datasciencecampus · Jun 25, 2024 · 2b8ca5e · 2b8ca5e
1 parent 8ee8cae
commit 2b8ca5e
Show file tree

Hide file tree

Showing 11 changed files with 1,262 additions and 972 deletions.
diff --git a/.nojekyll b/.nojekyll
@@ -1 +1 @@
-749a4d8c
+3bcf4943
diff --git a/docs/explanation/index.html b/docs/explanation/index.html
@@ -510,7 +510,7 @@ <h1 class="title">Explanation</h1>
 </tr>
 </thead>
 <tbody class="list">
-<tr data-index="0" data-categories="Explanation" data-listing-file-modified-sort="1718363545365" data-listing-reading-time-sort="4" data-listing-word-count-sort="687" data-listing-title-sort="1. Transport Performance: A Definition" data-listing-filename-sort="index.qmd">
+<tr data-index="0" data-categories="Explanation" data-listing-file-modified-sort="1719309154720" data-listing-reading-time-sort="4" data-listing-word-count-sort="687" data-listing-title-sort="1. Transport Performance: A Definition" data-listing-filename-sort="index.qmd">
 <td>
 <a href="../../docs/explanation/what_is_tp/index.html" class="title listing-title">1. Transport Performance: A Definition</a>
 </td>
@@ -521,7 +521,7 @@ <h1 class="title">Explanation</h1>
 <span class="listing-reading-time">4 min</span>
 </td>
 </tr>
-<tr data-index="1" data-categories="Explanation" data-listing-file-modified-sort="1718363545365" data-listing-reading-time-sort="4" data-listing-word-count-sort="709" data-listing-title-sort="2. Transport Performance: An Overview" data-listing-filename-sort="index.qmd">
+<tr data-index="1" data-categories="Explanation" data-listing-file-modified-sort="1719309154720" data-listing-reading-time-sort="4" data-listing-word-count-sort="709" data-listing-title-sort="2. Transport Performance: An Overview" data-listing-filename-sort="index.qmd">
 <td>
 <a href="../../docs/explanation/calculate_tp/index.html" class="title listing-title">2. Transport Performance: An Overview</a>
 </td>
@@ -532,7 +532,7 @@ <h1 class="title">Explanation</h1>
 <span class="listing-reading-time">4 min</span>
 </td>
 </tr>
-<tr data-index="2" data-categories="Explanation" data-listing-file-modified-sort="1718363545365" data-listing-reading-time-sort="1" data-listing-word-count-sort="5" data-listing-title-sort="3. Limitations and Caveats" data-listing-filename-sort="index.qmd">
+<tr data-index="2" data-categories="Explanation" data-listing-file-modified-sort="1719309154720" data-listing-reading-time-sort="1" data-listing-word-count-sort="5" data-listing-title-sort="3. Limitations and Caveats" data-listing-filename-sort="index.qmd">
 <td>
 <a href="../../docs/explanation/limitations/index.html" class="title listing-title">3. Limitations and Caveats</a>
 </td>

diff --git a/docs/how_to/index.html b/docs/how_to/index.html
@@ -510,7 +510,7 @@ <h1 class="title">How-To</h1>
 </tr>
 </thead>
 <tbody class="list">
-<tr data-index="0" data-categories="How-To" data-listing-file-modified-sort="1718363545369" data-listing-reading-time-sort="1" data-listing-word-count-sort="5" data-listing-title-sort="1. Get Gridded Population Estimates" data-listing-filename-sort="index.qmd">
+<tr data-index="0" data-categories="How-To" data-listing-file-modified-sort="1719309154724" data-listing-reading-time-sort="1" data-listing-word-count-sort="5" data-listing-title-sort="1. Get Gridded Population Estimates" data-listing-filename-sort="index.qmd">
 <td>
 <a href="../../docs/how_to/uc_pop/index.html" class="title listing-title">1. Get Gridded Population Estimates</a>
 </td>
@@ -521,7 +521,7 @@ <h1 class="title">How-To</h1>
 <span class="listing-reading-time">1 min</span>
 </td>
 </tr>
-<tr data-index="1" data-categories="How-To" data-listing-file-modified-sort="1718363545369" data-listing-reading-time-sort="1" data-listing-word-count-sort="5" data-listing-title-sort="2. Get Public Transit Schedule Data (GTFS)" data-listing-filename-sort="index.qmd">
+<tr data-index="1" data-categories="How-To" data-listing-file-modified-sort="1719309154724" data-listing-reading-time-sort="1" data-listing-word-count-sort="5" data-listing-title-sort="2. Get Public Transit Schedule Data (GTFS)" data-listing-filename-sort="index.qmd">
 <td>
 <a href="../../docs/how_to/gtfs/index.html" class="title listing-title">2. Get Public Transit Schedule Data (GTFS)</a>
 </td>
@@ -532,7 +532,7 @@ <h1 class="title">How-To</h1>
 <span class="listing-reading-time">1 min</span>
 </td>
 </tr>
-<tr data-index="2" data-categories="How-To" data-listing-file-modified-sort="1718363545369" data-listing-reading-time-sort="1" data-listing-word-count-sort="5" data-listing-title-sort="3. Get OpenStreetMap Data" data-listing-filename-sort="index.qmd">
+<tr data-index="2" data-categories="How-To" data-listing-file-modified-sort="1719309154724" data-listing-reading-time-sort="1" data-listing-word-count-sort="5" data-listing-title-sort="3. Get OpenStreetMap Data" data-listing-filename-sort="index.qmd">
 <td>
 <a href="../../docs/how_to/osm/index.html" class="title listing-title">3. Get OpenStreetMap Data</a>
 </td>

diff --git a/docs/reference/validate_osm.html b/docs/reference/validate_osm.html
@@ -426,6 +426,10 @@ <h2 class="anchored" data-anchor-id="classes">Classes</h2>
 <td><a href="#transport_performance.osm.validate_osm.FindTags">FindTags</a></td>
 <td>Applies tag collation to OSM file.</td>
 </tr>
+<tr class="even">
+<td><a href="#transport_performance.osm.validate_osm.PerformanceWarning">PerformanceWarning</a></td>
+<td>Operation may be slow.</td>
+</tr>
 </tbody>
 </table>
 <section id="transport_performance.osm.validate_osm.FindIds" class="level3">
@@ -684,9 +688,9 @@ <h4 class="anchored" data-anchor-id="raises-1">Raises</h4>
 <h4 class="anchored" data-anchor-id="attributes-1">Attributes</h4>
 <table class="caption-top table">
 <colgroup>
-<col style="width: 24%">
-<col style="width: 11%">
-<col style="width: 63%">
+<col style="width: 14%">
+<col style="width: 16%">
+<col style="width: 68%">
 </colgroup>
 <thead>
 <tr class="header">
@@ -711,6 +715,11 @@ <h4 class="anchored" data-anchor-id="attributes-1">Attributes</h4>
 <td>dict</td>
 <td>Locations of nodes that belong to a way.</td>
 </tr>
+<tr class="even">
+<td>_osm_pth</td>
+<td>Union[Path, str]</td>
+<td>Path to osm file on disk. Used for method plot_ids() when include_tags is True.</td>
+</tr>
 </tbody>
 </table>
 </section>
@@ -812,17 +821,17 @@ <h6 class="anchored" data-anchor-id="raises-2">Raises</h6>
 </section>
 <section id="transport_performance.osm.validate_osm.FindLocations.plot_ids" class="level5">
 <h5 class="anchored" data-anchor-id="transport_performance.osm.validate_osm.FindLocations.plot_ids">plot_ids</h5>
-<p><code>osm.validate_osm.FindLocations.plot_ids(ids, feature_type, crs='epsg:4326')</code></p>
+<p><code>osm.validate_osm.FindLocations.plot_ids(ids, feature_type, crs='epsg:4326', include_tags=False, tooltip_nm='custom_tooltip', tooltip_kwds={'labels': False}, tiles='CartoDB positron', style_kwds={'color': '#3f5277', 'fill': True, 'fillOpacity': 0.3, 'fillColor': '#3f5277', 'weight': 4})</code></p>
 <p>Plot coordinates for nodes or node members of a way.</p>
 <p>Provided with a list of node or way IDs, converts the coordinate data from dictionary to GeoDataFrame and uses the basic gdf.explore() method to visualise the features on a basemap.</p>
 <section id="parameters-3" class="level6">
 <h6 class="anchored" data-anchor-id="parameters-3">Parameters</h6>
 <table class="caption-top table">
 <colgroup>
-<col style="width: 14%">
-<col style="width: 16%">
-<col style="width: 56%">
-<col style="width: 13%">
+<col style="width: 4%">
+<col style="width: 11%">
+<col style="width: 55%">
+<col style="width: 27%">
 </colgroup>
 <thead>
 <tr class="header">
@@ -851,6 +860,36 @@ <h6 class="anchored" data-anchor-id="parameters-3">Parameters</h6>
 <td>The projection of the spatial features, by default “epsg:4326”</td>
 <td><code>'epsg:4326'</code></td>
 </tr>
+<tr class="even">
+<td><code>include_tags</code></td>
+<td>bool</td>
+<td>Should tag metadata be included in the map tooltips, by default False</td>
+<td><code>False</code></td>
+</tr>
+<tr class="odd">
+<td><code>tooltip_nm</code></td>
+<td>str</td>
+<td>Name to use for tooltip column in coord_gdf attribute, by default “custom_tooltip”</td>
+<td><code>'custom_tooltip'</code></td>
+</tr>
+<tr class="even">
+<td><code>tooltip_kwds</code></td>
+<td>dict</td>
+<td>Additional tooltip styling arguments to pass to gpd explore(), by default {“labels”: False}</td>
+<td><code>{'labels': False}</code></td>
+</tr>
+<tr class="odd">
+<td><code>tiles</code></td>
+<td>Union[str, xyzservices.TileProvider]</td>
+<td>Basemap provider tiles to use, by default “CartoDB positron”</td>
+<td><code>'CartoDB positron'</code></td>
+</tr>
+<tr class="even">
+<td><code>style_kwds</code></td>
+<td>dict</td>
+<td>Additional map styling arguments to pass to gpd explore(), by default { “color”: “#3f5277”, “fill”: True, “fillOpacity”: 0.3, “fillColor”: “#3f5277”, “weight”: 4, }</td>
+<td><code>{'color': '#3f5277', 'fill': True, 'fillOpacity': 0.3, 'fillColor': '#3f5277', 'weight': 4}</code></td>
+</tr>
 </tbody>
 </table>
 </section>
@@ -980,6 +1019,11 @@ <h4 class="anchored" data-anchor-id="raises-4">Raises</h4>
 <section id="attributes-2" class="level4">
 <h4 class="anchored" data-anchor-id="attributes-2">Attributes</h4>
 <table class="caption-top table">
+<colgroup>
+<col style="width: 16%">
+<col style="width: 6%">
+<col style="width: 76%">
+</colgroup>
 <thead>
 <tr class="header">
 <th>Name</th>
@@ -1013,6 +1057,11 @@ <h4 class="anchored" data-anchor-id="attributes-2">Attributes</h4>
 <td>dict</td>
 <td>Tags found for OSM area features.</td>
 </tr>
+<tr class="even">
+<td>__LARGE_FILE_THRESH</td>
+<td>int</td>
+<td>Size threshold in bytes on which to raise a PerformanceWarning when osm file on disk exceeds.</td>
+</tr>
 </tbody>
 </table>
 </section>
@@ -1089,11 +1138,16 @@ <h6 class="anchored" data-anchor-id="returns-4">Returns</h6>
 </tr>
 </tbody>
 </table>
-
-
 </section>
 </section>
 </section>
+</section>
+<section id="transport_performance.osm.validate_osm.PerformanceWarning" class="level3">
+<h3 class="anchored" data-anchor-id="transport_performance.osm.validate_osm.PerformanceWarning">PerformanceWarning</h3>
+<p><code>osm.validate_osm.PerformanceWarning()</code></p>
+<p>Operation may be slow.</p>
+
+
 </section>
 </section>
 </section>