behavior_generation_lecture_python's Introduction

Python Code for the Lecture "Verhaltensgenerierung für Fahrzeuge" (Behavior Generation for Vehicles) at KIT

This repository contains the python code for the lecture "Verhaltensgenerierung für Fahrzeuge" (Behavior Generation for Vehicles) at KIT. It is targeted towards both, exemplifying the content of the lecture, and giving a brief introduction to software development. (Please bare with us, the code is largely ported from matlab.)

Preparing the environment

We encourage the usage of conda or virtualenv instead of installing packages to your system directly.

Having activated your environment

install this package in editable mode: pip install --editable .

Making venv kernels available to jupyter?

from without the venv, install ipykernel pip install --user ipykernel
list the current venvs available in jupyter: jupyter kernelspec list (your venv is not yet in there)
activate the venv source activate venv-name
add the venv to the kernel list: python -m ipykernel install --user --name=venv-name-for-jupyter, where venv-name-for-jupyter can but must not match the name of the activated venv
check that the venv is in the list: jupyter kernelspec list

Structure

The structure of this repo is inspired by the PyPA sample project.

src contains the modules, which is the core implementation, at best browsed in your favorite IDE
tests contains unittests, at best browsed in your favorite IDE
scripts contains scripts that depict exemplary usage of the implemented modules, they can be run from the command line
notebooks contains jupyter notebooks, that can be browsed online, and interactively be run using jupyter

Contribution

Feel free to open an issue if you found a bug or have a request. You can also contribute to the lecture code yourself: Just fork this repository and open a pull request.