Scenario Runner
===============

| A utility to run scenarios, repeat them and output the results to a csv file.
| To use define a list of scenarios (objects of class: :class:`~discopygal.experiments.scenarios_runner.Scenario`) and invoke the function :func:`~discopygal.experiments.scenarios_runner.run_scenarios`

.. automodule:: discopygal.experiments.scenarios_runner
    :members:
    :no-undoc-members:

Example
-------

::

    from discopygal.experiments.scenarios_runner import run_scenarios, Scenario
    from discopygal.solvers.rrt.drrt_star import dRRT_star

    SCENE_PATH = "examples/scenes/2_pocket_maze_tight.json"

    scenarios = [Scenario(dRRT_star, SCENE_PATH, {"prm_num_landmarks": 200, "num_expands": 40}),
                 Scenario(dRRT_star, SCENE_PATH, {"prm_num_landmarks": 2000}),
                 Scenario(dRRT_star, SCENE_PATH, repetitions=5),
                 Scenario(dRRT_star, SCENE_PATH, {"prm_num_landmarks": 100}, 30, 20)]

    run_scenarios(scenarios, "results_drrt_star.csv")