lgsvl - A Python API for SVL Simulator

This folder contains lgsvl, a Python API for SVL Simulator.

Documentation

Documentation is available on our website: https://www.svlsimulator.com/docs/python-api/

Requirements

• Python 3.6 or higher
• Pip 21.1.1 or higher (install using python3 -m pip install 'pip>=21.1.1')

Installing

python3 -m pip install -r requirements.txt --user .

# install in development mode
python3 -m pip install -r requirements.txt --user -e .

Do not use the legacy python3 setup.py install nor pip3 install.

NOTE: If you are using release 2020.06 of SVL Simulator, you must switch to the release-2020.06 branch of this repository prior to installing:

git checkout -b release-2020.06

We encourage you to migrate to release 2021.1 of SVL Simulator soon as it is feasible/practical to do so.

Examples

Look into quickstart and examples folders for simple usages. To run these examples, first make sure that these assets have been added to your Library:

and that the plugins required by these vehicle sensor configurations have been added to your Library:

Then launch a simulation on a local cluster selecting the API Only template.

By default, the examples expect to be able to connect to SVL Simulator using the localhost address. To change it, set the LGSVL__SIMULATOR_HOST environment variable to the hostname or IP address of the network interface of the machine running SVL Simulator to which the examples should connect.

Running unit tests

To run the unit tests, first make sure that these assets have been added to your Library:

and that the plugins required by these vehicle sensor configurations have been added to your Library:

Then launch an API Only simulation before running the unit tests.

By default, the unit tests expect to be able to connect to SVL Simulator using the localhost address. To change it, set the LGSVL__SIMULATOR_HOST environment variable to the hostname or IP address of the network interface of the machine running SVL Simulator to which the unit tests should connect.

# run all unittests
python3 -m unittest discover -v -c

# run single test module
python3 -m unittest -v -c tests/test_XXXX.py

# run individual test case
python3 -m unittest -v tests.test_XXX.TestCaseXXX.test_XXX
python3 -m unittest -v tests.test_Simulator.TestSimulator.test_unload_scene

Creating test coverage report

# (one time only) install coverage.py
pip3 install --user coverage

# run all tests with coverage
~/.local/bin/coverage run -m unittest discover

# generate html report
~/.local/bin/coverage html --omit "~/.local/*","tests/*"

# output is in htmlcov/index.html

Tagging releases

The final change for a new release must be to set the argument of the get_version('<VERSION>') call in setup.py to the new version. Then commit this change and tag it with the new version:

git tag -a -m <VERSION> <VERSION>

Copyright and License

Copyright (c) 2018-2021 LG Electronics, Inc.

This software contains code licensed as described in LICENSE.