Commit Graph

114 Commits

Author SHA1 Message Date
MattRoweEAIF 1d38bc16d8 added town 12 map guide 2023-03-01 11:20:02 +01:00
MattRowe18 0926da2847
Docs preview (#5606)
* add UE4 warning

* fixed UE4 build warning

* removed file

* created inst seg tutorial

* added instance segmentation image

* added to index

* fix

* added menu entries

* texture streaming tutorial

* reorganised instance segmentation tutorial

* texture tutorial revision

* typos

* typos

* added PIL link

* added tooltip

* remove tooltip image

* replace tooltip image

* removed tooltip image

* added tooltip image

* replaced image

* texture streaming tutorial update

* started pedestrian bones tutorial

* added image

* updates

* updates

* added download link for skeleton.txt

* fixed link

* fixed link

* completed pedestrian tutorial

* small change

* small fix

* TM tutorial

* added new gif

* typo

* finished TM tutorial

* small edit

* small edit

* typo

* pygame tutorial

* added gif to pygame tutorial

* corrected gif location

* replaced manual_control.gif

* typos

* fixed pygame tutorial

* import numpy

* pedestrian tutorial corrections

* corrected pedestrian bones tutorial

* added actors and blueprints

* indexed getting started tutorial

* fixed links

* index.md refactor

* mkdocs.yml nav refactor

* mkdocs.yml syntax error

* main docs refactor

* new documentation structure

* content authoring tutorials

* content authoring tutorial

* content authoring

* latest changes

* vehicle authoring tutorial

* finished vehicle content tutorial

* finished vehicles tutorial

* adjusted outline

* finalise authoring tutorials

* rearrange index.md

* extended index.md

* change mkdocs format

* update jinja version

* bounding box tutorial

* fix stray files

* remove changes in build.sh

* proof read

* guillermo's pr edits

* bbox tutorial changes

* guillermo's pr edits 1

* added modeling guidelines and blender add on

* added COCO export format

* added bounding boxes to tutorials

* merged bounding box tutorial

* added Ubuntu 20.04 installation commands

* image updates

* add empty menu item

* added new maps authorship images

Co-authored-by: germanros1987 <38517452+germanros1987@users.noreply.github.com>
2022-07-20 18:16:27 +02:00
MattRowe18 a58503b9e8
Docs preview (#4983)
* add UE4 warning

* fixed UE4 build warning

* removed file

* created inst seg tutorial

* added instance segmentation image

* added to index

* fix

* added menu entries

* texture streaming tutorial

* reorganised instance segmentation tutorial

* texture tutorial revision

* typos

* typos

* added PIL link

* added tooltip

* remove tooltip image

* replace tooltip image

* removed tooltip image

* added tooltip image

* replaced image

* texture streaming tutorial update

* started pedestrian bones tutorial

* added image

* updates

* updates

* added download link for skeleton.txt

* fixed link

* fixed link

* completed pedestrian tutorial

* small change

* small fix

* TM tutorial

* added new gif

* typo

* finished TM tutorial

* small edit

* small edit

* typo

* pygame tutorial

* added gif to pygame tutorial

* corrected gif location

* replaced manual_control.gif

* typos

* fixed pygame tutorial

* import numpy

* pedestrian tutorial corrections

* corrected pedestrian bones tutorial

* added actors and blueprints

* indexed getting started tutorial

* fixed links

* index.md refactor

* mkdocs.yml nav refactor

* mkdocs.yml syntax error

* main docs refactor

* new documentation structure

* content authoring tutorials

* content authoring tutorial

* content authoring

* latest changes

* vehicle authoring tutorial

* finished vehicle content tutorial

* finished vehicles tutorial

* adjusted outline

* finalise authoring tutorials

* rearrange index.md

* extended index.md

* change mkdocs format

* update jinja version

* bounding box tutorial

* fix stray files

* remove changes in build.sh

* proof read

* guillermo's pr edits

* bbox tutorial changes

* guillermo's pr edits 1

* added modeling guidelines and blender add on

* added COCO export format

* added bounding boxes to tutorials

* merged bounding box tutorial

Co-authored-by: germanros1987 <38517452+germanros1987@users.noreply.github.com>
2022-04-14 12:38:49 +02:00
Corinne 74ea12357d
Removed references to CarSim being in beta stage (#4501) 2021-08-06 07:22:19 -07:00
corkyw10 dca7cc3f8d updated Index page, rearranged nav bar, corrected links to broken images, corrected default settings for wheel physics, added anysys rtr information 2021-07-30 12:48:32 +02:00
Corinne bd36e46b39
Corkyw10/maps documentation (#4233)
* Restructured maps docs layout and fixed affected URLs

* Updated RoadRunner map generation doc. Includes link for Leaderboard license

* Updated package ingestion doc so it is located in the main navigation bar. All relative links have been fixed.

* Moved customization information to separate tutorial. Added next steps

* Moved manual preparation of json package to separate tutorial.

* Added how to add traffic light and signs documentation. Updated nav with approriate page name. Cropped photo to show an updated view of UE editor

* Redraft of the weather and landscape tutorial

* Updated tutorial for using the road painter. Typo fix in other tutorials for map customization

* Added tutorial to add levels to maps

* Added images for maps tutorials

* Minor syntax changes to manual package prep

* Full drafts of map documentation

* Added images and corrected names for building shaders

* [NO_BUILD] First draft of Large Maps docs (#4396)

* Drafting large map docs

* Changed name of spawn_npc script

* Syntax changes

* Corrected hybrid mode dormant behavior, added code for setting ego vehicle, removed expensive note about map calls

* Added section for roadrunner large maps

* Added images to roadrunner docs and rearranged nav bar and titles.

* Added corrections to import of large maps and standard map nomenclature

Co-authored-by: bernat <bernatx@gmail.com>

* Made corrections to spawn points and additional fbx folder information

* Fixed mentions of normal maps to standard maps

Co-authored-by: bernat <bernatx@gmail.com>
2021-07-30 11:20:23 +02:00
corkyw10 dd9442b47f Agent script documentation first draft 2021-07-29 16:21:59 +02:00
corkyw10 9e88bf1e99 Updated docker image with new commands based on the graphics API used. Brought docker build for managing packages into the main docs from github. Updated rendering docs to reflect the fact UE4.26 uses only vulkan and has an off screen flag. Moved make package from docker instructions to the guide for making packages. 2021-07-29 16:21:38 +02:00
corkyw10 ac4e41269b Updated vehicle control title in nav bar 2021-07-28 14:45:55 +02:00
corkyw10 ffb539edeb Added banner to warn users about the latest version of docs only referring to development branch 2021-05-13 16:19:38 +02:00
Corinne cec8fd90ae
Corkyw10/chrono docs (#4160)
* Added Chrono Integration page to navigation

* Initial draft of Chrono documentation

* Added Python API information for enable_chrono_physics. Made some syntactical changes to first draft of Chrono docs.

* Made the forward slash character in PythonAPI stand out. Added link to Actor class in the Chrono doc.

* Added manual_control_chrono.py to PythonAPI/examples

* Edited chrono torial. Edited changelog.

Co-authored-by: Axel <axellopez92@outlook.com>
2021-05-07 15:16:32 +02:00
corkyw10 8f162700f5 Updated 4 wheeled vehicle import tutorial. Merged the vehicle modeling tutorial into it. Index page updated to reflect changes in the docs structure 2021-04-20 16:37:51 +02:00
corkyw10 a2a9737244 Removed ROS docs, replaced with an brief overview and a link to the new docs. Updated nav and index to reflect changes 2021-04-16 16:09:04 +02:00
corkyw10 a9a4366343 Added overview of traffic simulation options 2021-03-31 17:47:21 +02:00
Corinne b4b50cc48a
Corkyw10/import maps tutorial (#3875)
* restructured tutorial layout to avoid confusion between the three different methods available

* Beginnings of new layout of maps tutorial

* updatng docker and make import sections

* Final first draft of map import guide refactor. Links to the guide have been changed in the rest of the documentation

* Removed windows import option from package map import doc

* Clarified that package import otpion with Docker only works on Linux

* Deleted deprecated section. Removed reference to creating crosswalk meshes unless users want to add new ones. Removed part about packages needing unique name and moved this to 'before you begin' to say that map names should be unique'

* Added more information about how to export from road runner. Removed another line referring to the deprecated methods to import maps.

* Add a structure of the .json file to the overview and added to --use-carla-materials flag that it is only necessary if you do not provide a .json file yourself

* Clarified that .json values will override flag values

* Alternative import methods

* Added alternative section to overview and added images for manual import

* Summary section added to alternative methods

* Added image to show render disable for pedestrian mesh
2021-03-23 10:00:18 +01:00
corkyw10 a4439bcefc Added tutorial on how to create a basic Scenic script 2021-03-23 09:59:19 +01:00
corkyw10 4f94297dae Refactored quickstart instalation guide 2021-03-10 10:39:12 +01:00
corkyw10 1f0c7441dd Documentation add for RLlib integration 2021-03-02 12:56:59 +01:00
corkyw10 e7824e52a2 Added benchmark to navigation menu and created first draft of benchmark docs with explanation of where to find the script and flags available 2021-02-05 12:28:35 +01:00
corkyw10 ee77b3afa6 CarSim tutorial refactoring and name change to bring in line with other tutorials 2021-01-12 17:11:44 +01:00
corkyw10 7177f22fff Added tutorial to nav bar and made some typo/grammar fixes 2020-12-22 16:11:51 +01:00
sergi.e 31fff28bc6
sergi-e/api-snipets (#3409)
* First iteration with snipets, copy button and snippet button for all methods

* New iteration with snipets implemented and test snipets

* New iteration without yaml intervention, with auxiliary doc deleted and responsive buttons to window width

* New iteration with snipets copied from recipes, images added, and invisible button for small window

* Fixed some marging issues & code formatting

* Removed recipe reference and its instances. Snipets are now scalable to window width. Added button to close snipet. doc_gen_snipets.py is now imported in doc_gen.py. Cleaned css inside .py and added to extra.css

* New iteration with two functionalities for snipet buttons. Pop up for small windows.

* Fixed bp_library.md

Co-authored-by: Marc Garcia Puig <marcgpuig@gmail.com>
2020-10-15 16:48:48 +02:00
sergi-e 434dfaa3d0 First iteration on semnatic tags 2020-10-07 11:42:28 +02:00
sergi-e d45505b8cd First iteration 2020-09-25 14:47:24 +02:00
sergi-e 10babc27c9 new iteration. Missing default values, API docs, and wall height note. 2020-07-31 21:50:19 +02:00
sergi-e 72655ba6ec First draft 2020-07-31 21:50:19 +02:00
sergi-e 17ca775788 First draft on new tutorial 2020-07-20 15:11:49 +02:00
sergi.e 73af1fdb03
Sergi e/carlaviz docs (#3069)
* carlaviz first draft

* New iteration with pic

* New pics and descriptions

* list of items

* First draft for PR

* Index modified

* ending modified

* First draft fixes
2020-07-17 14:55:42 +02:00
Pasch, Frederik 88ae9d04ae Update to AD RSS Library 4.0.0
- Added support for unstructured scenes and pedestrians.
- Rework rss example folder structure
- Python based debug drawing
- Handle negative speeds
- Fixes #2871 by linking libproj statically.
- Fixes #2958 by using sequential colcon build
- Allow setting log level
- Add ActorConstellationCallback
- Move setting of RssDynamics to python code
2020-07-14 17:53:28 +02:00
sergi-e d018039e0d New iteration with materials 2020-05-11 18:50:18 +02:00
sergi-e 6bdb1b587a First draft custom tools 2020-05-11 18:50:18 +02:00
sergi.e cd35196d20
sergi-e/p099-updates (#2751)
* First draft TM updates

* Idle iteration

* Different updates

* Python API weather fix

* Added RSS sensor

* Added nightly builds

* Added texture mention to Town10

* Updated TM

* Updated contact mail

* New update on B,Jo,Ja comments

* Last fixes on Ja comments
2020-04-23 12:40:28 +02:00
sergi-e 3cb68ba618 New iteration with ptv 2020-04-16 12:41:06 +02:00
sergi-e aa938b02bf First draft. 2020-04-16 12:41:06 +02:00
sergi.e 8ebb8a12a1
sergi-e/asset-import (#2690)
* First draft

* First iteration B comments

* Added bottom links to forum

* Intermediate iteration

* middle iteration

* Idle iteration

* New draft with separated tutorials

* Links fixed.

* New recast executable described

* Fixed spacing

* Last iteration B comments

* New iteration with auto json

* New modifications on B PR

* New iteration with ped. nav.

* New iteration on B final review
2020-04-15 01:55:18 +02:00
sergi-e eb6c4f82c0 name changed 2020-04-07 15:54:34 +02:00
sergi-e 0a46e32d4c First iteration with text 2020-04-07 15:54:34 +02:00
sergi.e 29e8e14cc1
Sergi e/rss docs (#2686)
* RSS first add

* RSS docs first draft.·

* Second draft.

* Codacy fixes

* Readme update
2020-04-03 13:57:11 +02:00
sergi.e f03c0ec98c
Sergi e/map create custom (#2675)
* First iteration

* Minor fix

* Iteration on Docker method

* Deleted code line

* new iteration with deprecated tutorials

* fixed link

* Iteration on X comments
2020-03-31 18:09:04 +02:00
sergi.e e4cc150a3c
sergi-e/p098-index (#2573)
* Fixing links and style.

* Command line summary added

* New table attempt

* Codacy fixes + default table css
2020-03-11 13:53:27 +01:00
sergi-e d5e96c539f New iteration on release comments 2020-03-06 16:07:35 +01:00
sergi-e 4cd1afcf8c Index updated with ROS 2020-03-06 16:07:35 +01:00
sergi-e 7588981727 Added messages and topics references. 2020-03-06 16:07:35 +01:00
sergi-e b27d5d10c3 First draft 2020-03-06 16:07:35 +01:00
sergi-e aa353043e4 Index updated. Mention to TrafficManager.cpp added. 2020-03-06 12:56:44 +01:00
sergi-e db0e95cc1e New iteration on Jacopo comments. 2020-03-06 12:56:44 +01:00
adas-user 2d23b37f5a Fixed first draft traffic manager 2020-03-06 12:56:44 +01:00
sergi-e 48247f1ad9 Final draft 2020-03-03 10:23:34 +01:00
sergi.e eae903e908
sergi-e/sidebar-bug (#2529)
* Fix indexes for all the documentation.

* Added instructions for development assets in linux build

* Table bottom-margin workaround
2020-03-02 09:40:34 +01:00
doterop 85b192530d
Doterop/traffic manager (#2468)
* Initial implementation of t.m. performance script

* Remove redundant getLocation() calls

* Demo for inter-client communication via Carla server

* WIP: To do: For client usage needed to be changed.

* Instead or client instance episodeProxy is passed to TM

* Instead or client instance episodeProxy is passed to TM

* parmeter improvements (walkers,cars,signs,lights)

* adding section id to map setup

* fix manual_control to reload car with autopilot on

* Instead of client instance episodeProxy is passed to TM.

* WIP: Only added vehicle register via RPC server / client call in TM to
local instance from remote instance. Similarly other APIs we need to
added.

* Added all TM APIs

* carla client now can provide TM instance if required.

* While getting TM instance if server given data is not valid new TM
instace is created. Need to decide what to do with earlier registed
vehicle with previous TM.

* Updated with HealthCheckRemoteTM() function to check TM server status
instead of ResetAllTrafficLights() for any new user client.

* Dynamic port selection added to TM server instace (in case of multiple
TM serve run, it required).

* Fixed change map error

* If registered TM at carla server is not present then remote TM should be
freed and new local TM instance is created.

* Created Process for Local TM.
It cheaks with total registered vehicles in it, if no register vehicles
for 5 sec, it closes it self.

In python spawn_npc.py Client Timeout set to 10 sec. as creating Process
is system dependent call and takes time.

User has to unregister vehicle before destroying it (if activated with
TM). Also neet to check TM unregister function to remove vehicles from
register list.

* Fix for collision ignore bug

* Update TM exit function check to compare registered vehicles with world
actors that if any valid vehicle present cointinue to run the TM else
stop.

* Print removal

* Splited work of main for loop in ApplyBatchCommandsSync

* WIP! Trying to get client directly

* WIP! Trying to access episode properly without getting it from TM ctr

* Changes to BatchControlStage for Sync Mode
Changes to Parameters for Synch Mode

* Added port support for TM. Multiclient MultiTM

* Added additions for RPC Synchronous Tick to TM.
Error handeling and code organization.

* Exposed API for Sync Mode

* TMServer notifies Server that it is gonna be destroyed

* Exposed Python API for Sync Mode

* Add TM as separate process and synchronous tick calls

* SetSynchronousModeTimeOutInMiliSecond method added

* TM shutsdown and informs to the connected clients

* WIP! Map change issues again

* Updated Traffic Manager for:
1) Multi-client, Multi-TM (as required) can be reistered to server.
2) TM is not a PROCESS separated from the user-client.
3) TM will exit if user-client exit.
4) If server closed, TM also get closed by catching runtime err.

* Server side changes ...

* Fixed possible stall on TM destruction

* fixing collision stage + cybertruck not safe

* Merge branch 'master' into 'soumyadeep/traffic_manager'

* WIP! Disconnection of server has to be properly handled by clients

* format update

* Fix bug unsignalized junctions

* # WARNING: head commit changed in the meantime

Merge branch 'doterop/traffic_manager' into soumyadeep/traffic_manager
Updates for Syncronized Tick.

* Updated runtime exception in Episode for smooth exit if TN server closed
for any other user client.

* Better Exception handeling

* Merged with jackbart94/tm_reduce_getloc_calls

* Merged soumyadeep/traffic_manager.
Removed World getter and recovered Episode as a parameter of TM ctr.
Fixed syntax errors.

* Initial implementation of t.m. performance script

* Remove redundant getLocation() calls

* Demo for inter-client communication via Carla server

* WIP: To do: For client usage needed to be changed.

* Instead or client instance episodeProxy is passed to TM

* Instead or client instance episodeProxy is passed to TM

* parmeter improvements (walkers,cars,signs,lights)

* fix manual_control to reload car with autopilot on

* Instead of client instance episodeProxy is passed to TM.

* WIP: Only added vehicle register via RPC server / client call in TM to
local instance from remote instance. Similarly other APIs we need to
added.

* Added all TM APIs

* carla client now can provide TM instance if required.

* While getting TM instance if server given data is not valid new TM
instace is created. Need to decide what to do with earlier registed
vehicle with previous TM.

* Updated with HealthCheckRemoteTM() function to check TM server status
instead of ResetAllTrafficLights() for any new user client.

* Dynamic port selection added to TM server instace (in case of multiple
TM serve run, it required).

* Fixed change map error

* If registered TM at carla server is not present then remote TM should be
freed and new local TM instance is created.

* Created Process for Local TM.
It cheaks with total registered vehicles in it, if no register vehicles
for 5 sec, it closes it self.

In python spawn_npc.py Client Timeout set to 10 sec. as creating Process
is system dependent call and takes time.

User has to unregister vehicle before destroying it (if activated with
TM). Also neet to check TM unregister function to remove vehicles from
register list.

* Fix for collision ignore bug

* Update TM exit function check to compare registered vehicles with world
actors that if any valid vehicle present cointinue to run the TM else
stop.

* Splited work of main for loop in ApplyBatchCommandsSync

* WIP! Trying to get client directly

* WIP! Trying to access episode properly without getting it from TM ctr

* Changes to BatchControlStage for Sync Mode
Changes to Parameters for Synch Mode

* Added port support for TM. Multiclient MultiTM

* Added additions for RPC Synchronous Tick to TM.
Error handeling and code organization.

* Exposed API for Sync Mode

* TMServer notifies Server that it is gonna be destroyed

* Exposed Python API for Sync Mode

* Add TM as separate process and synchronous tick calls

* SetSynchronousModeTimeOutInMiliSecond method added

* TM shutsdown and informs to the connected clients

* WIP! Map change issues again

* Updated Traffic Manager for:
1) Multi-client, Multi-TM (as required) can be reistered to server.
2) TM is not a PROCESS separated from the user-client.
3) TM will exit if user-client exit.
4) If server closed, TM also get closed by catching runtime err.

* Fixed possible stall on TM destruction

* fixing collision stage + cybertruck not safe

* Merge branch 'master' into 'soumyadeep/traffic_manager'

* WIP! Disconnection of server has to be properly handled by clients

* format update

* Fix bug unsignalized junctions

* # WARNING: head commit changed in the meantime

Merge branch 'doterop/traffic_manager' into soumyadeep/traffic_manager
Updates for Syncronized Tick.

* Updated runtime exception in Episode for smooth exit if TN server closed
for any other user client.

* Better Exception handeling

* Merged with jackbart94/tm_reduce_getloc_calls

* Merged soumyadeep/traffic_manager.
Removed World getter and recovered Episode as a parameter of TM ctr.
Fixed syntax errors.

* Rebased with master

* Changes after rebase

* Solving tab errors

* Updated Changelog

* Removing Destroyed vehicle's from TM Server

* Fixed uint compatibility with Windows

* Merged soumyadeep/traffic_manager. Discarded destroyed actors

* -Removed unnecessary files

* restoring docs from rebase

* Fix windows compilation

* refactoring stage-related code

* more code refactoring

* When map change the simulation doesn't throw exception anymore

* Fixed incorrect episode

* Fixed map change and TM remote detached thread destruction

* Syntax and comments fixes

* Missed change on previous commit

* Fixed compile minor compile issue

* Cleaned and fixed some issues after merge

* fix to sync localization bugs
modified PID parameters
revamping spawn_npc

* deleted tm_spawn_npc

* fixes spawn error in sync mode

* Redoing TM sync logic

* finished performance benchmark for tm

* deprecated wrapped methods:
register_vehicle
unregister_vehicle

* New TM management

* Fixed sync mode on TM

* Cleaned TM of prints and unussed functions

* collision stage checks for (0,0,0) to ignore.
in memory map has an # between keys to avoid possible mixup.
fixed spawn_npc with new sync mode

* changelog

* added more connection retries

* fixed changelog + comments (see reviewable)

* Moved socket include's to single header

* Added missing line at the end of the file

* Fixed syntax errors

* final commit

* Minor correction in comment

* update copyright year to 2020 + removed break

* restoring unwanted changes

* patch for smoke test error

* Removed "todo" for pylint

Co-authored-by: Jacopo Bartiromo <32928804+jackbart94@users.noreply.github.com>
Co-authored-by: Praveen Kumar <35625166+pravinblaze@users.noreply.github.com>
Co-authored-by: Soumyadeep <soumyadeep.dhar@kpit.com>
Co-authored-by: joel-mb <joel.moriana@gmail.com>
Co-authored-by: Sekhar Barua <58979936+sekhar2912@users.noreply.github.com>
Co-authored-by: bernat <bernatx@gmail.com>
Co-authored-by: Marc Garcia Puig <marcgpuig@gmail.com>
2020-02-28 19:58:13 +01:00