From d589c45a5b5de423dbba21e7b3513949c3524092 Mon Sep 17 00:00:00 2001 From: MattRoweEAIF <125647690+MattRoweEAIF@users.noreply.github.com> Date: Thu, 11 Apr 2024 14:59:30 +0200 Subject: [PATCH] fixed typos and broken links (#7396) * fixed typos and broken links * updated python_api.md --- Docs/build_faq.md | 2 +- Docs/core_map.md | 28 ++ Docs/python_api.md | 676 +++++++++++++++++++-------------------- Docs/start_quickstart.md | 2 +- PythonAPI/docs/world.yml | 4 +- 5 files changed, 370 insertions(+), 342 deletions(-) diff --git a/Docs/build_faq.md b/Docs/build_faq.md index 07dcc4ada..5007e8b6f 100644 --- a/Docs/build_faq.md +++ b/Docs/build_faq.md @@ -76,7 +76,7 @@ CARLA forum > CARLA is a performance demanding software. At the very minimum it requires a 6GB GPU or, even better, a dedicated GPU capable of running Unreal Engine. > -> Take a look at [Unreal Engine's recommended hardware](https://www.ue4community.wiki/recommended-hardware-x1p9qyg0). +> Take a look at [Unreal Engine's recommended hardware](https://dev.epicgames.com/documentation/en-us/unreal-engine/hardware-and-software-specifications-for-unreal-engine). --- diff --git a/Docs/core_map.md b/Docs/core_map.md index d15b6c9d5..e59f9f473 100644 --- a/Docs/core_map.md +++ b/Docs/core_map.md @@ -23,6 +23,7 @@ After discussing about the world and its actors, it is time to put everything in - [Add map package](tuto_M_add_map_package.md) - [Add map source](tuto_M_add_map_source.md) - [Alternative methods](tuto_M_add_map_alternative.md) +- [__Additional maps__](#additional-maps) --- @@ -257,6 +258,9 @@ Non-layered maps are shown in the table below (click the town name to see an ove | [__Town11__](map_town11.md) | A Large Map that is undecorated. Serves as a proof of concept for the Large Maps feature. | | [__Town12__](map_town12.md) | A Large Map with numerous different regions, including high-rise, residential and rural environments.| +!!! note + Town06 and Town07 are additional content which does not come with the standard CARLA package. Please see the [additional maps section](#additional-maps) for details on how to import these. + ### Layered maps The layout of layered maps is the same as non-layered maps but it is possible to toggle off and on the layers of the map. There is a minimum layout that cannot be toggled off and consists of roads, sidewalks, traffic lights and traffic signs. Layered maps can be identified by the suffix `_Opt`, for example, `Town01_Opt`. With these maps it is possible to [load][load_layer] and [unload][unload_layer] layers via the Python API: @@ -291,3 +295,27 @@ CARLA is designed to be extensible and highly customisable for specialist applic * [__Add map package__](tuto_M_add_map_package.md) * [__Add map source__](tuto_M_add_map_source.md) * [__Alternative methods__](tuto_M_add_map_alternative.md) + +## Additional maps + +Each release has it's own additional package of extra assets and maps. This additional package includes the maps __Town06__ and __Town07__. These are stored separately to reduce the size of the build, so they can only be imported after the main package has been installed. + +__1.__ [Download](https://github.com/carla-simulator/carla/blob/master/Docs/download.md) the appropriate package for your desired version of CARLA. + +__2.__ Extract the package: + +- __On Linux__: + + - move the package to the _Import_ folder and run the following script to extract the contents: + +```sh + cd path/to/carla/root + + ./ImportAssets.sh +``` + +- __On Windows__: + + - Extract the contents directly in the root folder. + +--- diff --git a/Docs/python_api.md b/Docs/python_api.md index 88c0ae748..a4a68ba77 100644 --- a/Docs/python_api.md +++ b/Docs/python_api.md @@ -3771,9 +3771,9 @@ When enabled, the simulation will run no rendering at all. This is mainly used t - **fixed_delta_seconds** (_float_) Ensures that the time elapsed between two steps of the simulation is fixed. Set this to 0.0 to work with a variable time-step, as happens by default. - **substepping** (_bool_) -Enable the physics substepping. This option allows computing some physics substeps between two render frames. If synchronous mode is set, the number of substeps and its time interval are fixed and computed are so they fulfilled the requirements of [carla.WorldSettings.max_substep](#carla.WorldSettings.max_substep) and [carla.WorldSettings.max_substep_delta_time](#carla.WorldSettings.max_substep_delta_time). These last two parameters need to be compatible with [carla.WorldSettings.fixed_delta_seconds](#carla.WorldSettings.fixed_delta_seconds). Enabled by default. +Enable the physics substepping. This option allows computing some physics substeps between two render frames. If synchronous mode is set, the number of substeps and its time interval are fixed and computed are so they fulfilled the requirements of [carla.WorldSettings.max_substeps](#carla.WorldSettings.max_substeps) and [carla.WorldSettings.max_substep_delta_time](#carla.WorldSettings.max_substep_delta_time). These last two parameters need to be compatible with [carla.WorldSettings.fixed_delta_seconds](#carla.WorldSettings.fixed_delta_seconds). Enabled by default. - **max_substep_delta_time** (_float_) -Maximum delta time of the substeps. If the [carla.WorldSettingsmax_substep](#carla.WorldSettingsmax_substep) is high enough, the substep delta time would be always below or equal to this value. By default, the value is set to 0.01. +Maximum delta time of the substeps. If the [carla.WorldSettings.max_substeps](#carla.WorldSettings.max_substeps) is high enough, the substep delta time would be always below or equal to this value. By default, the value is set to 0.01. - **max_substeps** (_int_) The maximum number of physics substepping that are allowed. By default, the value is set to 10. - **max_culling_distance** (_float_) @@ -4226,6 +4226,71 @@ document.getElementById("snipets-container").innerHTML = null; } +