Metadata-Version: 2.1
Name: ridepy
Version: 2.7.0.post1
Summary: Simulates a dispatching algorithm serving exogenous transportation requests with a fleet of vehicles. Does not simulate the universe, unlike MATSim. Batteries are included.
Author-email: Felix Jung <felix.jung@tu-dresden.de>, Debsankha Manik <dmanik@debsankha.net>
Project-URL: Homepage, https://ridepy.org/
Project-URL: Documentation, https://ridepy.org/
Project-URL: Repository, https://github.com/PhysicsOfMobility/ridepy/
Keywords: simulation,ridepooling,mobility,transport,physics
Classifier: Intended Audience :: Science/Research
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Cython
Classifier: Programming Language :: C++
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: decorator
Requires-Dist: networkx
Requires-Dist: numpy
Requires-Dist: pandas<2
Requires-Dist: scipy
Requires-Dist: tabulate
Requires-Dist: notebook
Requires-Dist: jupytext
Requires-Dist: matplotlib
Requires-Dist: cython==3.0a6
Requires-Dist: loky
Requires-Dist: typer
Requires-Dist: pyarrow
Requires-Dist: tqdm
Provides-Extra: dev
Requires-Dist: black==24.3.0; extra == "dev"
Requires-Dist: commitizen; extra == "dev"
Requires-Dist: pdbpp; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: hypothesis; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: wheel; extra == "dev"
Requires-Dist: tox; extra == "dev"
Requires-Dist: psutil; extra == "dev"
Requires-Dist: check-manifest; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: auditwheel; extra == "dev"
Requires-Dist: blacken-docs; extra == "dev"
Requires-Dist: pygit2; extra == "dev"
Requires-Dist: tomli; extra == "dev"
Requires-Dist: tomli-w; extra == "dev"
Requires-Dist: packaging; extra == "dev"
Requires-Dist: python-gnupg; extra == "dev"
Provides-Extra: doc
Requires-Dist: recommonmark; extra == "doc"
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: sphinx-rtd-theme; extra == "doc"
Requires-Dist: sphinx-toggleprompt; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
Requires-Dist: myst-nb; extra == "doc"

|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
