carla/README.md

103 lines
4.5 KiB
Markdown
Raw Normal View History

CARLA Simulator
===============
2017-03-30 01:05:26 +08:00
2018-01-31 00:38:23 +08:00
[![Build Status](https://travis-ci.org/carla-simulator/carla.svg?branch=master)](https://travis-ci.org/carla-simulator/carla)
2018-02-08 03:14:59 +08:00
[![Documentation](https://readthedocs.org/projects/carla/badge/?version=latest)](http://carla.readthedocs.io)
2018-12-12 09:54:31 +08:00
2018-05-14 21:34:32 +08:00
[![carla.org](Docs/img/btn/web.png)](http://carla.org)
2018-07-30 20:10:23 +08:00
[![download](Docs/img/btn/download.png)](https://github.com/carla-simulator/carla/blob/master/Docs/download.md)
2018-05-14 21:34:32 +08:00
[![documentation](Docs/img/btn/docs.png)](http://carla.readthedocs.io)
2019-12-12 04:17:06 +08:00
[![forum](Docs/img/btn/forum.png)](https://forum.carla.org)
[![discord](Docs/img/btn/chat.png)](https://discord.gg/8kqACuC)
2018-05-14 21:34:32 +08:00
2017-11-11 00:54:06 +08:00
CARLA is an open-source simulator for autonomous driving research. CARLA has
been developed from the ground up to support development, training, and
2018-12-12 09:54:31 +08:00
validation of autonomous driving systems. In addition to open-source code
2017-11-11 00:54:06 +08:00
and protocols, CARLA provides open digital assets (urban layouts, buildings,
vehicles) that were created for this purpose and can be used freely. The
simulation platform supports flexible specification of sensor suites and
environmental conditions.
2017-10-31 00:56:39 +08:00
[![CARLA Video](Docs/img/video_thumbnail.png)](https://www.youtube.com/watch?v=TOojcifcRBA)
2017-10-31 00:56:39 +08:00
2018-01-23 20:03:15 +08:00
If you want to benchmark your model in the same conditions as in our CoRL17
paper, check out
2018-12-13 23:39:27 +08:00
[Benchmarking](https://github.com/carla-simulator/driving-benchmarks).
2017-10-31 00:56:39 +08:00
[**Get CARLA overnight build**](http://carla-releases.s3.amazonaws.com/Linux/Dev/CARLA_Latest.tar.gz)
2018-12-12 09:54:31 +08:00
## CARLA Ecosystem
Repositories associated to the CARLA simulation platform:
* [**Scenario_Runner**](https://github.com/carla-simulator/scenario_runner): Engine to execute traffic scenarios in CARLA 0.9.X
* [**ROS-bridge**](https://github.com/carla-simulator/ros-bridge): Interface to connect CARLA 0.9.X to ROS
* [**Driving-benchmarks**](https://github.com/carla-simulator/driving-benchmarks): Benchmark tools for Autonomous Driving tasks
2019-03-20 20:20:35 +08:00
* [**Conditional Imitation-Learning**](https://github.com/felipecode/coiltraine): Training and testing Conditional Imitation Learning models in CARLA
2019-02-01 02:07:59 +08:00
* [**AutoWare AV stack**](https://github.com/carla-simulator/carla-autoware): Bridge to connect AutoWare AV stack to CARLA
2018-12-12 09:54:31 +08:00
* [**Reinforcement-Learning**](https://github.com/carla-simulator/reinforcement-learning): Code for running Conditional Reinforcement Learning models in CARLA
2019-03-02 05:18:59 +08:00
* [**Map Editor**](https://github.com/carla-simulator/carla-map-editor): Standalone GUI application to enhance RoadRunner maps with traffic lights and traffic signs information
2018-12-12 09:54:31 +08:00
**Like what you see? Star us on GitHub to support the project!**
2017-10-31 00:56:39 +08:00
Paper
-----
If you use CARLA, please cite our CoRL17 paper.
_CARLA: An Open Urban Driving Simulator_<br>Alexey Dosovitskiy, German Ros,
Felipe Codevilla, Antonio Lopez, Vladlen Koltun; PMLR 78:1-16
[[PDF](http://proceedings.mlr.press/v78/dosovitskiy17a/dosovitskiy17a.pdf)]
2018-10-11 16:46:08 +08:00
[[talk](https://www.youtube.com/watch?v=xfyK03MEZ9Q&feature=youtu.be&t=2h44m30s)]
2017-10-31 00:56:39 +08:00
```
@inproceedings{Dosovitskiy17,
title = {{CARLA}: {An} Open Urban Driving Simulator},
author = {Alexey Dosovitskiy and German Ros and Felipe Codevilla and Antonio Lopez and Vladlen Koltun},
booktitle = {Proceedings of the 1st Annual Conference on Robot Learning},
pages = {1--16},
year = {2017}
}
```
2018-01-19 23:10:27 +08:00
Building CARLA
--------------
Use `git clone` or download the project from this page. Note that the master
branch contains the latest fixes and features, for the latest stable code may be
2018-08-21 18:51:02 +08:00
best to switch to the `stable` branch.
2018-01-19 23:10:27 +08:00
Then follow the instruction at [How to build on Linux][buildlinuxlink] or
[How to build on Windows][buildwindowslink].
2018-01-19 23:10:27 +08:00
Unfortunately we don't have official instructions to build on Mac yet, please
check the progress at [issue #150][issue150].
2018-01-19 23:10:27 +08:00
2020-03-13 22:17:56 +08:00
[buildlinuxlink]: https://carla.readthedocs.io/en/latest/build_linux/
[buildwindowslink]: https://carla.readthedocs.io/en/latest/build_windows/
2018-01-19 23:10:27 +08:00
[issue150]: https://github.com/carla-simulator/carla/issues/150
2018-01-15 21:55:26 +08:00
Contributing
------------
Please take a look at our [Contribution guidelines][contriblink].
2020-03-13 22:17:56 +08:00
[contriblink]: https://carla.readthedocs.io/en/latest/cont_contribution_guidelines/
2018-01-15 21:55:26 +08:00
2018-01-18 00:33:17 +08:00
F.A.Q.
------
If you run into problems, check our
[FAQ](http://carla.readthedocs.io/en/latest/faq/).
2017-10-31 00:56:39 +08:00
License
-------
CARLA specific code is distributed under MIT License.
CARLA specific assets are distributed under CC-BY License.
The ad-rss-lib library compiled and linked by the [RSS Integration build variant](Docs/rss_lib_integration.md) introduces LGPL-2.1-only License.
2018-04-09 20:21:25 +08:00
Note that UE4 itself follows its own license terms.