Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/commonroad/commonroad-reachable-set
This repository holds code related to the computation of reachable sets for autonomous vehicles
https://github.com/commonroad/commonroad-reachable-set
Last synced: about 2 months ago
JSON representation
This repository holds code related to the computation of reachable sets for autonomous vehicles
- Host: GitHub
- URL: https://github.com/commonroad/commonroad-reachable-set
- Owner: CommonRoad
- License: bsd-3-clause
- Created: 2024-02-19T07:30:27.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-10-21T20:22:48.000Z (3 months ago)
- Last Synced: 2024-10-22T14:44:50.110Z (3 months ago)
- Language: Jupyter Notebook
- Homepage:
- Size: 15.9 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# CommonRoad-Reach: A Toolbox for Reachability Analysis of Automated Vehicles
Reachability analysis has gained increasing popularity in motion planning and safeguarding of automated vehicles (AVs).
While existing tools for reachability analysis mainly focus on general-purpose algorithms for formal verification
of dynamical systems, a toolbox tailored to AV-specific applications is not yet available.
The CommonRoad-Reach toolbox
- integrates different methods for computing reachable sets using polytopic set propagation and graph-based propagation;
- provides Python and C++ implementations of the algorithms, thus offering convenient prototyping and real-time computation for the users; and
- extracts driving corridors which can be used as planning constraints for motion planners.
## System Requirements
The software is written in Python 3.10 and C++17, and was tested on Ubuntu 18.04, 20.04 and 22.04.
It should be compatible with later versions.
For building the code, the following minimum versions are required:
* **GCC and G++**: version 10 or above
* **CMake**: version 3.20 or above.
* **Pip**: version 21.3 or above
We further recommend using [Anaconda](https://www.anaconda.com/) to manage your virtual python environment.
## Installation options
We provide two installation options for CommonRoad-Reach: Installation as a Python package or building from source.
1. **Python Package**: Install the python package via `pip` in your Conda environment:
```bash
pip install commonroad-reach
```
2. **Build from source**: To build the project from source and install it in your Conda environment, please refer to the [README_FOR_DEVS](./README_FOR_DEVS.md).
This option is only recommended for advanced users and those who are looking to contribute to the development of CommonRoad-Reach.
## Getting Started
Run the exemplary scripts to compute reachable sets and extract driving corridors.
* To compute reachable sets, run `compute_reachable_set.py`.
* To extract driving corridors, run `extract_driving_corridors.py`.
The outputs will be stored in the `./output/` folder. Default and scenario-specific configurations are stored in the `./configurations/` folder.
## Documentation
The documentation of our toolbox is available on our website: https://cps.pages.gitlab.lrz.de/commonroad-reachable-set/.
In order to generate the documentation via Sphinx locally, run the following commands in the root directory:
```bash
pip install -r ./docs/requirements_doc.txt
cd docs/Sphinx
make html
```
The documentation can then be launched by browsing ``./docs/Sphinx/build/html/index.html/``.
## Citation
If you use our toolbox for your research, please cite our [paper](https://mediatum.ub.tum.de/doc/1684928/1684928.pdf):
```text
@InProceedings{iraniliu2022commonroad,
title = {{CommonRoad-Reach}: {A} toolbox for reachability analysis of automated vehicles},
author = {Irani Liu, Edmond and W\"ursching, Gerald and Klischat, Moritz and Althoff, Matthias},
booktitle = {Proc. of the IEEE Int. Conf. Intell. Transp. Syst.},
pages = {2313--2320},
year = {2022},
}
```