Metadata-Version: 2.1
Name: pyvrp
Version: 0.1.0
Summary: A state-of-the-art vehicle routing problem solver.
Home-page: https://github.com/N-Wouda/PyVRP
License: MIT
Author: Niels Wouda
Author-email: nielswouda@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Requires-Dist: matplotlib (>=2.2.0)
Requires-Dist: numpy (>=1.15.2)
Requires-Dist: tomli (>=2.0.1,<3.0.0)
Requires-Dist: tqdm (>=4.64.1,<5.0.0)
Requires-Dist: vrplib (>=1.0.0,<2.0.0)
Project-URL: Repository, https://github.com/N-Wouda/PyVRP
Project-URL: Tracker, https://github.com/N-Wouda/PyVRP/issues
Description-Content-Type: text/markdown

[![PyPI version](https://badge.fury.io/py/pyvrp.svg)](https://badge.fury.io/py/pyvrp)
[![CI](https://github.com/N-Wouda/pyvrp/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/N-Wouda/pyvrp/actions/workflows/CI.yml)
[![Documentation Status](https://readthedocs.org/projects/pyvrp/badge/?version=latest)](https://pyvrp.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/gh/N-Wouda/pyvrp/branch/main/graph/badge.svg?token=G9JKIVZOHB)](https://codecov.io/gh/N-Wouda/pyvrp)

# PyVRP

The `pyvrp` package is an open-source, state-of-the-art vehicle routing problem solver.

`pyvrp` may be installed in the usual way as
```
pip install pyvrp
```
This also resolves the few core dependencies `pyvrp` has.
The documentation is available [here][1].

> If you are new to metaheuristics or vehicle routing, you might benefit from reading the [introduction to HGS for VRP][6] page.

### Examples

We provide some example notebooks that show how the `pyvrp` package may be used to solve vehicle routing problems.
These include:

- The vehicle routing problem with time windows (VRPTW), [here][4].
  We solve several instances from the literature, including a large 1000 customer instance.
- The capacitated vehicle routing problem, [here][5].
  We solve an instance with 439 customers to near optimality within 30 seconds.

### Contributing

We are very grateful for any contributions you are willing to make. Please have
a look [here][2] to get started. If you aim to make a large change, it is
helpful to discuss the change first in a new GitHub issue. Feel free to open
one!

### Getting help

If you are looking for help, please follow the instructions [here][3].

### How to cite PyVRP

TODO


[1]: https://pyvrp.readthedocs.io/en/latest/

[2]: https://pyvrp.readthedocs.io/en/latest/dev/contributing.html

[3]: https://pyvrp.readthedocs.io/en/latest/setup/getting_help.html

[4]: https://pyvrp.readthedocs.io/en/latest/examples/vrptw.html

[5]: https://pyvrp.readthedocs.io/en/latest/examples/cvrp.html

[6]: https://pyvrp.readthedocs.io/en/latest/setup/introduction_to_hgs.html

