Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: gui documentation integration #492

Merged
merged 3 commits into from
Dec 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions docs/installation/autoware/source-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ sudo apt-get -y install git

## How to set up a workspace

!!! info [Using Autoware Build GUI](#using-autoware-build-gui)
Copy link
Contributor

@xmfcx xmfcx Jan 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

!!! info should either be alone or within quotes like in https://squidfunk.github.io/mkdocs-material/reference/admonitions/#changing-the-title

!!! note "Phasellus posuere in sem ut cursus"

  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
  nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
  massa, nec semper lorem quam in massa.

Right now it looks broken:

Screenshot from 2024-01-29 17-34-15

@KhalilSelyan could you create a mini PR to fix this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, just created one at #512


If you prefer a graphical user interface (GUI) over the command line for launching and managing your simulations, refer to the `Using Autoware Build GUI` section at the end of this document for a step-by-step guide.

1. Create the `src` directory and clone repositories into it.

Autoware uses [vcstool](https://github.com/dirk-thomas/vcstool) to construct workspaces.
Expand Down Expand Up @@ -136,3 +140,37 @@ sudo apt-get -y install git
```bash
colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release
```

## Using Autoware Build GUI

In addition to the traditional command-line methods of building Autoware packages, developers and users can leverage the Autoware Build GUI for a more streamlined and user-friendly experience. This GUI application simplifies the process of building and managing Autoware packages.

### Integration with Autoware Source Installation

When using the Autoware Build GUI in conjunction with the traditional source installation process:

- **Initial Setup**: Follow the standard Autoware source installation guide to set up your environment and workspace.
- **Using the GUI**: Once the initial setup is complete, you can use the Autoware Build GUI to manage subsequent builds and package updates.

This integration offers a more accessible approach to building and managing Autoware packages, catering to both new users and experienced developers.

### Getting Started with Autoware Build GUI

1. **Installation:** Ensure you have installed the Autoware Build GUI. [Installation instructions](https://github.com/autowarefoundation/autoware-build-gui#installation).
2. **Launching the App**: Once installed, launch the Autoware Build GUI.
![Build_GUI_Main](images/build-gui/build_gui_main.png)
3. **Setting Up**: Set the path to your Autoware folder within the GUI.
![Build_GUI_Setup](images/build-gui/build_gui_setup.png)
4. **Building Packages**: Select the Autoware packages you wish to build and manage the build process through the GUI.
![Build_GUI_Build](images/build-gui/build_gui_build.png)

4.1. **Build Configuration**: Choose from a list of default build configurations, or select the packages you wish to build manually.
![Build_GUI_Build_Configuration](images/build-gui/build_gui_build_configuration.png)

4.2. **Build Options**: Choose which build type you wish to use, with ability to specify additional build options.
![Build_GUI_Build_Options](images/build-gui/build_gui_build_options.png)

5. **Save and Load**: Save your build configurations for future use, or load a previously saved configuration if you don't wish to build all packages or use one of the default configurations provided.
![Build_GUI_Save](images/build-gui/build_gui_save.png)
6. **Updating Workspace**: Update your Autoware workspace's packages to the latest version using the GUI or adding Calibration tools to the workspace.
![Build_GUI_Update](images/build-gui/build_gui_update.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
51 changes: 51 additions & 0 deletions docs/tutorials/ad-hoc-simulation/planning-simulation.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ If not, please, follow [Manual downloading of artifacts](https://github.com/auto

## Basic simulations

!!! info [Using Autoware Launch GUI](#using-autoware-launch-gui)

If you prefer a graphical user interface (GUI) over the command line for launching and managing your simulations, refer to the `Using Autoware Launch GUI` section at the end of this document for a step-by-step guide.

### Lane driving scenario

#### 1. Launch Autoware
Expand Down Expand Up @@ -203,3 +207,50 @@ You can update the color of the traffic light by selecting the next color (in th
To remove a traffic light from `TrafficLightPublishPanel`, click the `RESET` button.

[Reference video tutorials](https://drive.google.com/file/d/1bs_dX1JJ76qHk-SGvS6YF9gmekkN8fz7/view?usp=sharing)

## Using Autoware Launch GUI

This section provides a step-by-step guide on using the Autoware Launch GUI for planning simulations, offering an alternative to the command-line instructions provided in the Basic simulations section.

### Getting Started with Autoware Launch GUI

1. **Installation:** Ensure you have installed the Autoware Launch GUI. [Installation instructions](https://github.com/autowarefoundation/autoware-launch-gui#installation).

2. **Launching the GUI:** Open the Autoware Launch GUI from your applications menu.

![GUI screenshot for launching the GUI](images/planning/launch-gui/launch_gui_main.png)

### Launching a Planning Simulation

#### Lane Driving Scenario

1. **Set Autoware Path:** In the GUI, set the path to your Autoware installation.

![GUI_screenshot_for_setting_Autoware_path](images/planning/launch-gui/launch_gui_setup.png)

2. **Select Launch File:** Choose `planning_simulator.launch.xml` for the lane driving scenario.

![GUI screenshot for selecting launch file](images/planning/launch-gui/selecting_launch_file.png)

3. **Customize Parameters:** Adjust parameters such as `map_path`, `vehicle_model`, and `sensor_model` as needed.

![GUI screenshot for customizing parameters](images/planning/launch-gui/customizing-parameters1.png)
![GUI screenshot for customizing parameters](images/planning/launch-gui/customizing-parameters2.png)

4. **Start Simulation:** Click the launch button to start the simulation.

![GUI screenshot for starting simulation](images/planning/launch-gui/starting_simulation.png)

5. **Any Scenario:** From here, you can follow the instructions in the

- Lane driving scenario: [Lane Driving Scenario](#lane-driving-scenario)
- Parking scenario: [Parking scenario](#parking-scenario)
- Lane change scenario: [Lane change scenario](#lane-change-scenario)
- Avoidance scenario: [Avoidance scenario](#avoidance-scenario)
- Advanced Simulations: [Advanced Simulations](#advanced-simulations)

### Monitoring and Managing the Simulation

- **Real-Time Monitoring:** Use the GUI to monitor CPU/Memory usage and Autoware logs in real-time.
- **Profile Management:** Save your simulation profiles for quick access in future simulations.
- **Adjusting Parameters:** Easily modify simulation parameters on-the-fly through the GUI.
54 changes: 54 additions & 0 deletions docs/tutorials/ad-hoc-simulation/rosbag-replay-simulation.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@

## How to run a rosbag replay simulation

!!! info [Using Autoware Launch GUI](#using-autoware-launch-gui)

If you prefer a graphical user interface (GUI) over the command line for launching and managing your simulations, refer to the `Using Autoware Launch GUI` section at the end of this document for a step-by-step guide.

1. Launch Autoware.

```sh
Expand Down Expand Up @@ -76,3 +80,53 @@
![third-person-follower](images/rosbag-replay/third-person-follower.png)

[Reference video tutorials](https://drive.google.com/file/d/12D6aSC1Y3Kf7STtEPWG5RYynxKdVcPrc/view?usp=sharing)

## Using Autoware Launch GUI

This section provides a step-by-step guide for using the Autoware Launch GUI to launch and manage your rosbag replay simulation. offering an alternative to the command-line instructions provided in the previous section.

### Getting Started with Autoware Launch GUI

1. **Installation:** Ensure you have installed the Autoware Launch GUI. [Installation instructions](https://github.com/autowarefoundation/autoware-launch-gui#installation).

2. **Launching the GUI:** Open the Autoware Launch GUI from your applications menu.
![GUI_screenshot_for_launching](images/rosbag-replay/launch-gui/launch_gui_main.png)

### Launching a Logging Simulation

1. **Set Autoware Path:** In the GUI, set the path to your Autoware installation.
![GUI_screenshot_for_setting_Autoware_path](images/rosbag-replay/launch-gui/launch_gui_setup.png)
2. **Select Launch File:** Choose `logging_simulator.launch.xml` for the lane driving scenario.
![GUI screenshot for selecting launch file](images/rosbag-replay/launch-gui/selecting_launch_file.png)
3. **Customize Parameters:** Adjust parameters such as `map_path`, `vehicle_model`, and `sensor_model` as needed.

![GUI screenshot for customizing parameters](images/rosbag-replay/launch-gui/customizing-parameters1.png)
![GUI screenshot for customizing parameters](images/rosbag-replay/launch-gui/customizing-parameters2.png)

4. **Start Simulation:** Click the launch button to start the simulation and have access to all the logs.

![GUI screenshot for starting simulation](images/rosbag-replay/launch-gui/starting_simulation.png)

5. **Play Rosbag:** Move to the `Rosbag` tab and select the rosbag file you wish to play.

![GUI screenshot for selecting rosbag file](images/rosbag-replay/launch-gui/selecting_rosbag_file.png)

6. **Adjust Playback Speed:** Adjust the playback speed as needed and any other parameters you wish to customize.

![GUI screenshot for adjusting playback speed](images/rosbag-replay/launch-gui/adjusting_flags.png)

7. **Start Playback:** Click the play button to start the rosbag playback and have access to settings such as `pause/play`, `stop`, and `speed slider`5.

![GUI screenshot for starting playback](images/rosbag-replay/launch-gui/starting_playback.png)

8. **View Simulation:** Move to the `RViz` window to view the simulation.

![after-rosbag-play](images/rosbag-replay/after-rosbag-play.png)

9. To focus the view on the ego vehicle, change the `Target Frame` in the RViz Views panel from `viewer` to `base_link`.

![change-target-frame](images/rosbag-replay/change-target-frame.png)

10. To switch the view to `Third Person Follower` etc, change the `Type` in the RViz Views panel.

![third-person-follower](images/rosbag-replay/third-person-follower.png)
Loading