README

# 2d-truck-simulator

Simple overview of use/purpose.
This simulator was designed with the purpose to develop and run tragectory planning
algorithms for vehicles, specifically trucks with trailers. It feature connectors
(bindings) to ROS2 (Humble) as well as visualization that can be turned off.

## Description

An in-depth paragraph about your project and overview of use.
The simulator was created with the goal of developing and running tragectory planning
algorithms. It features basic sensor and controls that would be required for these
topics.

## Getting Started

### Dependencies

* Python3.12
* Pip
* Python virtual enviroment
* ROS2 Humble

For Ubuntu24.04 the following package is also required: libxcb-xinerama0

The python dependacies can be installed with:
```
sudo apt install python3-pip python3.12-venv
```

For ROS Humble follow the official instalation (optional). https://docs.ros.org/en/humble/index.html

### Installing

The following python packages are required:
```
python3 -m venv env
source env/bin/activate
pip3 install -r requirements.txt
```

* How/where to download your program
* Any modifications needed to be made to files/folders

### Executing program

```
./src/Main --graphical --ros
```

## Help

Any advise for common problems or issues.
```
command to run if program contains helper info
```

## Authors

Contributors names and contact info

  Paraskevas Karachatzis

## License

This project is licensed under the GPL2 License - see the LICENSE.md file for details

## Acknowledgments

Inspiration, code snippets, etc.
* turtlesim (https://github.com/ros/ros_tutorials)