index.qmd

---
title: "`assess-gtfs` documentation"
title-block-banner: true
date-format: iso
description: |

  A Python package allowing inspection, validation and filtering of General
  Transit Feed Specification.
toc: true
toc-title: "On this homepage"
sidebar: false
about:
    template: marquee
    links:
        - icon: github
          href: https://github.com/datasciencecampus/assess_gtfs
          text: GitHub
---

  <img src="/docs/_static/assess-gtfs.png"/ alt="assess-gtfs logo" width=200 style="display: block; margin-left: auto; margin-right: auto;">

## What is `assess-gtfs`?

[General Transit Feed Specification (GTFS)][gtfs] is a common data format for
public transit information. GTFS is a prerequisite for undertaking routing
with public transit schedules.

The `assess-gtfs` Python package helps to reduce barriers to understanding the
service distribution within GTFS. More specifically, it enables developers to
inspect, clean and process GTFS for more efficient, localised routing analysis.

### The History of `assess-gtfs`

`assess-gtfs` started out life as a module in the ONS Data Science Campus'
[`transport_performance`][tp] package. `assess-gtfs` is built upon and inspired
by the excellent [gtfs_kit][gtfskit] package. `assess-gtfs` was needed to
process and inspect GTFS data prior to building transport networks with the
[r<sup>5</sup>py][r5py] package. Building valid transit networks with the
output of our GTFS processing pipelines has been the primary user requirement
during development.


## Where do I go now?

These docs are structured in accordance with the [Diátaxis][diataxis] framework:

<div class="grid-container">
<div class="grid-item item1 jumbotron">
<p class="jumbotron-icon">🏁</p>
<p>Want to get up and running with `assess-gtfs` quickly?</p>
<a class="btn btn-primary btn-lg" href="./docs/getting_started/index.html" role="button">Getting Started</a>
</div>
<div class="grid-item item2 jumbotron">
<p class="jumbotron-icon">🔎</p>
<p>Need more details on the methods/tools used within `assess-gtfs`?</p>
<a class="btn btn-primary btn-lg" href="./docs/explanation/index.html" role="button">Explanation</a>
</div>
<div class="grid-item item3 jumbotron">
<p class="jumbotron-icon">🧭</p>
<p>Looking for guidance on how to get something done (e.g. find input data)?</p>
<a class="btn btn-primary btn-lg" href="./docs/how_to/index.html" role="button">How-To</a>
</div>
<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">Tutorial</a>
</div>
<div class="grid-item item5 jumbotron">
<p class="jumbotron-icon">📖</p>
<p>Requiring a technical reference covering the `assess-gtfs` API?</p>
<a class="btn btn-primary btn-lg" href="./docs/reference/index.html" role="button">API reference</a>
</div>
<div class="grid-item item6 jumbotron">
<p class="jumbotron-icon">🛠️</p>
<p>Want to contribute to the development of `assess-gtfs`?</p>
<a class="btn btn-primary btn-lg" href="https://github.com/datasciencecampus/assess_gtfs" role="button">GitHub</a>
</div>
</div>

::: {.callout-note}

## Notes on contributing...

We hope that the open source and public sector communities will collaborate and
build on this package. You can find the `assess-gtfs` source code on
[GitHub](https://github.com/datasciencecampus/assess_gtfs).

:::


[diataxis]: https://diataxis.fr/
[gtfs]: https://gtfs.org/schedule/
[r5py]: https://r5py.readthedocs.io/en/stable/index.html
[tp]: https://github.com/datasciencecampus/transport-network-performance
[gtfskit]: https://pypi.org/project/gtfs_kit/