Data

Tools

Indexes

Applications

Experiments

Open Source Science

RidePy

RidePy: A fast and modular framework for simulating ridepooling systems - Published in JOSS (2024)

https://github.com/physicsofmobility/ridepy

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 6 DOI reference(s) in README and JOSS metadata
  • ✓
    Academic publication links
    Links to: joss.theoj.org
  • ✓
    Committers with academic emails
    2 of 5 committers (40.0%) from academic institutions
  • ○
    Institutional organization owner
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

research ridepooling simulation

Scientific Fields

Sociology Social Sciences - 87% confidence
Mathematics Computer Science - 84% confidence
Last synced: 4 months ago · JSON representation

Repository

Simulates a dispatching algorithm serving exogenous transportation requests with a fleet of vehicles. Does not simulate the universe, unlike MATSim. Batteries are included.

Basic Info
  • Host: GitHub
  • Owner: PhysicsOfMobility
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage: https://ridepy.org
  • Size: 1010 KB
Statistics
  • Stars: 8
  • Watchers: 3
  • Forks: 0
  • Open Issues: 50
  • Releases: 33
Topics
research ridepooling simulation
Created over 5 years ago · Last pushed 7 months ago
Metadata Files
Readme License Codeowners

README.rst 

|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

Owner

  • Name: Physics of Mobility
  • Login: PhysicsOfMobility
  • Kind: organization

JOSS Publication

RidePy: A fast and modular framework for simulating ridepooling systems
Published
May 06, 2024
DOI
Volume 9, Issue 97, Page 6241
Authors
Felix Jung ORCID
Chair of Network Dynamics, Institute of Theoretical Physics and Center for Advancing Electronics Dresden (cfaed), TUD Dresden University of Technology, 01062 Dresden, Germany
Debsankha Manik
Chair of Network Dynamics, Institute of Theoretical Physics and Center for Advancing Electronics Dresden (cfaed), TUD Dresden University of Technology, 01062 Dresden, Germany
Editor
Patrick Diehl ORCID
Tags
simulation ridepooling mobility transport physics
View PDF Review Thread Software Archive

GitHub Events

Total
  • Issues event: 2
  • Watch event: 1
  • Delete event: 2
  • Issue comment event: 2
  • Push event: 7
  • Pull request event: 2
  • Create event: 2
Last Year
  • Issues event: 2
  • Watch event: 1
  • Delete event: 2
  • Issue comment event: 2
  • Push event: 7
  • Pull request event: 2
  • Create event: 2

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 232
  • Total Committers: 5
  • Avg Commits per committer: 46.4
  • Development Distribution Score (DDS): 0.216
Past Year
  • Commits: 16
  • Committers: 1
  • Avg Commits per committer: 16.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Felix Jung f****g@t****e 182
Debsankha Manik d****a 22
Felix Jung f****g@d****e 19
Debsankha Manik d****k@g****e 7
Matthias Dahlmanns 5****l 2
Committer Domains (Top 20 + Academic)
gwdg.de: 1 ds.mpg.de: 1 tu-dresden.de: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 78
  • Total pull requests: 75
  • Average time to close issues: 7 months
  • Average time to close pull requests: 2 months
  • Total issue authors: 6
  • Total pull request authors: 7
  • Average comments per issue: 0.59
  • Average comments per pull request: 8.48
  • Merged pull requests: 56
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 3
  • Average time to close issues: about 5 hours
  • Average time to close pull requests: 2 months
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.5
  • Average comments per pull request: 1.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • fxjung (66)
  • debsankha (5)
  • matdahl (4)
  • s-bien (2)
  • karophia (1)
  • Btushir (1)
Pull Request Authors
  • fxjung (81)
  • debsankha (11)
  • Alex020796 (2)
  • matdahl (2)
  • danielskatz (2)
  • pmarszal (1)
  • xuanxu (1)
Top Labels
Issue Labels
bug (10) documentation (10) extras (9) enhancement (8) core (7) cython (4) cython/C++ (4) annoyance (3) wont fix for now (3) ongoing (2) analytics (2) graphs (2) meta (1) question (1) good first issue (1) batteries (1)
Pull Request Labels
enhancement (3) batteries (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 94 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 27
  • Total maintainers: 1
pypi.org: ridepy

Simulates a dispatching algorithm serving exogenous transportation requests with a fleet of vehicles. Does not simulate the universe, unlike MATSim. Batteries are included.

  • Versions: 27
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 94 Last month
Rankings
Dependent packages count: 7.0%
Average: 25.2%
Dependent repos count: 30.4%
Forks count: 30.6%
Stargazers count: 32.6%
Maintainers (1)
fxjung
Last synced: 4 months ago

Dependencies

.github/workflows/build-doc.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/configure-pages v3 composite
  • actions/setup-python v4 composite
  • actions/upload-pages-artifact v1 composite
.github/workflows/build-sdist.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
.github/workflows/build-wheel.yml actions
  • RalfG/python-wheels-manylinux-build v0.7.1-manylinux2014_x86_64 composite
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
.github/workflows/deploy-doc.yml actions
  • actions/deploy-pages v2 composite
.github/workflows/deploy-pypi.yml actions
  • actions/download-artifact v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/deploy-testpypi.yml actions
  • actions/download-artifact v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/python-testing.yml actions
  • EnricoMi/publish-unit-test-result-action v2 composite
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
pyproject.toml pypi
  • cython ==3.0a6
  • decorator *
  • jupytext *
  • loky *
  • matplotlib *
  • networkx *
  • notebook *
  • numpy *
  • pandas < 2
  • pyarrow *
  • scipy *
  • tabulate *
  • typer *
setup.py pypi