PyVRP
=====

TODO

.. hint::

    If you are new to metaheuristics or vehicle routing, you might benefit from first reading the :doc:`introduction to HGS for VRP <setup/introduction_to_hgs>`.
    To set up an installation from source, or to run the examples listed below yourself, please have a look at the :doc:`installation instructions <setup/installation>`.

.. toctree::
   :maxdepth: 1
   :caption: Getting started

   setup/introduction_to_hgs
   setup/installation
   setup/getting_help
   setup/benchmarks

.. toctree::
   :maxdepth: 1
   :caption: Examples

   examples/vrptw
   examples/cvrp

.. toctree::
   :maxdepth: 1
   :caption: API reference

   api/pyvrp
   api/crossover
   api/diagnostics
   api/diversity
   api/educate
   api/plotting
   api/stop

.. toctree::
   :maxdepth: 1
   :caption: Developing PyVRP

   dev/contributing
   dev/benchmarking