Skip to content

Commit dca7cc3

Browse files
corkyw10bernatx
authored andcommitted
updated Index page, rearranged nav bar, corrected links to broken images, corrected default settings for wheel physics, added anysys rtr information
1 parent 374b1dd commit dca7cc3

13 files changed

+321
-293
lines changed

Docs/core_map.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ Every object on a CARLA map has a set of associated variables which can be found
127127

128128
See an example of distinct objects being toggled:
129129

130-
![toggle_objects_gif](/img/objects_small.gif)
130+
![toggle_objects_gif](img/objects_small.gif)
131131

132132
[env_obj]: https://carla.readthedocs.io/en/latest/python_api/#carla.EnvironmentObject
133133
[env_obj_id]: https://carla.readthedocs.io/en/latest/python_api/#carla.EnvironmentObject.id

Docs/ecosys_ansys.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Ansys Real Time Radar Model: Training a Vehicle Longitudinal Controller Using Reinforcement Learning
2+
3+
In a webinair series in April 2021, [Ansys](https://www.ansys.com/) presented the details of their integration of the Ansys Real Time Radar (RTR) with the CARLA simulator. Here you can download and view the presentation slides and videos that accompanied the webinair.
4+
5+
The presentation details how the RTR was integrated with CARLA to train a vehicle longitudinal controller using reinforcement learning and includes the model, action space and reward policy used. The videos show the results of the training in the CARLA simulator.
6+
7+
View the presentation [here](https://drive.google.com/file/d/1xtGaI8Ls6C8Jh-PQvKRrLKs6c3ri3WQ2/view) and the videos [here](https://drive.google.com/file/d/1whHE1MKhzQtW3jj4dJCW6A3mCjUnNaJI/view).
8+

Docs/img/large_map_export_fbx.png

11.6 KB
Loading

Docs/img/rr_world_settings.png

114 KB
Loading

Docs/index.md

+40-18
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ CARLA forum</a>
2424
## Getting started
2525

2626
[__Introduction__](start_introduction.md) — What to expect from CARLA.
27-
[__Quick start__](start_quickstart.md) — Get the CARLA releases.
27+
[__Quick start package installation__](start_quickstart.md) — Get the CARLA releases.
2828

2929

3030
## Building CARLA
@@ -33,7 +33,7 @@ CARLA forum</a>
3333
[__Windows build__](build_windows.md) — Make the build on Windows.
3434
[__Update CARLA__](build_update.md) — Get up to date with the latest content.
3535
[__Build system__](build_system.md) — Learn about the build and how it is made.
36-
[__Running in a Docker__](build_docker.md) — Run CARLA using a container solution.
36+
[__CARLA in Docker__](build_docker.md) — Run CARLA using a container solution.
3737
[__F.A.Q.__](build_faq.md) — Some of the most frequent installation issues.
3838

3939

@@ -44,16 +44,22 @@ CARLA forum</a>
4444
[__3rd. Maps and navigation__](core_map.md) — Discover the different maps and how do vehicles move around.
4545
[__4th. Sensors and data__](core_sensors.md) — Retrieve simulation data using sensors.
4646

47-
## Advanced steps
47+
## Advanced concepts
4848
[__OpenDRIVE standalone mode__](adv_opendrive.md) — Use any OpenDRIVE file as a CARLA map.
4949
[__PTV-Vissim co-simulation__](adv_ptv.md) — Run a synchronous simulation between CARLA and PTV-Vissim.
5050
[__Recorder__](adv_recorder.md) — Register the events in a simulation and play it again.
5151
[__Rendering options__](adv_rendering_options.md) — From quality settings to no-render or off-screen modes.
5252
[__RSS__](adv_rss.md) — An implementation of RSS in the CARLA client library.
53-
[__SUMO co-simulation__](adv_sumo.md) — Run a synchronous simulation between CARLA and SUMO.
5453
[__Synchrony and time-step__](adv_synchrony_timestep.md) — Client-server communication and simulation time.
54+
[__Benchmarking Performance__](adv_benchmarking.md) — Perform benchmarking using our prepared script.
55+
[__CARLA Agents__](adv_agents.md) — Agents scripts allow single vehicles to roam the map or drive to a set destination.
56+
57+
## Traffic Simulation
58+
59+
[__ Traffic Simulation Overview__](ts_traffic_simulation_overview.md) — An overview of the different options available to populate your scenes with traffic
5560
[__Traffic Manager__](adv_traffic_manager.md) — Simulate urban traffic by setting vehicles to autopilot mode.
56-
[__CARLA Agents__](adv_agents.md) — Agents scripts allow single vehicles to roam the map or drive to a set destination.
61+
[__SUMO co-simulation__](adv_sumo.md) — Run a synchronous simulation between CARLA and SUMO.
62+
[__Scenic__](tuto_G_scenic.md) — Follow an example of defining different scenarios using the Scenic library.
5763

5864
## References
5965
[__Python API reference__](python_api.md) — Classes and methods in the Python API.
@@ -66,7 +72,28 @@ CARLA forum</a>
6672
[__carlaviz — web visualizer__](plugins_carlaviz.md) — Plugin that listens the simulation and shows the scene and some simulation data in a web browser.
6773

6874
## ROS bridge
69-
[__ROS bridge documentation__](ros_documentation.md) — Brief overview of the ROS bridge and a link to the full documentation
75+
[__ROS bridge documentation__](ros_documentation.md) — Brief overview of the ROS bridge and a link to the full documentation
76+
77+
## Custom Maps
78+
79+
[__Overview of custom maps in CARLA__](tuto_M_custom_map_overview.md) — An overview of the process and options involved in adding a custom, standard sized map
80+
[__Create a map in RoadRunner__](tuto_M_generate_map.md) — How to generate a customs, standard sized map in RoadRunner
81+
[__ Import map in CARLA package__](tuto_M_add_map_package.md) How to import a map in a CARLA package
82+
[__Import map in CARLA source build__](tuto_M_add_map_source.md) — How to import a map in CARLA built from source
83+
[__Alternative ways to import maps__](tuto_M_add_map_alternative.md) — Alternative methods to import maps
84+
[__ Manually prepare map package__](tuto_M_manual_map_package.md) — How to prepare a map for manual import
85+
[__Customizing maps: Layered maps__](tuto_M_custom_layers.md) — How to create sub-layers in your custom map
86+
[__ Customizing maps: Traffic lights and signs__](tuto_M_custom_add_tl.md) — How to add traffic lights and signs to your custom map
87+
[__ Customizing maps: Road painter__](tuto_M_custom_road_painter.md) — How to use the road painter tool to change the apearance of the road
88+
[__Customizing Maps: Procedural Buildings__](tuto_M_custom_buildings.md) — Populate your custom map with buildings
89+
[__ Customizing maps: Weather and landscape__](tuto_M_custom_weather_landscape.md) — Create the weather profile for your custom map and populate the landscape
90+
[__Generate pedestrian navigation__](tuto_M_generate_pedestrian_navigation.md) — Obtain the information needed for walkers to move around.
91+
92+
## Large Maps
93+
94+
[__Large maps overview__](large_map_overview.md) — An explanation of how large maps work in CARLA
95+
[__Create a Large Map in RoadRunner__](large_map_roadrunner.md) — How to create a large map in RoadRunner
96+
[__Import/Package a Large Map__](large_map_import.md) — How to import a large map
7097
## Tutorials — General
7198
[__Add friction triggers__](tuto_G_add_friction_triggers.md) — Define dynamic box triggers for wheels.
7299
[__Control vehicle physics__](tuto_G_control_vehicle_physics.md) — Set runtime changes on a vehicle physics.
@@ -75,31 +102,26 @@ CARLA forum</a>
75102
[__Retrieve simulation data__](tuto_G_retrieve_data.md) — A step by step guide to properly gather data using the recorder.
76103
[__CarSim Integration (Beta)__](tuto_G_carsim_integration.md) — Tutorial on how to run a simulation using the CarSim vehicle dynamics engine.
77104
[__RLlib Integration__](tuto_G_rllib_integration.md) — Find out how to run your own experiment using the RLlib library.
78-
[__Scenic__](tuto_G_scenic.md) — Follow an example of defining different scenarios using the Scenic library.
79-
80-
## Tutorials — Maps
81-
[__Overview of custom maps__](tuto_M_custom_map_overview.md)
82-
[__Create a map in RoadRunner__](tuto_M_generate_map.md)
83-
[__Import map in CARLA package__](tuto_M_add_map_package.md)
84-
[__Import map in CARLA source build__](tuto_M_add_map_source.md)
85-
[__Manually prepare map package__](tuto_M_manual_map_package.md)
86-
[__Alternative map section__](tuto_M_add_map_alternative.md)
87-
[__Generate pedestrian navigation__](tuto_M_generate_pedestrian_navigation.md) — Obtain the information needed for walkers to move around.
105+
[__Chrono Integration__](tuto_G_chrono.md) — Use the Chrono integration to simulation physics
106+
[__Build Unreal Engine and CARLA in Docker__](build_docker_unreal.md) — Build Unreal Engine and CARLA in Docker
88107

89108
## Tutorials — Assets
90109
[__Add a new vehicle__](tuto_A_add_vehicle.md) — Prepare a vehicle to be used in CARLA.
91110
[__Add new props__](tuto_A_add_props.md) — Import additional props into CARLA.
92111
[__Create standalone packages__](tuto_A_create_standalone.md) — Generate and handle standalone packages for assets.
93-
[__Map customization__](tuto_A_map_customization.md) — Edit an existing map.
94112
[__Material customization__](tuto_A_material_customization.md) — Edit vehicle and building materials.
95113

96114
## Tutorials — Developers
97-
[__Contribute with new assets__](tuto_D_contribute_assets.md) — Add new content to CARLA.
115+
[__How to upgrade content__](tuto_D_contribute_assets.md) — Add new content to CARLA.
98116
[__Create a sensor__](tuto_D_create_sensor.md) — Develop a new sensor to be used in CARLA.
99117
[__Create semantic tags__](tuto_D_create_semantic_tags.md) — Define customized tags for semantic segmentation.
100118
[__Customize vehicle suspension__](tuto_D_customize_vehicle_suspension.md) — Modify the suspension system of a vehicle.
101119
[__Generate detailed colliders__](tuto_D_generate_colliders.md) — Create detailed colliders for vehicles.
120+
[__Make a release__](tuto_D_make_release.md) — How to make a release of CARLA
121+
122+
## CARLA Ecosystem
102123

124+
[__Ansys Real Time Radar Model__](ecosys_ansys.md) — Details about the Ansys RTR Webinair
103125
## Contributing
104126
[__Contribution guidelines__](cont_contribution_guidelines.md) — The different ways to contribute to CARLA.
105127
[__Code of conduct__](cont_code_of_conduct.md) — Standard rights and duties for contributors.

Docs/large_map_roadrunner.md

+1
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ The specifics of how to build a large map in RoadRunner go beyond the scope of t
3737
If you are building a large map with elevation, the recommended largest size of the map is 20km by 20km. Maps larger than this may cause RoadRunner to crash on export.
3838

3939
[rr_tutorials]: https://www.mathworks.com/support/search.html?fq=asset_type_name:video%20category:roadrunner/index&page=1&s_tid=CRUX_topnav
40+
4041
---
4142

4243
## Export a large map in RoadRunner

0 commit comments

Comments
 (0)