284-Feature-Document-the-usage-of-the-different-scenarios-available-to-test-the-vehicle

[ll7]

Description

Fixes #284

Add a readme to the build folder which describes the functionality.

TODO

• Maybe, docker-compose_dev_distributed.yaml is not correctly modified, as it should use the simple route.
  • referenced in new issue Verify that docker-compose_dev_distributed uses the correct simple route. #296
• correctly link this readme in the documentation folder.

[ll7]

I made the questionable design choice to add the Readme.md in the build folder and only link the readme in the development guidelines.

[ll7]

Verify that docker-compose_dev_distributed uses the correct simple route.
https://github.com/una-auxme/paf23/blob/844def35bb5725e62bb799c77da565f4d844964d/build/docker-compose_dev_distributed.yaml#L5-L12

[ll7]

@JulianTrommer please look at these changes. I will merge now without a review due to your absence.

[ll7]

I will not delete this branch until you reviewed these changes.

[github-actions]

Simulation results

Metric	Value
Avg. driving score	0.00757
Avg. route completion	9.62
Avg. infraction penalty	0.000822
Collisions with pedestrians	1.414
Collisions with vehicles	15.551
Collisions with layout	3.534
Red lights infractions	0.0
Stop sign infractions	0.0
Off-road infractions	0.008
Route deviations	0.0
Route timeouts	0.0
Agent blocked	1.414
Yield emergency vehicles infractions	0.0
Scenario timeouts	1.414
Min speed infractions	0.0

[github-actions]

Simulation results

Metric	Value
Avg. driving score	0.002399
Avg. route completion	35.6
Avg. infraction penalty	0.000246
Collisions with pedestrians	0.535
Collisions with vehicles	15.157
Collisions with layout	5.885
Red lights infractions	0.0
Stop sign infractions	0.178
Off-road infractions	0.2
Route deviations	0.0
Route timeouts	0.0
Agent blocked	0.357
Yield emergency vehicles infractions	0.0
Scenario timeouts	0.713
Min speed infractions	0.178

[github-actions]

Simulation results

Metric	Value
Avg. driving score	1.9e-05
Avg. route completion	37.425
Avg. infraction penalty	2e-06
Collisions with pedestrians	1.017
Collisions with vehicles	15.088
Collisions with layout	4.916
Red lights infractions	0.17
Stop sign infractions	0.339
Off-road infractions	0.162
Route deviations	0.0
Route timeouts	0.0
Agent blocked	0.339
Yield emergency vehicles infractions	0.0
Scenario timeouts	0.339
Min speed infractions	0.17

[github-actions]

Simulation results

Metric	Value
Avg. driving score	0.000618
Avg. route completion	38.06
Avg. infraction penalty	6.1e-05
Collisions with pedestrians	1.0
Collisions with vehicles	14.667
Collisions with layout	3.167
Red lights infractions	0.0
Stop sign infractions	0.333
Off-road infractions	0.09
Route deviations	0.167
Route timeouts	0.0
Agent blocked	0.167
Yield emergency vehicles infractions	0.0
Scenario timeouts	0.5
Min speed infractions	0.167