Scripts
=======

*Pyrate* contains a few scripts in the directory `pyrate/scripts/`.
They are mainly meant for actually applying the algorithms to real-world data and to also serve as some examples for the library code.

Requirements
------------

Most script documentation assumes the typical Sailing Team directory layout as described in
`the installation guide <https://gitlab.sailingteam.hg.tu-darmstadt.de/informatik/pyrate/-/wikis/Installation>`_.
To execute these programs, you need the datasets that you want to work with (if any).
Therefore, you will probably want to download the data repository as described
`here <https://gitlab.sailingteam.hg.tu-darmstadt.de/informatik/data/-/blob/master/README.md#installation>`_,
if you haven't already.


Usage
-----

This section just lists the parameters of the scrips. See :ref:`scripts-reference` for more complete explanations.


.. _script-s57_charts_to_db:

``s57_charts_to_db.py``
~~~~~~~~~~~~~~~~~~~~~~~

.. command-output:: ../../scripts/s57_charts_to_db.py --help


.. _script-benchmark_db_and_projections:

``benchmark_db_and_projections.py``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. command-output:: ../../scripts/benchmark_db_and_projections.py --help


.. _script-create_earth_graph:

``create_earth_graph.py``
~~~~~~~~~~~~~~~~~~~~~~~~~

.. command-output:: ../../scripts/create_earth_graph.py --help


.. _script-earth_graph_frequency_statistics:

``earth_graph_frequency_statistics.py``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. command-output:: ../../scripts/earth_graph_frequency_statistics.py --help


.. _script-visualize_earth_graph:

``visualize_earth_graph.py``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. command-output:: ../../scripts/visualize_earth_graph.py --help


.. _script-benchmark_graph_neighbor_search:

``benchmark_graph_neighbor_search.py``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. command-output:: ../../scripts/benchmark_graph_neighbor_search.py --help


Reference
---------

This section above just lists the usage of the scrips.
The complete API reference can be found below:

.. toctree::
   :maxdepth: 2

   reference