Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/intel/ad-rss-lib
Library implementing the Responsibility Sensitive Safety model (RSS) for Autonomous Vehicles
https://github.com/intel/ad-rss-lib
autonomous-vehicles rss safety
Last synced: about 2 months ago
JSON representation
Library implementing the Responsibility Sensitive Safety model (RSS) for Autonomous Vehicles
- Host: GitHub
- URL: https://github.com/intel/ad-rss-lib
- Owner: intel
- License: lgpl-2.1
- Created: 2019-02-13T00:02:25.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T16:03:05.000Z (about 2 months ago)
- Last Synced: 2024-08-02T17:22:38.776Z (about 2 months ago)
- Topics: autonomous-vehicles, rss, safety
- Language: C++
- Homepage: https://intel.github.io/ad-rss-lib/
- Size: 260 MB
- Stars: 331
- Watchers: 29
- Forks: 138
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-robotic-tooling - ad-rss-lib - Library implementing the Responsibility Sensitive Safety model (RSS) for Autonomous Vehicles. (Behavior and Decision / Vector Map)
README
C++ Library for Responsibility Sensitive Safety
=====
[](https://opensource.org/licenses/LGPL-2.1)
[](https://github.com/intel/ad-rss-lib/releases/latest)
[](https://github.com/intel/ad-rss-lib/actions/workflows/build_test.yml/badge.svg?branch=main)
[](https://www.bestpractices.dev/projects/8374)
[](https://securityscorecards.dev/viewer/?uri=github.com/intel/ad-rss-lib)
# Table of contents
1. [Introduction](#introduction)
2. [License](#license)
3. [Documentation](#documentation)
4. [Releases](#releases)
1. [Release 4.x](#release_4)
2. [Release 3.x](#release_3)
3. [Release 2.x](#release_2)
4. [Release 1.x](#release_1)
5. [Getting Started](#started)
1. [Supported Systems](#systems)
6. [Building the library](#building)
7. [Contributing](#contributing)
## Introduction
This library intends to provide a C++ implementation of the Responsibility Sensitive Safety model (RSS) for Automated Vehicles.
RSS is described in the following paper. Potential users of this C++ library are encouraged to read these papers in order to become familiar with the concepts and functions provided by the library.
* On a Formal Model of Safe and Scalable Self-driving Cars, S. Shalev-Shwartz, S. Shammah, A. Shashua, Mobileye, arXiv:1708.06374, [https://arxiv.org/abs/1708.06374](https://arxiv.org/abs/1708.06374)
The RSS module in this library receives (processed) sensor information as input and provides actuator command restrictions as output. The input to the RSS module is an object list, with information about all objects (road agents) in the surrounding environment of the ego vehicle. For each object, the RSS module creates a description of the object-ego vehicle pair and their properties, called a "situation". For each situation, the relevant RSS safety checks are performed and a proper response is calculated. Finally, one overall response is obtained by combining the responses calculated for each object-ego vehicle situation. The resulting actuation command restrictions, in the form of longitudinal and lateral limits on acceleration are provided as output.
The ad_rss library contains a stand-alone C++ implementation of the RSS module.
* Conversion of AV sensor data to the input object list required by the RSS module is outside the scope of the ad_rss library. This includes conversion of object location and motion in a Cartesian world coordinate system into a constellation based coordinate system.
* Conversion of the output proper response and acceleration restrictions to real AV actuation commands (enforcing the restrictions) is outside the scope of this library. This conversion depends strongly on the software and hardware setup of the actual (or simulated) vehicle.
The scope, design and architecture of this C++ library for RSS is described in more detail in the following document packaged with this release. This documentation includes guidance on the usage of the RSS library and its integration into a automated driving system. Users of this library are strongly encouraged to read this documentation prior to integration of the library.
### Integrating RSS with automated driving maps
When RSS is to be integrated into a larger system it is usually up to the user implementation to provide the required input into RSS based on the environment information
available within the system. The [*ad_rss_map_integration*](https://intel.github.io/ad-rss-lib/ad_rss_map_integration/Main/) library provides an example C++ implementation
for integrating RSS with automated driving maps.
### Usage of ad-rss-lib
If you use ad-rss-lib for any publication, please cite the IV'2019 paper:
```
@INPROCEEDINGS{
title={Towards Standardization of AV Safety: C++ Library for Responsibility Sensitive Safety}
author={Gassmann, Bernd and Oboril, Fabian and Buerkle, Cornelius and Liu, Shuang and Yan, Shoumeng and Elli, Maria Soledad and Alvarez, Ignacio and Aerrabotu, Naveen and Jaber, Suhel and van Beek, Peter and Iyer, Darshan and Weast, Jack}
booktitle={2019 IEEE Intelligent Vehicles Symposium (IV)}
year={2019}
}
```
#### Usage with Python
Starting with Release v1.6, it is possible to use the ad-rss-lib library also with Python.
Please see the [Documentation on the Python binding for ad_rss](https://intel.github.io/ad-rss-lib/ad_rss/ad_rss_python/index.html) or [ad_rss_map_integration_python](https://intel.github.io/ad-rss-lib/ad_rss_map_integration/ad_rss_map_integration_python/index.html) for further information.
#### Usage within CARLA
This library can be used together with the open-source driving simulator [CARLA](https://github.com/carla-simulator/carla) to investigate the behavior of RSS. A first version is shown in the following video sequence:
[](https://www.youtube.com/watch?v=UxKPXPT2T8Q)
#### Usage within Baidu Apollo
In addition, the library is already integrated and used in Baidu's [Apollo Open Platform stack](https://github.com/ApolloAuto/apollo):
## License
This software library is provided under the LGPL-2.1 open-source license: https://opensource.org/licenses/LGPL-2.1.
In addition, the terms in the following apply:
[RELEASE NOTES AND DISCLAIMERS](./RELEASE_NOTES_AND_DISCLAIMERS.md).
## Documentation
Visit the project's [GitHub page](https://intel.github.io/ad-rss-lib/) to access the online version of the full documentation of this library. This includes:
* [Doxygen](https://intel.github.io/ad-rss-lib/doxygen/ad_rss/index.html)
* [Background documentation](https://intel.github.io/ad-rss-lib/ad_rss/Overview/).
* [Integrate RSS with AD map data](https://intel.github.io/ad-rss-lib/ad_rss_map_integration/Main/) and respective [Doxygen](https://intel.github.io/ad-rss-lib/doxygen/ad_rss_map_integration/index.html).
If you have any additional question not answered therein, you might find more in the [FAQ](https://intel.github.io/ad-rss-lib/FAQ/index.html)
## Releases
General release notes and changes can be found in the [Changelog](https://intel.github.io/ad-rss-lib/CHANGELOG/index.html)
#### Release 4.x.x
These releases extends the 3.x version with handling of unstructured roads and pedestrians.
#### Release 3.x.x
These releases improve the 2.x version capabilities on constellation creation.
#### Release 2.x.x
These releases extend the 1.x version with map integration for extended usability.
#### Release 1.x.x
The initial release of the C++ software library for RSS implements a subset of the rules and calculations specified in the published RSS paper. This means that this release handles a subset of automated driving scenarios, described below. Scenarios other than this subset cannot be handled.
##### Features & Limitations
This release implements the RSS calculations and rules corresponding to the following scenarios:
* Multi-lane roads, i.e. longitudinal and lateral safe distance and proper response determination; and
* Intersections, i.e. two or more routes of different geometry, rules for intersections of routes, with priority/right of way, and longitudinal and lateral proper response determination. However, in the case of intersections, it is assumed that there is always a lateral conflict; and
* Unstructured roads and pedestrians.
The following parts of RSS are NOT implemented in this release of the library software:
* Occlusions;
* Longitudinal or lateral evasive maneuvers as defined by RSS; and
* Intersections without a lateral conflict.
Note: The RSS module in this library does not initiate evasive manuevers. At the same time, it would not hinder an evasive manuever being executed by the AV driving policy and planning modules, as long as it is compliant with the required RSS proper response.
#### Installation of dependencies
Currently, the focused operating systems are Ubuntu 20.04 and Ubuntu 22.04. Nevertheless, the library should work in a similar way for any other Linux OS.
To install the basic dependencies for Ubuntu 20.04/22.04 execute the following command:
```bash
user$> sudo apt-get install git build-essential cmake libboost-dev libpugixml-dev libgtest-dev libpython-dev libproj-dev
```
If you want to use doxygen for API documentation, please also install:
```bash
user$> sudo apt-get install doxygen graphviz
```
#### Get the library
To download the library, you may run:
```bash
user$> git clone https://github.com/intel/ad-rss-lib.git
user$> cd ad-rss-lib
```
#### Supported systems
Development systems are Ubuntu 20.04 and Ubuntu 22.04
Following compiler and Python combinations are [tested continously](https://github.com/intel/ad-rss-lib/blob/main/.github/workflows/build_test.yml):
| | Ubuntu 20.04 | Ubuntu 22.04 |
|:---------------:|:------------:|:------------:|
| GCC 9 | x | |
| Clang 10 | x | |
| GCC 11 | | x |
| Clang 14 | | x |
| Python 3.8 | x | |
| Python 3.10 | x | x |
Important: cmake is required to be at least version 3.5!
## Building the library
See the detailed [Build instructions](https://intel.github.io/ad-rss-lib/BUILDING/index.html).
## Contributing
Contibutions are very welcome!
Before submitting a pull request, please ensure that your code compiles successfully and that the tests run successfully.
In case new functionality is added, please also take care on adding appropriate unit tests. The reported code coverage should not fall below 80%.
Please also check that your code formatting complies to the provided clang style. To do so, you can run:
```bash
ad-rss-lib$> sudo apt-get install clang-format-14
ad-rss-lib$> find -iname *.cpp -o -iname *.hpp | xargs clang-format-14 -style=file -i
```
This command will automatically update the code formatting to be compliant with our style.
In addition, please perform a static code analysis, if possible.
```bash
ad-rss-lib$> sudo apt-get install clang-tidy
ad-rss-lib$> cmake -DBUILD_STATIC_ANALYSIS=ON
ad-rss-lib$> make clang-tidy
```
This may provide a list of possible improvements that you would like to consider in your pull request.