| Name | ridepy JSON |
| Version |
2.10
JSON |
| download |
| home_page | None |
| Summary | Simulates a dispatching algorithm serving exogenous transportation requests with a fleet of vehicles. Does not simulate the universe, unlike MATSim. Batteries are included. |
| upload_time | 2024-08-16 15:46:18 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | ~=3.9 |
| license | None |
| keywords |
simulation
ridepooling
mobility
transport
physics
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
|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 <ridepy doc_>`__ to get started. You might also be interested in our `paper <https://doi.org/10.21105/joss.06241>`__ published in the Journal of Open Source Software.
Quickstart
----------
For detailed instructions, see the `installation guide <https://ridepy.org/howto/install-ridepy>`__ 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 <https://www.boost.org/>`__. 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 <https://ridepy.org/howto/report-an-issue>`__ or `ask for help <https://ridepy.org/howto/obtain-support>`__.
If you are interested in contributing to our codebase, please read our `contributing guide <https://ridepy.org/howto/contribute>`__.
Here is a short overview of the most important points:
Resources
~~~~~~~~~
- Documentation: `ridepy.org <ridepy doc_>`__
- Source code: `GitHub <https://github.com/PhysicsOfMobility/ridepy>`__
- Issue tracker: `GitHub <https://github.com/PhysicsOfMobility/ridepy/issues>`__
Code style
~~~~~~~~~~
- Python: `black <https://github.com/psf/black>`__
- C++: `LLVM <https://llvm.org/docs/CodingStandards.html>`__
Development
~~~~~~~~~~~
- Version control: `Git <https://git-scm.com/>`__
- Testing: `pytest <https://docs.pytest.org/en/stable/>`__
- Continuous integration: `GitHub Actions <https://github.com/PhysicsOfMobility/ridepy/actions>`__
- Versioning: `Semantic Versioning <https://semver.org/>`__
.. 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
Raw data
{
"_id": null,
"home_page": null,
"name": "ridepy",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.9",
"maintainer_email": null,
"keywords": "simulation, ridepooling, mobility, transport, physics",
"author": null,
"author_email": "Felix Jung <felix.jung@tu-dresden.de>, Debsankha Manik <dmanik@debsankha.net>",
"download_url": "https://files.pythonhosted.org/packages/2e/c5/258edb10188bba9e0fcd8782a7b86b0b22edbf6fb9d32bbc9f26bd5892c8/ridepy-2.10.tar.gz",
"platform": null,
"description": "|joss| |Code style: black| |Tests| |Docs| |wheel| |sdist|\n\nRidePy\n======\n\nRidePy is a scientific Python library for simulating modern on-demand transit systems such as ridepooling.\n\nIn 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.\n\nHead over to `ridepy.org <ridepy doc_>`__ to get started. You might also be interested in our `paper <https://doi.org/10.21105/joss.06241>`__ published in the Journal of Open Source Software.\n\nQuickstart\n----------\n\nFor detailed instructions, see the `installation guide <https://ridepy.org/howto/install-ridepy>`__ in the documentation.\n\nIf you're in a hurry, here's the gist:\n\n- RidePy currently works best with Python 3.9\n- 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 <https://www.boost.org/>`__. On Debian-like systems, this is easily accomplished with\n\n.. code-block:: bash\n\n sudo apt-get install build-essential libboost-all-dev\n\n- Install RidePy with\n\n.. code-block:: bash\n\n pip install ridepy\n\nContributing\n------------\n\nWe are always happy for contributions from the community. If you run into a problem, please `report an issue <https://ridepy.org/howto/report-an-issue>`__ or `ask for help <https://ridepy.org/howto/obtain-support>`__.\n\nIf you are interested in contributing to our codebase, please read our `contributing guide <https://ridepy.org/howto/contribute>`__.\n\nHere is a short overview of the most important points:\n\nResources\n~~~~~~~~~\n\n- Documentation: `ridepy.org <ridepy doc_>`__\n- Source code: `GitHub <https://github.com/PhysicsOfMobility/ridepy>`__\n- Issue tracker: `GitHub <https://github.com/PhysicsOfMobility/ridepy/issues>`__\n\nCode style\n~~~~~~~~~~\n\n- Python: `black <https://github.com/psf/black>`__\n- C++: `LLVM <https://llvm.org/docs/CodingStandards.html>`__\n\nDevelopment\n~~~~~~~~~~~\n\n- Version control: `Git <https://git-scm.com/>`__\n- Testing: `pytest <https://docs.pytest.org/en/stable/>`__\n- Continuous integration: `GitHub Actions <https://github.com/PhysicsOfMobility/ridepy/actions>`__\n- Versioning: `Semantic Versioning <https://semver.org/>`__\n\n.. http://mozillascience.github.io/working-open-workshop/contributing/\n\n..\n ---------\n Badges\n ---------\n\n.. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n\n.. |Docs| image:: https://github.com/PhysicsOfMobility/ridepy/actions/workflows/build-doc.yml/badge.svg\n :target: https://github.com/PhysicsOfMobility/ridepy/actions/workflows/build-doc.yml\n\n.. |Tests| image:: https://github.com/PhysicsOfMobility/ridepy/actions/workflows/python-testing.yml/badge.svg\n :target: https://github.com/PhysicsOfMobility/ridepy/actions/workflows/python-testing.yml\n\n.. |wheel| image:: https://github.com/PhysicsOfMobility/ridepy/actions/workflows/build-wheel.yml/badge.svg\n :target: https://github.com/PhysicsOfMobility/ridepy/actions/workflows/build-wheel.yml\n\n.. |sdist| image:: https://github.com/PhysicsOfMobility/ridepy/actions/workflows/build-sdist.yml/badge.svg\n :target: https://github.com/PhysicsOfMobility/ridepy/actions/workflows/build-sdist.yml\n\n.. |joss| image:: https://joss.theoj.org/papers/10.21105/joss.06241/status.svg\n :target: https://doi.org/10.21105/joss.06241\n\n.. _ridepy doc: https://ridepy.org\n",
"bugtrack_url": null,
"license": null,
"summary": "Simulates a dispatching algorithm serving exogenous transportation requests with a fleet of vehicles. Does not simulate the universe, unlike MATSim. Batteries are included.",
"version": "2.10",
"project_urls": {
"Documentation": "https://ridepy.org/",
"Homepage": "https://ridepy.org/",
"Repository": "https://github.com/PhysicsOfMobility/ridepy/"
},
"split_keywords": [
"simulation",
" ridepooling",
" mobility",
" transport",
" physics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eadd7b3d3b4f0b9dcfb93da52a84e3177a0e6818c00b5e1648099ccf710c8547",
"md5": "932b715b5324602f3f0f142f1c2d8d0c",
"sha256": "ac3e0723d4e079707dd6c55841c16de6b24f350d519bf1eb3a97d51e3239581b"
},
"downloads": -1,
"filename": "ridepy-2.10-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "932b715b5324602f3f0f142f1c2d8d0c",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": "~=3.9",
"size": 3789326,
"upload_time": "2024-08-16T15:46:17",
"upload_time_iso_8601": "2024-08-16T15:46:17.160223Z",
"url": "https://files.pythonhosted.org/packages/ea/dd/7b3d3b4f0b9dcfb93da52a84e3177a0e6818c00b5e1648099ccf710c8547/ridepy-2.10-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2ec5258edb10188bba9e0fcd8782a7b86b0b22edbf6fb9d32bbc9f26bd5892c8",
"md5": "584971807e88687fe14ec6dc0f0b5466",
"sha256": "0cec602e5a29bdc425bfa22c402d51b9817ce34ea2acbc98163805d16564d21b"
},
"downloads": -1,
"filename": "ridepy-2.10.tar.gz",
"has_sig": false,
"md5_digest": "584971807e88687fe14ec6dc0f0b5466",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.9",
"size": 109745,
"upload_time": "2024-08-16T15:46:18",
"upload_time_iso_8601": "2024-08-16T15:46:18.687970Z",
"url": "https://files.pythonhosted.org/packages/2e/c5/258edb10188bba9e0fcd8782a7b86b0b22edbf6fb9d32bbc9f26bd5892c8/ridepy-2.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-16 15:46:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PhysicsOfMobility",
"github_project": "ridepy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "ridepy"
}
