Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ShisatoYano/AutonomousVehicleControlBeginnersGuide

Python sample codes and documents about Autonomous vehicle control algorithm. In the future, I want to release these ones as my own technical book for beginners.
https://github.com/ShisatoYano/AutonomousVehicleControlBeginnersGuide

algorithm autonomous-driving autonomous-navigation autonomous-vehicles calibration localization mapping object-detection object-tracking path-planning path-tracking perception python slam

Last synced: 2 months ago
JSON representation

Python sample codes and documents about Autonomous vehicle control algorithm. In the future, I want to release these ones as my own technical book for beginners.

Host: GitHub
URL: https://github.com/ShisatoYano/AutonomousVehicleControlBeginnersGuide
Owner: ShisatoYano
License: mit
Created: 2022-07-01T14:00:16.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-03-28T09:58:50.000Z (3 months ago)
Last Synced: 2024-03-29T09:43:53.526Z (3 months ago)
Topics: algorithm, autonomous-driving, autonomous-navigation, autonomous-vehicles, calibration, localization, mapping, object-detection, object-tracking, path-planning, path-tracking, perception, python, slam
Language: Python
Homepage:
Size: 111 MB
Stars: 57
Watchers: 3
Forks: 6
Open Issues: 1
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Lists

awesome-mobile-robotics - Autonomous Vehicle Control Beginners Guide

README

        # AutonomousVehicleControlBeginnersGuide

[![Linux_CI](https://github.com/ShisatoYano/AutonomousDrivingSamplePrograms/actions/workflows/Linux_CI.yml/badge.svg)](https://github.com/ShisatoYano/AutonomousDrivingSamplePrograms/actions/workflows/Linux_CI.yml) [![Windows_CI](https://github.com/ShisatoYano/AutonomousDrivingSamplePrograms/actions/workflows/Windows_CI.yml/badge.svg)](https://github.com/ShisatoYano/AutonomousDrivingSamplePrograms/actions/workflows/Windows_CI.yml) [![MacOS_CI](https://github.com/ShisatoYano/AutonomousDrivingSamplePrograms/actions/workflows/MacOS_CI.yml/badge.svg)](https://github.com/ShisatoYano/AutonomousDrivingSamplePrograms/actions/workflows/MacOS_CI.yml) [![CodeFactor](https://www.codefactor.io/repository/github/shisatoyano/autonomousvehiclecontrolbeginnersguide/badge)](https://www.codefactor.io/repository/github/shisatoyano/autonomousvehiclecontrolbeginnersguide)  

Python sample codes and documents about Autonomous vehicle control algorithm. In the future, I want to release these ones as my own technical book for beginners.  

## Table of Contents

* [What is this?](#what-is-this)

* [Goal of this project](#goal-of-this-project)

* [Requirements](#requirements)

* [How to use](#how-to-use)

* [Examples of Simulation](#examples-of-simulation)

    * [Localization](#localization)

        * [Extended Kalman Filter Localization](#extended-kalman-filter-localization)

    * [Mapping](#mapping)

        * [NDT Map Construction](#ndt-map-construction)

    * [Path Tracking](#path-tracking)

        * [Pure pursuit Path Tracking](#pure-pursuit-path-tracking)

    * [Perception](#perception)

        * [Rectangle fitting Detection](#rectangle-fitting-detection)

        * [Sensor's Extrinsic Parameters Estimation](#sensors-extrinsic-parameters-estimation)

* [License](#license)

* [Use Case](#use-case)

* [Contribution](#contribution)

* [Author](#author)

## What is this?

This is a sample codes collections about Autonomous vehicle control algorithm. Each source codes are implemented with Python to help your understanding. You can fork this repository and use for studying, education or work freely.  

## Goal of this project

I want to release my own technical book about Autonomous Vehicle algorithms in the future. The book will include all of codes and documents in this repository as contents.  

## Requirements

For running each sample codes:  

* [Python 3.11.x](https://www.python.org/)

* [Matplotlib](https://matplotlib.org/)

* [NumPy](https://numpy.org/)

* [SciPy](https://scipy.org/)

For development:

* [pytest](https://docs.pytest.org/en/7.4.x/) (for unit tests)

* [pytest-cov](https://github.com/pytest-dev/pytest-cov) (for coverage measurement)

For setting up the environment with Docker:

* [VS Code](https://code.visualstudio.com/)

* [Docker](https://www.docker.com/)

* [WSL](https://learn.microsoft.com/en-us/windows/wsl/)

## How to use

1. Clone this repository  

    ```bash

    $ git clone https://github.com/ShisatoYano/AutonomousVehicleControlBeginnersGuide

    ```

2. Set up the environment for running each codes

    * Set up on your local directory:

        ```bash

        $ pip install -r requirements.txt

        ```

    * Set up with Docker on WSL:

        * Before cloning thi repo, [install WSL](https://learn.microsoft.com/en-us/windows/wsl/install) and [Docker](https://docs.docker.com/desktop/install/linux-install/) in advance

        * Clone this repo following the above Step 1

        * Open this repo's folder by VSCode

        * [Create Dev Container](https://code.visualstudio.com/docs/devcontainers/create-dev-container)

        * And then, all required libraries are installed automatically

3. Execute unit tests to confirm the environment were installed successfully

    ```bash

    $ . run_test_suites.sh

    ```

4. Execute a python script at src/simulations directory

    * For example, when you want to execute localization simulation of Extended Kalman Filter:

        ```bash

        $ python src/simulations/localization/extended_kalman_filter_localization/extended_kalman_filter_localization.py

        ```

5. Add star to this repository if you like it!!

## Examples of Simulation

### Localization

#### Extended Kalman Filter Localization

![](src/simulations/localization/extended_kalman_filter_localization/extended_kalman_filter_localization.gif)  

### Mapping

#### NDT Map Construction

![](src/simulations/mapping/ndt_map_construction/ndt_map_construction.gif)  

### Path Tracking

#### Pure pursuit Path Tracking

![](src/simulations/path_tracking/pure_pursuit_path_tracking/pure_pursuit_path_tracking.gif)  

### Perception

#### Rectangle fitting Detection

![](src/simulations/perception/point_cloud_rectangle_fitting/point_cloud_rectangle_fitting.gif)  

#### Sensor's Extrinsic Parameters Estimation

Estimation by Unscented Kalman Filter  

![](src/simulations/perception/sensor_auto_calibration/sensor_auto_calibration.gif)  

## License

MIT  

## Use Case

I started this project to study an algorithm and software development for Autonomous Vehicle system by myself. You can also use this repo for your own studying, education, researching and development.  

If this project helps your task, please let me know by creating a issue.  

Any paper, animation, video as your output, always welcome!! It will encourage me to continue this project.  

## Contribution

Any contribution by creating an issue or sending a pull request is welcome!! Please check [this document about how to contribute](/HOWTOCONTRIBUTE.md).  

## Author

[Shisato Yano](https://github.com/ShisatoYano)