Welcome to RidePy’s documentation!

RidePy is a scientific Python library for simulating modern on-demand transit systems such as ridepooling.

To better understand what RidePy is all about probably should start by reading the overview section. For instructions on installation, contributing and support, head over to the “How to…” section. And to dive right in and get started with using RidePy for a simple simulation, try the tutorial.

In addition to these general guides, we offer a commented API reference, in which we explain the building blocks and concepts that RidePy is based on in more detail, and how you can leverage them for your specific application. This section is far more technical than the hands-on tutorial, but allows for a deeper understanding.

Finally, we now have a helpful (currently still incomplete) glossary, which details both general terms and concepts as well as those specific to the analytics module.

For quick access to the documentation of specific parts of the API, refer to the hierarchically structured Python module index. There is also an alphabetical documentation index.

To access RidePy’s source code, report issues, or contribute to the project, visit our GitHub repository.