Skip to content

Commit

Permalink
docs: Update site
Browse files Browse the repository at this point in the history
  • Loading branch information
r-leyshon committed Jun 27, 2024
1 parent b0e481f commit 95b09d3
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
13 changes: 6 additions & 7 deletions docs/tutorials/index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ undertaking routing with public transport modalities.

To do this, we will need to use a class from the `assess_gtfs`
package called `MultiGtfsInstance`. Take a look at the
<a href="../../reference/multi_validation.qmd#assess_gtfs.multi_validation.MultiGtfsInstance" target="_blank">`MultiGtfsInstance` API documentation</a> for full details on
<a href="../../docs/reference/multi_validation.qmd#assess_gtfs.multi_validation.MultiGtfsInstance" target="_blank">`MultiGtfsInstance` API documentation</a> for full details on
how this class works. You may wish to keep this page open for reference in
later tasks.

Expand Down Expand Up @@ -313,7 +313,7 @@ print(f"Unfiltered feed is: {size_out}")
### By Bounding Box

To help understand the requirements for spatially cropping a feed, inspect the
[API documentation for the `filter_to_bbox()`](../../reference/multi_validation.qmd#assess_gtfs.multi_validation.MultiGtfsInstance.filter_to_bbox)
[API documentation for the `filter_to_bbox()`](../../docs/reference/multi_validation.qmd#assess_gtfs.multi_validation.MultiGtfsInstance.filter_to_bbox)
method.

To perform this crop, we need to get a bounding box. This could be any boundary
Expand Down Expand Up @@ -556,11 +556,14 @@ or where the specification is violated.

```{python}
feed.clean_feeds()
feed.is_valid(validation_kwargs={"far_stops": False})
feed.is_valid()
```

:::

You may note warnings printed to the console and whether a statement about
whether a feed was successfully cleaned.

## Write Filtered Feed

Once we have finished the filter and cleaning operations, we can now go ahead
Expand Down Expand Up @@ -610,9 +613,5 @@ successfully examined the features, errors and warnings within a GTFS feed. We
have also filtered the feed by bounding box and by date in order to reduce its
size on disk.

To continue learning how to work with the `assess_gtfs` package, it
is suggested that you continue with the
[OpenStreetMap tutorials](/docs/tutorials/osm/index.qmd)

For any problems encountered with this tutorial or the `assess_gtfs`
package, please open an issue on our [GitHub repository](https://github.com/datasciencecampus/transport-network-performance/issues).
2 changes: 1 addition & 1 deletion index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ These docs are structured in accordance with the [Diátaxis][diataxis] framework
<div class="grid-item item4 jumbotron">
<p class="jumbotron-icon">📝</p>
<p>Interested in learning how to use `assess_gtfs` by examples?</p>
<a class="btn btn-primary btn-lg" href="./docs/tutorials/index.html" role="button">Tutorials</a>
<a class="btn btn-primary btn-lg" href="./docs/tutorials/index.html" role="button">Tutorial</a>
</div>
<div class="grid-item item5 jumbotron">
<p class="jumbotron-icon">📖</p>
Expand Down

0 comments on commit 95b09d3

Please sign in to comment.