From 718ea7926bbef2cdb63b8422e37d6dd3b0e358d2 Mon Sep 17 00:00:00 2001 From: Jannik Busse <53993035+jannikbusse@users.noreply.github.com> Date: Thu, 2 Nov 2023 09:27:29 +0100 Subject: [PATCH 01/28] Update README.rst --- README.rst | 57 +++++++++++++++++++++++++++--------------------------- 1 file changed, 29 insertions(+), 28 deletions(-) diff --git a/README.rst b/README.rst index 2d5a33f..bca346a 100644 --- a/README.rst +++ b/README.rst @@ -46,6 +46,35 @@ tool. Fig.1: Possible workflow for the presend road variation tool. +Documentation +------------- + +A simple but well designed C++ reference +`documentation `__ +is provided. + +Variation tool +-------------- + +The Variation tool is used to generate a variety of different scenarios +based on the same general road network. A template file is provided to +specify variables as well as the general road network structure. A more +thorough documentation can be found in the `variation +subdirectory `__. + +.. _installation-1: + +Installation +~~~~~~~~~~~~ + +You can run the code from the ``variation`` subfolder, however, the +variation tool can be installed system wide by using the install script +in the root directory. + +.. code:: bash + + sh install-variation.sh + Repository Overview ------------------- @@ -122,34 +151,6 @@ flag of the tool. ./road-generation_executable -h -Documentation -------------- - -A simple but well designed C++ reference -`documentation `__ -is provided. - -Variation tool --------------- - -The Variation tool is used to generate a variety of different scenarios -based on the same general road network. A template file is provided to -specify variables as well as the general road network structure. A more -thorough documentation can be found in the `variation -subdirectory `__. - -.. _installation-1: - -Installation -~~~~~~~~~~~~ - -You can run the code from the ``variation`` subfolder, however, the -variation tool can be installed system wide by using the install script -in the root directory. - -.. code:: bash - - sh install-variation.sh Licenses -------- From ddb390bfc574cc0160bd08cee0f99e7892f18220 Mon Sep 17 00:00:00 2001 From: Jannik Busse <53993035+jannikbusse@users.noreply.github.com> Date: Thu, 2 Nov 2023 09:33:22 +0100 Subject: [PATCH 02/28] Update README.rst --- README.rst | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index bca346a..968cd22 100644 --- a/README.rst +++ b/README.rst @@ -64,16 +64,8 @@ subdirectory `__. .. _installation-1: -Installation -~~~~~~~~~~~~ - -You can run the code from the ``variation`` subfolder, however, the -variation tool can be installed system wide by using the install script -in the root directory. -.. code:: bash - sh install-variation.sh Repository Overview ------------------- @@ -91,6 +83,9 @@ Here, the main folders are named: Installation ------------ +Road Generation +--------------- + The following **requirements** have to be satisfied: - ``C++11`` @@ -132,6 +127,17 @@ Alternatively you can **build the project manually**: *Note:* In principal, it is possible to compile and use the tool in Windows operating systems. However, this is experimental. +Variation tool +-------------- + +You can run the code from the ``variation`` subfolder, however, the +variation tool can be installed system wide by using the install script +in the root directory. + +.. code:: bash + + sh install-variation.sh + Usage ----- From 82df0e2212fed8fed4320c6b94f69ba594e9a721 Mon Sep 17 00:00:00 2001 From: Jannik Busse <53993035+jannikbusse@users.noreply.github.com> Date: Thu, 2 Nov 2023 09:34:47 +0100 Subject: [PATCH 03/28] Update README.rst --- README.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 968cd22..025c996 100644 --- a/README.rst +++ b/README.rst @@ -62,7 +62,7 @@ specify variables as well as the general road network structure. A more thorough documentation can be found in the `variation subdirectory `__. -.. _installation-1: + @@ -83,8 +83,8 @@ Here, the main folders are named: Installation ------------ -Road Generation ---------------- +.. _Road Generation-1: + The following **requirements** have to be satisfied: @@ -127,8 +127,7 @@ Alternatively you can **build the project manually**: *Note:* In principal, it is possible to compile and use the tool in Windows operating systems. However, this is experimental. -Variation tool --------------- +.. _Variation tool-1: You can run the code from the ``variation`` subfolder, however, the variation tool can be installed system wide by using the install script From f71e90a5d2a0292029387955920f05ef323cc524 Mon Sep 17 00:00:00 2001 From: Jannik Busse <53993035+jannikbusse@users.noreply.github.com> Date: Thu, 2 Nov 2023 09:36:30 +0100 Subject: [PATCH 04/28] Update README.rst --- README.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 025c996..14a7b3e 100644 --- a/README.rst +++ b/README.rst @@ -83,8 +83,8 @@ Here, the main folders are named: Installation ------------ -.. _Road Generation-1: - +Road Generation +^^^^^^^^^^^^^^^ The following **requirements** have to be satisfied: @@ -127,7 +127,8 @@ Alternatively you can **build the project manually**: *Note:* In principal, it is possible to compile and use the tool in Windows operating systems. However, this is experimental. -.. _Variation tool-1: +Variation tool +^^^^^^^^^^^^^^ You can run the code from the ``variation`` subfolder, however, the variation tool can be installed system wide by using the install script From ee95f7436226bb3f5dda52ab42451d0b1ed3a68e Mon Sep 17 00:00:00 2001 From: Jannik Busse <53993035+jannikbusse@users.noreply.github.com> Date: Thu, 2 Nov 2023 09:54:07 +0100 Subject: [PATCH 05/28] Update README.rst --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 14a7b3e..0014ad0 100644 --- a/README.rst +++ b/README.rst @@ -84,7 +84,7 @@ Installation ------------ Road Generation -^^^^^^^^^^^^^^^ + The following **requirements** have to be satisfied: @@ -128,7 +128,7 @@ Alternatively you can **build the project manually**: Windows operating systems. However, this is experimental. Variation tool -^^^^^^^^^^^^^^ + You can run the code from the ``variation`` subfolder, however, the variation tool can be installed system wide by using the install script From 7b73d314836a5376a2f7983e1ca1ef7f96b89d19 Mon Sep 17 00:00:00 2001 From: Jannik Busse <53993035+jannikbusse@users.noreply.github.com> Date: Thu, 2 Nov 2023 09:56:33 +0100 Subject: [PATCH 06/28] Update README.rst --- README.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.rst b/README.rst index 0014ad0..026b789 100644 --- a/README.rst +++ b/README.rst @@ -10,6 +10,11 @@ Road Generation Tool for Basic OpenDRIVE Road Networks About ----- +.. collapse:: Open + :open: + + This section is open by default. + Simulation is a valuable building block for the verification and validation of automated driving functions (ADF). When simulating urban driving scenarios, simulation maps are one important component. Often, From 89b2c99b7571b58ae8d7658aab02893cc069fc3f Mon Sep 17 00:00:00 2001 From: Jannik Busse <53993035+jannikbusse@users.noreply.github.com> Date: Thu, 2 Nov 2023 09:56:55 +0100 Subject: [PATCH 07/28] Update README.rst --- README.rst | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.rst b/README.rst index 026b789..7901a9c 100644 --- a/README.rst +++ b/README.rst @@ -10,10 +10,6 @@ Road Generation Tool for Basic OpenDRIVE Road Networks About ----- -.. collapse:: Open - :open: - - This section is open by default. Simulation is a valuable building block for the verification and validation of automated driving functions (ADF). When simulating urban From 5db19873bdcaefdf2c845303d469fd253434e53c Mon Sep 17 00:00:00 2001 From: Jannik Busse <53993035+jannikbusse@users.noreply.github.com> Date: Thu, 2 Nov 2023 10:05:31 +0100 Subject: [PATCH 08/28] WIP: Update README.rst --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 7901a9c..02423f7 100644 --- a/README.rst +++ b/README.rst @@ -85,7 +85,7 @@ Installation ------------ Road Generation - +--------------- The following **requirements** have to be satisfied: @@ -129,7 +129,7 @@ Alternatively you can **build the project manually**: Windows operating systems. However, this is experimental. Variation tool - +-------------- You can run the code from the ``variation`` subfolder, however, the variation tool can be installed system wide by using the install script From df3d87a354d3995c9f4d318c09339e2ceacea72d Mon Sep 17 00:00:00 2001 From: Jannik Busse <53993035+jannikbusse@users.noreply.github.com> Date: Thu, 2 Nov 2023 12:30:27 +0100 Subject: [PATCH 09/28] Update README.rst --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index 02423f7..f22d3b5 100644 --- a/README.rst +++ b/README.rst @@ -65,7 +65,11 @@ subdirectory `__. +.. collapse:: A Different Label + :class: custom-summary + :name: summary0 + Something else that might escape notice. Repository Overview From a8dc392056a8c480be3eae62f3bd91b75156c3b2 Mon Sep 17 00:00:00 2001 From: Jannik Busse <53993035+jannikbusse@users.noreply.github.com> Date: Thu, 2 Nov 2023 12:33:27 +0100 Subject: [PATCH 10/28] Update README.rst --- README.rst | 115 +++++++++++++++++++++++++---------------------------- 1 file changed, 54 insertions(+), 61 deletions(-) diff --git a/README.rst b/README.rst index f22d3b5..78158cd 100644 --- a/README.rst +++ b/README.rst @@ -65,13 +65,6 @@ subdirectory `__. -.. collapse:: A Different Label - :class: custom-summary - :name: summary0 - - Something else that might escape notice. - - Repository Overview ------------------- @@ -88,60 +81,60 @@ Here, the main folders are named: Installation ------------ -Road Generation ---------------- - -The following **requirements** have to be satisfied: - -- ``C++11`` -- ``CMake 2.6 or higher`` -- ``Python 3.6`` -- ``xercesC`` - -**Download** the repository as a zip-file and un-zip, or use git with - -.. code:: bash - - # Clone Repository and open main folder - git clone git@github.com:ika-rwth-aachen/RoadGeneration.git - cd RoadGeneration - -A build script for Linux systems is provided and can be executed from -the root directory with - -.. code:: bash - - sh buildScript.sh - -Alternatively you can **build the project manually**: - -1. Install `XercesC `_ via a - package manager, e.g.: - -.. code:: bash - - $ sudo apt install libxerces-c-dev - -2. Build the Road-generation tool with standard cmake commands, e.g.: - -.. code:: bash - - $ mkdir -p build && cd build && cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../bin .. - $ cmake --build . - -*Note:* In principal, it is possible to compile and use the tool in -Windows operating systems. However, this is experimental. - -Variation tool --------------- - -You can run the code from the ``variation`` subfolder, however, the -variation tool can be installed system wide by using the install script -in the root directory. - -.. code:: bash - - sh install-variation.sh +*Road Generation + + + The following **requirements** have to be satisfied: + + - ``C++11`` + - ``CMake 2.6 or higher`` + - ``Python 3.6`` + - ``xercesC`` + + **Download** the repository as a zip-file and un-zip, or use git with + + .. code:: bash + + # Clone Repository and open main folder + git clone git@github.com:ika-rwth-aachen/RoadGeneration.git + cd RoadGeneration + + A build script for Linux systems is provided and can be executed from + the root directory with + + .. code:: bash + + sh buildScript.sh + + Alternatively you can **build the project manually**: + + 1. Install `XercesC `_ via a + package manager, e.g.: + + .. code:: bash + + $ sudo apt install libxerces-c-dev + + 2. Build the Road-generation tool with standard cmake commands, e.g.: + + .. code:: bash + + $ mkdir -p build && cd build && cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../bin .. + $ cmake --build . + + *Note:* In principal, it is possible to compile and use the tool in + Windows operating systems. However, this is experimental. + +* Variation tool + + + You can run the code from the ``variation`` subfolder, however, the + variation tool can be installed system wide by using the install script + in the root directory. + + .. code:: bash + + sh install-variation.sh Usage ----- From 9d8149dc09f079f5f8dca9b518aeb58a6832c35d Mon Sep 17 00:00:00 2001 From: Jannik Busse <53993035+jannikbusse@users.noreply.github.com> Date: Thu, 2 Nov 2023 12:33:46 +0100 Subject: [PATCH 11/28] Update README.rst --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 78158cd..721e31c 100644 --- a/README.rst +++ b/README.rst @@ -81,7 +81,7 @@ Here, the main folders are named: Installation ------------ -*Road Generation +* Road Generation The following **requirements** have to be satisfied: From aea8c8b7e7c778ab8132976ff43abe3a28dd66f4 Mon Sep 17 00:00:00 2001 From: Jannik Busse <53993035+jannikbusse@users.noreply.github.com> Date: Fri, 3 Nov 2023 09:10:04 +0100 Subject: [PATCH 12/28] Update README.rst --- README.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.rst b/README.rst index 721e31c..262374d 100644 --- a/README.rst +++ b/README.rst @@ -10,6 +10,18 @@ Road Generation Tool for Basic OpenDRIVE Road Networks About ----- +
+ Click me + + ### Heading + 1. Foo + 2. Bar + * Baz + * Qux + + ### Some Javascript + +
Simulation is a valuable building block for the verification and validation of automated driving functions (ADF). When simulating urban From ea12823fd1336c0ad2b8476990cde95517d1c767 Mon Sep 17 00:00:00 2001 From: Jannik Busse <53993035+jannikbusse@users.noreply.github.com> Date: Fri, 3 Nov 2023 09:26:51 +0100 Subject: [PATCH 13/28] Update README.rst --- README.rst | 120 ++++++++++++++++++++++++----------------------------- 1 file changed, 54 insertions(+), 66 deletions(-) diff --git a/README.rst b/README.rst index 262374d..abd9080 100644 --- a/README.rst +++ b/README.rst @@ -10,18 +10,6 @@ Road Generation Tool for Basic OpenDRIVE Road Networks About ----- -
- Click me - - ### Heading - 1. Foo - 2. Bar - * Baz - * Qux - - ### Some Javascript - -
Simulation is a valuable building block for the verification and validation of automated driving functions (ADF). When simulating urban @@ -93,60 +81,60 @@ Here, the main folders are named: Installation ------------ -* Road Generation - - - The following **requirements** have to be satisfied: - - - ``C++11`` - - ``CMake 2.6 or higher`` - - ``Python 3.6`` - - ``xercesC`` - - **Download** the repository as a zip-file and un-zip, or use git with - - .. code:: bash - - # Clone Repository and open main folder - git clone git@github.com:ika-rwth-aachen/RoadGeneration.git - cd RoadGeneration - - A build script for Linux systems is provided and can be executed from - the root directory with - - .. code:: bash - - sh buildScript.sh - - Alternatively you can **build the project manually**: - - 1. Install `XercesC `_ via a - package manager, e.g.: - - .. code:: bash - - $ sudo apt install libxerces-c-dev - - 2. Build the Road-generation tool with standard cmake commands, e.g.: - - .. code:: bash - - $ mkdir -p build && cd build && cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../bin .. - $ cmake --build . - - *Note:* In principal, it is possible to compile and use the tool in - Windows operating systems. However, this is experimental. - -* Variation tool - - - You can run the code from the ``variation`` subfolder, however, the - variation tool can be installed system wide by using the install script - in the root directory. - - .. code:: bash - - sh install-variation.sh +Road Generation +~~~~~~~~~~~~~~~ + + The following **requirements** have to be satisfied: + + - ``C++11`` + - ``CMake 2.6 or higher`` + - ``Python 3.6`` + - ``xercesC`` + + **Download** the repository as a zip-file and un-zip, or use git with + + .. code:: bash + + # Clone Repository and open main folder + git clone git@github.com:ika-rwth-aachen/RoadGeneration.git + cd RoadGeneration + + A build script for Linux systems is provided and can be executed from + the root directory with + + .. code:: bash + + sh buildScript.sh + + Alternatively you can **build the project manually**: + + 1. Install `XercesC `_ via a + package manager, e.g.: + + .. code:: bash + + $ sudo apt install libxerces-c-dev + + 2. Build the Road-generation tool with standard cmake commands, e.g.: + + .. code:: bash + + $ mkdir -p build && cd build && cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../bin .. + $ cmake --build . + + *Note:* In principal, it is possible to compile and use the tool in + Windows operating systems. However, this is experimental. + +Variation tool +~~~~~~~~~~~~~~ + + You can run the code from the ``variation`` subfolder, however, the + variation tool can be installed system wide by using the install script + in the root directory. + + .. code:: bash + + sh install-variation.sh Usage ----- From 08da88b5f767a96384e617de5c603648001a19c7 Mon Sep 17 00:00:00 2001 From: Jannik Busse <53993035+jannikbusse@users.noreply.github.com> Date: Fri, 3 Nov 2023 09:27:33 +0100 Subject: [PATCH 14/28] Update README.rst --- README.rst | 94 +++++++++++++++++++++++++++--------------------------- 1 file changed, 47 insertions(+), 47 deletions(-) diff --git a/README.rst b/README.rst index abd9080..f234a9b 100644 --- a/README.rst +++ b/README.rst @@ -84,57 +84,57 @@ Installation Road Generation ~~~~~~~~~~~~~~~ - The following **requirements** have to be satisfied: - - - ``C++11`` - - ``CMake 2.6 or higher`` - - ``Python 3.6`` - - ``xercesC`` - - **Download** the repository as a zip-file and un-zip, or use git with - - .. code:: bash - - # Clone Repository and open main folder - git clone git@github.com:ika-rwth-aachen/RoadGeneration.git - cd RoadGeneration - - A build script for Linux systems is provided and can be executed from - the root directory with - - .. code:: bash - - sh buildScript.sh - - Alternatively you can **build the project manually**: - - 1. Install `XercesC `_ via a - package manager, e.g.: - - .. code:: bash - - $ sudo apt install libxerces-c-dev - - 2. Build the Road-generation tool with standard cmake commands, e.g.: - - .. code:: bash - - $ mkdir -p build && cd build && cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../bin .. - $ cmake --build . - - *Note:* In principal, it is possible to compile and use the tool in - Windows operating systems. However, this is experimental. +The following **requirements** have to be satisfied: + +- ``C++11`` +- ``CMake 2.6 or higher`` +- ``Python 3.6`` +- ``xercesC`` + +**Download** the repository as a zip-file and un-zip, or use git with + +.. code:: bash + + # Clone Repository and open main folder + git clone git@github.com:ika-rwth-aachen/RoadGeneration.git + cd RoadGeneration + +A build script for Linux systems is provided and can be executed from +the root directory with + +.. code:: bash + + sh buildScript.sh + +Alternatively you can **build the project manually**: + +1. Install `XercesC `_ via a + package manager, e.g.: + +.. code:: bash + + $ sudo apt install libxerces-c-dev + +2. Build the Road-generation tool with standard cmake commands, e.g.: + +.. code:: bash + + $ mkdir -p build && cd build && cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../bin .. + $ cmake --build . + +*Note:* In principal, it is possible to compile and use the tool in +Windows operating systems. However, this is experimental. Variation tool ~~~~~~~~~~~~~~ - You can run the code from the ``variation`` subfolder, however, the - variation tool can be installed system wide by using the install script - in the root directory. - - .. code:: bash - - sh install-variation.sh +You can run the code from the ``variation`` subfolder, however, the +variation tool can be installed system wide by using the install script +in the root directory. + +.. code:: bash + + sh install-variation.sh Usage ----- From c14624ff0f2a71dedff503072ec293b6b74e5610 Mon Sep 17 00:00:00 2001 From: Jannik Busse Date: Mon, 13 Nov 2023 11:33:41 +0100 Subject: [PATCH 15/28] cleaned up doc starting page and updated readme --- docs/doc.rst | 4 ++-- docs/index.rst | 4 ---- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/doc.rst b/docs/doc.rst index 88d1dda..4e45b35 100644 --- a/docs/doc.rst +++ b/docs/doc.rst @@ -1,8 +1,8 @@ *************** -Documentation +Class reference *************** -This is the documentation for the Road Generation tool. +This is the class reference for the Road Generation tool. interface.h ============== diff --git a/docs/index.rst b/docs/index.rst index c41a4a0..8c25beb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,8 +4,6 @@ contain the root `toctree` directive. -Welcome to Road's documentation! -================================ .. include:: ../README.rst @@ -17,8 +15,6 @@ Welcome to Road's documentation! Road Generation Variation -* :ref:`genindex` -* :ref:`search` .. toctree:: :maxdepth: 3 From 5d31dfb5f9eb936fa51706945d0bf6b7fc4c8154 Mon Sep 17 00:00:00 2001 From: Jannik Busse Date: Mon, 13 Nov 2023 11:34:22 +0100 Subject: [PATCH 16/28] cleaned up doc starting page and updated readme --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index f234a9b..11ac3d5 100644 --- a/README.rst +++ b/README.rst @@ -52,7 +52,7 @@ Documentation A simple but well designed C++ reference `documentation `__ -is provided. +is provided. The input file format specification can be found `here `_ Variation tool -------------- From be44dda2223ed0ba7d3c1e9a76b1964c3deee116 Mon Sep 17 00:00:00 2001 From: Jannik Busse Date: Wed, 15 Nov 2023 18:07:36 +0100 Subject: [PATCH 17/28] added doc examples --- README.rst | 6 ++-- docs/inputdoc.rst | 71 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 74 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 11ac3d5..a359779 100644 --- a/README.rst +++ b/README.rst @@ -50,9 +50,9 @@ Fig.1: Possible workflow for the presend road variation tool. Documentation ------------- -A simple but well designed C++ reference -`documentation `__ -is provided. The input file format specification can be found `here `_ +If you want to include the library in your project, a simple but well designed C++ reference +`documentation `__ is provided. +The input file format specification can be found `here `_. Variation tool -------------- diff --git a/docs/inputdoc.rst b/docs/inputdoc.rst index 3a07293..4fabec1 100644 --- a/docs/inputdoc.rst +++ b/docs/inputdoc.rst @@ -719,6 +719,8 @@ Key points Example ''''''' +**Example linking** + .. code-block:: xml @@ -730,6 +732,39 @@ Example +**Complete input file** + +.. figure:: _static/link.png + :class: align-right + :width: 470 + +.. code-block:: xml + + + + + + + + + + + + + + + + + + + + + + + + + + CloseRoads ---------- @@ -749,6 +784,7 @@ To smoothly close open connections, roads and their respective linkage informati Example ''''''' +**Example linking** .. code-block:: xml @@ -759,3 +795,38 @@ Example + + +**Complete input file** + +.. figure:: _static/close.png + :class: align-right + :width: 470 + +.. code-block:: xml + + + + + + + + + + + + + + + + + + + + + + + + + + From 6d1d7b12cd1e15743e33ab4669caaa2d2dd8315e Mon Sep 17 00:00:00 2001 From: Jannik Busse Date: Thu, 16 Nov 2023 15:54:58 +0100 Subject: [PATCH 18/28] added elevation to doc --- docs/inputdoc.rst | 55 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/docs/inputdoc.rst b/docs/inputdoc.rst index 4fabec1..ca170a8 100644 --- a/docs/inputdoc.rst +++ b/docs/inputdoc.rst @@ -719,6 +719,8 @@ Key points Example ''''''' +You can find a example of the linking tag, as well as a minimal working example below. + **Example linking** .. code-block:: xml @@ -784,6 +786,9 @@ To smoothly close open connections, roads and their respective linkage informati Example ''''''' + +Below is an example of the close road tag and a minimal working example. + **Example linking** .. code-block:: xml @@ -830,3 +835,53 @@ Example + +Elevation +---------- + +Elevation is not currently supported in the road generation tool. However, the input format does support it for connecting roads. + + +elevationProfile +'''''''''''''''''' + +An elevation profile can be specified for each connecting road segment. A simple ramp or slope can be achieved by specifying the attributes listed below. + +.. csv-table:: + :widths: 100 100 100 100 50 + + **Name** , **Type** , **Range** , **Description** , **Required** + sR , double , positive , radius of curvature at the start of segment, yes + relEndHeight , double , all , relative end height of segment , yes + eR , double , positive , radius of curvature at the end of segment , yes + + +elevationPoint +'''''''''''''''' + +If a more complex height profile is required, additional elevation points can be specified. + +.. csv-table:: + :widths: 100 100 100 100 50 + + **Name** , **Type** , **Range** , **Description** , **Required** + s , double , positive , s offset of the elevation point, yes + height , double , all , height of elevation point , yes + r , double , positive , radius of curvature on elevation point , yes + + + +**Example elevation profile** + +.. code-block:: xml + + + + + + + + + + + From c195defafa181bf32217c5c00bb4fe47c88e4e02 Mon Sep 17 00:00:00 2001 From: Jannik Busse Date: Fri, 17 Nov 2023 09:50:54 +0100 Subject: [PATCH 19/28] Update Readme --- README.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.rst b/README.rst index a359779..b2284af 100644 --- a/README.rst +++ b/README.rst @@ -148,8 +148,7 @@ The compiled application can be called from the root folder: This generates the output OpenDRIVE file next to the input file. The provided input file is checked against ``input.xsd``. Analogous the output file is checked against the ``output.xsd`` file which specifies -the openDRIVE 1.5 standard. For a list of all parameters use the help -flag of the tool. +the openDRIVE standard. For a list of all parameters use: .. code:: bash From 8e666a1945ea82649d979a7490ffb228c01c927c Mon Sep 17 00:00:00 2001 From: Jannik Busse Date: Fri, 17 Nov 2023 10:16:39 +0100 Subject: [PATCH 20/28] minor changes --- README.rst | 6 ++++-- docs/inputdoc.rst | 6 +++--- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index b2284af..d7aa317 100644 --- a/README.rst +++ b/README.rst @@ -4,12 +4,14 @@ Road Generation Tool for Basic OpenDRIVE Road Networks .. image:: https://camo.githubusercontent.com/83d3746e5881c1867665223424263d8e604df233d0a11aae0813e0414d433943/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e737667 -.. inclusion-marker + About ----- +.. inclusion-marker + Simulation is a valuable building block for the verification and validation of automated driving functions (ADF). When simulating urban @@ -50,7 +52,7 @@ Fig.1: Possible workflow for the presend road variation tool. Documentation ------------- -If you want to include the library in your project, a simple but well designed C++ reference +If you want to include the library in a project, a simple but well designed C++ reference `documentation `__ is provided. The input file format specification can be found `here `_. diff --git a/docs/inputdoc.rst b/docs/inputdoc.rst index ca170a8..b9e472a 100644 --- a/docs/inputdoc.rst +++ b/docs/inputdoc.rst @@ -845,7 +845,7 @@ Elevation is not currently supported in the road generation tool. However, the i elevationProfile '''''''''''''''''' -An elevation profile can be specified for each connecting road segment. A simple ramp or slope can be achieved by specifying the attributes listed below. +An elevation profile can be specified for each connecting road segment with an `elevationPoint` tag. A simple ramp or slope can be achieved by specifying the attributes listed below. .. csv-table:: :widths: 100 100 100 100 50 @@ -859,7 +859,7 @@ An elevation profile can be specified for each connecting road segment. A simple elevationPoint '''''''''''''''' -If a more complex height profile is required, additional elevation points can be specified. +If a more complex height profile is required, additional elevation points can be specified with the `elevationPoint` tag. .. csv-table:: :widths: 100 100 100 100 50 @@ -881,7 +881,7 @@ If a more complex height profile is required, additional elevation points can be - + From 577c77f35dfbd2ac84a7480e21016b445a7aed23 Mon Sep 17 00:00:00 2001 From: Jannik Busse Date: Fri, 17 Nov 2023 11:23:39 +0100 Subject: [PATCH 21/28] fixed typo --- docs/inputdoc.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/inputdoc.rst b/docs/inputdoc.rst index b9e472a..21d8ad2 100644 --- a/docs/inputdoc.rst +++ b/docs/inputdoc.rst @@ -708,6 +708,7 @@ SegmentLink fromPos, string , 'start' 'end' , specifies if the fromSegment should be linked at its beginning or end , yes toPos, string , 'start' 'end' , specifies if the toSegment should be linked at its beginning or end , yes + Key points ^^^^^^^^^^ @@ -716,8 +717,8 @@ Key points * Segments have a seperate namespace from Roads, i.e. multiple roads with the ID 1 can exist under differen segments -Example -''''''' +Examples +'''''''' You can find a example of the linking tag, as well as a minimal working example below. From 888761605ffc689ca279e6478a0a70da683a346e Mon Sep 17 00:00:00 2001 From: Jannik Busse Date: Fri, 24 Nov 2023 13:38:46 +0100 Subject: [PATCH 22/28] refactor: update attribute names --- docs/inputdoc.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/inputdoc.rst b/docs/inputdoc.rst index 21d8ad2..61f85a8 100644 --- a/docs/inputdoc.rst +++ b/docs/inputdoc.rst @@ -852,9 +852,9 @@ An elevation profile can be specified for each connecting road segment with an ` :widths: 100 100 100 100 50 **Name** , **Type** , **Range** , **Description** , **Required** - sR , double , positive , radius of curvature at the start of segment, yes - relEndHeight , double , all , relative end height of segment , yes - eR , double , positive , radius of curvature at the end of segment , yes + startRadius , double , positive , radius of curvature at the start of segment, yes + heightDifference , double , all , relative end height of segment , yes + endRadius , double , positive , radius of curvature at the end of segment , yes elevationPoint @@ -868,7 +868,7 @@ If a more complex height profile is required, additional elevation points can be **Name** , **Type** , **Range** , **Description** , **Required** s , double , positive , s offset of the elevation point, yes height , double , all , height of elevation point , yes - r , double , positive , radius of curvature on elevation point , yes + R , double , positive , radius of curvature on elevation point , yes @@ -881,8 +881,8 @@ If a more complex height profile is required, additional elevation points can be - - + + From 2942d94bcc07c23fb3983e66e234a8f84f2cfb8b Mon Sep 17 00:00:00 2001 From: Jannik Busse Date: Fri, 24 Nov 2023 13:47:57 +0100 Subject: [PATCH 23/28] docs: update input doc about elevation --- docs/inputdoc.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/inputdoc.rst b/docs/inputdoc.rst index 61f85a8..c6534b8 100644 --- a/docs/inputdoc.rst +++ b/docs/inputdoc.rst @@ -846,7 +846,7 @@ Elevation is not currently supported in the road generation tool. However, the i elevationProfile '''''''''''''''''' -An elevation profile can be specified for each connecting road segment with an `elevationPoint` tag. A simple ramp or slope can be achieved by specifying the attributes listed below. +An elevation profile can be specified for each connecting road segment with an `elevationPoint` tag. A simple ramp or slope can be achieved by specifying the attributes listed below. The `heightDifference` is relative to the height of the segment start (at `s=0`). .. csv-table:: :widths: 100 100 100 100 50 @@ -860,7 +860,7 @@ An elevation profile can be specified for each connecting road segment with an ` elevationPoint '''''''''''''''' -If a more complex height profile is required, additional elevation points can be specified with the `elevationPoint` tag. +If a more complex height profile is required, additional elevation points can be specified with the `elevationPoint` tag. Elevation points are specified relative to the height of the segment start (at `s=0`). .. csv-table:: :widths: 100 100 100 100 50 From 08de512a4d922976baf8d33ffeda995477cea2ea Mon Sep 17 00:00:00 2001 From: Jannik Busse Date: Thu, 30 Nov 2023 16:18:28 +0100 Subject: [PATCH 24/28] fixed typo --- docs/doc.rst | 2 +- docs/inputdoc.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/doc.rst b/docs/doc.rst index 4e45b35..ca5344e 100644 --- a/docs/doc.rst +++ b/docs/doc.rst @@ -1,5 +1,5 @@ *************** -Class reference +Class Reference *************** This is the class reference for the Road Generation tool. diff --git a/docs/inputdoc.rst b/docs/inputdoc.rst index c6534b8..1d5f862 100644 --- a/docs/inputdoc.rst +++ b/docs/inputdoc.rst @@ -1,4 +1,4 @@ -Input file format +Input File Format ================= This section explains the input format and provides examples for basic usecases. Furthermore a variety of template files can be found in `io/Templates`. If the input `xsd` scheme was subject to change, this documentation needs to be updated. From de09214ef841c3ba0a81bfae551472855193bdc7 Mon Sep 17 00:00:00 2001 From: Jannik Busse Date: Thu, 30 Nov 2023 16:45:51 +0100 Subject: [PATCH 25/28] doc: update readme and update sphinx landing page --- README.rst | 4 ++-- docs/index.rst | 17 ++++++++++++++++- 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index d7aa317..135f3db 100644 --- a/README.rst +++ b/README.rst @@ -74,9 +74,9 @@ This repository provides a tool for the generation of road networks. Here, the main folders are named: - ``doc``: Resources for documentation -- ``io``: Sample input files +- ``examples``: Examlpe and Template files that showcase minimal working input networks - ``src``: Source code -- ``test``: Test files and their desired OpenDRIVE outputs +- ``test``: Test file .xml and .xodr pairs - ``xml``: Contains the XSD validation files - ``variation``: Python based variation tool for the road generator diff --git a/docs/index.rst b/docs/index.rst index 8c25beb..95a6305 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,7 +5,22 @@ -.. include:: ../README.rst +Road Generation Documentation +============================= + +Welcome to the documentation for `Road Generation `_! + +If you want to use the Road Generation tool you can can follow the `Installation instructions `_. +If you are unsure about the input format, we recommend to chekout the `Input Documentation `_. + +Content +^^^^^^^ + +#. `Installation instructions `_ +#. `Variation Tool Documentation `_ +#. `Input Documentation `_ + + .. toctree:: :maxdepth: 3 From d23a0e4de1369ffb25ec64d668253519fd924e3a Mon Sep 17 00:00:00 2001 From: Jannik Busse Date: Thu, 30 Nov 2023 16:46:14 +0100 Subject: [PATCH 26/28] minor changes --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 135f3db..821eaa5 100644 --- a/README.rst +++ b/README.rst @@ -74,7 +74,7 @@ This repository provides a tool for the generation of road networks. Here, the main folders are named: - ``doc``: Resources for documentation -- ``examples``: Examlpe and Template files that showcase minimal working input networks +- ``examples``: Examlpe and Template files that showcase minimal working inputs - ``src``: Source code - ``test``: Test file .xml and .xodr pairs - ``xml``: Contains the XSD validation files From 691ca30b760bb7f2fd57540dd1f1989f4af01599 Mon Sep 17 00:00:00 2001 From: Jannik Busse Date: Thu, 30 Nov 2023 16:50:24 +0100 Subject: [PATCH 27/28] doc: update variation doc --- docs/index.rst | 4 ++-- variation/README.rst | 3 +-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 95a6305..a8c315b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,13 +10,13 @@ Road Generation Documentation Welcome to the documentation for `Road Generation `_! -If you want to use the Road Generation tool you can can follow the `Installation instructions `_. +If you want to use the Road Generation tool you can can follow the `Installation instructions `_. If you are unsure about the input format, we recommend to chekout the `Input Documentation `_. Content ^^^^^^^ -#. `Installation instructions `_ +#. `Road Generation `_ #. `Variation Tool Documentation `_ #. `Input Documentation `_ diff --git a/variation/README.rst b/variation/README.rst index e6a970a..21ca6e8 100644 --- a/variation/README.rst +++ b/variation/README.rst @@ -5,8 +5,7 @@ Variation Tool The variation tool makes use of the road-generation library and -generates several variations of an OpenDRIVE road network that is -provided by a template file. The main goal was to create an easy to use +generates several variations of an OpenDRIVE road network. A special template file is provided to set the parameters of the variation. The main goal was to create an easy to use syntax while allowing the user to specify constraints for the output scenarios. From 939f6e0a781f2fe6f67f67071bc2a3d1924fb463 Mon Sep 17 00:00:00 2001 From: Jannik Busse Date: Thu, 30 Nov 2023 16:56:52 +0100 Subject: [PATCH 28/28] doc: updated landing page --- docs/index.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index a8c315b..0f75b1c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,10 +8,8 @@ Road Generation Documentation ============================= -Welcome to the documentation for `Road Generation `_! - -If you want to use the Road Generation tool you can can follow the `Installation instructions `_. -If you are unsure about the input format, we recommend to chekout the `Input Documentation `_. +Welcome to the documentation for `Road Generation `_! If you intend to use the tool, please follow the `Installation instructions `_. +If you have questions about the input format, it is recommended to refer to the `Input Documentation `_. Content ^^^^^^^