Python API Use Case Examples

The LGSVL Simulator teams has created sample Python scripts that use the LGSVL Simulator Python API to test specific scenarios or perform certain tasks. These example scripts can be found on our Github here.

Please contact us if you would like to contribute examples that you are using, or submit a pull request.

Scenarios top#

We have created basic sample scenarios using the Python API. See here for a step-by-step guide on how to run one of these scenarios. Several are based on the sample Test Cases from NHTSA.

The below scenarios assume that the simulator can be connected to an instance of Apollo 5.0. See the guide for getting connected with Apollo 5.0 here. The Apollo modules that need to be started are shown below (localization, perception, planning, prediction, routing, traffic light, transform, control):

It is recommended to start Apollo and the modules before running a scenario. Apollo's destination can be set after Localization and Routing have been started.

Vehicle Following top#

  • Scripts: Perform Vehicle Following
  • This scenario simulates the EGO vehicle approaching a slower NPC from behind. The EGO is expected to accelerate up to the speed limit and catch up to the NPC.

For this scenario, the destination is the end of the lane.

Encroaching Oncoming Vehicle top#

  • Scripts: Detect and Respond to Encroaching Oncoming Vehicle
  • This scenario simulates the EGO vehicle approaching an oncoming NPC that is half in the EGO's lane making a collision imminent. The EGO is expected to avoid a collision.
  • Here the NPC uses the waypoint system to define its path. With waypoints, the NPC ignores other traffic and does not attempt to avoid collisions.

For this scenario, the destinaion is the end of the lane. The same destination can be used as the Vehicle Following scripts.

Other Uses top#

Collecting data in KITTI format top#

  • Script:
  • This script shows an example of collecting data in the KITTI format. This data can be used to train for detecting vehicles in images.
  • This script spawns the ego vehicle in a random position in the San Francisco map. Then a number of NPC vehicles are randomly spawned in front of the ego vehicle. Camera and ground truth data is saved in the KITTI format. This data can be used to train for detecting vehicles in images.
  • For more information on KITTI please see: The data format is defined in a README file downloadable from:

Automated Driving System Test Cases top#

  • The United States National Highway Traffic Safety Administration released a report describing a framework for establishing sample preliminary tests. The report is available online: A Framework for Automated Driving System Testable Cases and Scenarios
  • We created several of the described tests available here: NHTSA-sample-tests
  • These tests run the ADS at different speeds. To accomplish this with Apollo, the speed limit in the HD map of the appropriate lanes needs to be adjusted and the planning configuration should also be changed to limit Apollo's top speed.
  • The ADS destination is described in the report. For our implementation of the Perform Lane Change tests, the same destination as the above Overtaker and Traffic Jam scenarios is used.