https://github.com/physicsofmobility/ridepy
Simulates a dispatching algorithm serving exogenous transportation requests with a fleet of vehicles. Does not simulate the universe, unlike MATSim. Batteries are included.
https://github.com/physicsofmobility/ridepy
research ridepooling simulation
Last synced: 25 days ago
JSON representation
Simulates a dispatching algorithm serving exogenous transportation requests with a fleet of vehicles. Does not simulate the universe, unlike MATSim. Batteries are included.
- Host: GitHub
- URL: https://github.com/physicsofmobility/ridepy
- Owner: PhysicsOfMobility
- License: mit
- Created: 2020-07-25T12:07:41.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-06-11T14:18:52.000Z (8 months ago)
- Last Synced: 2025-10-24T23:44:06.005Z (3 months ago)
- Topics: research, ridepooling, simulation
- Language: Python
- Homepage: https://ridepy.org
- Size: 1010 KB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 50
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
|joss| |Code style: black| |Tests| |Docs| |wheel| |sdist|
RidePy
======
RidePy is a scientific Python library for simulating modern on-demand transit systems such as ridepooling.
In short: RidePy simulates a dispatching algorithm serving exogenous transportation requests with a fleet of vehicles. Does not simulate the universe, unlike MATSim. Batteries are included.
Head over to `ridepy.org `__ to get started. You might also be interested in our `paper `__ published in the Journal of Open Source Software.
Quickstart
----------
For detailed instructions, see the `installation guide `__ in the documentation.
If you're in a hurry, here's the gist:
- RidePy currently works best with Python 3.9
- If you are on platform other than x86-64 Linux, i.e., one that we don't offer wheels for, you will need to first set up a C++ build environment and the `Boost C++ libraries `__. On Debian-like systems, this is easily accomplished with
.. code-block:: bash
sudo apt-get install build-essential libboost-all-dev
- Install RidePy with
.. code-block:: bash
pip install ridepy
Contributing
------------
We are always happy for contributions from the community. If you run into a problem, please `report an issue `__ or `ask for help `__.
If you are interested in contributing to our codebase, please read our `contributing guide `__.
Here is a short overview of the most important points:
Resources
~~~~~~~~~
- Documentation: `ridepy.org `__
- Source code: `GitHub `__
- Issue tracker: `GitHub `__
Code style
~~~~~~~~~~
- Python: `black `__
- C++: `LLVM `__
Development
~~~~~~~~~~~
- Version control: `Git `__
- Testing: `pytest `__
- Continuous integration: `GitHub Actions `__
- Versioning: `Semantic Versioning `__
.. http://mozillascience.github.io/working-open-workshop/contributing/
..
---------
Badges
---------
.. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. |Docs| image:: https://github.com/PhysicsOfMobility/ridepy/actions/workflows/build-doc.yml/badge.svg
:target: https://github.com/PhysicsOfMobility/ridepy/actions/workflows/build-doc.yml
.. |Tests| image:: https://github.com/PhysicsOfMobility/ridepy/actions/workflows/python-testing.yml/badge.svg
:target: https://github.com/PhysicsOfMobility/ridepy/actions/workflows/python-testing.yml
.. |wheel| image:: https://github.com/PhysicsOfMobility/ridepy/actions/workflows/build-wheel.yml/badge.svg
:target: https://github.com/PhysicsOfMobility/ridepy/actions/workflows/build-wheel.yml
.. |sdist| image:: https://github.com/PhysicsOfMobility/ridepy/actions/workflows/build-sdist.yml/badge.svg
:target: https://github.com/PhysicsOfMobility/ridepy/actions/workflows/build-sdist.yml
.. |joss| image:: https://joss.theoj.org/papers/10.21105/joss.06241/status.svg
:target: https://doi.org/10.21105/joss.06241
.. _ridepy doc: https://ridepy.org