Skip to content
Snippets Groups Projects
README.md 2.74 KiB
Newer Older
Simon Wittl's avatar
Simon Wittl committed
![test](https://mygit.th-deg.de/roboct/robo_quality/gitlab-profile/-/raw/main/resources/rq_workflow.svg?inline=false)

Simon Wittl's avatar
Simon Wittl committed
# RoboQuality Project
Simon Wittl's avatar
Simon Wittl committed

Simon Wittl's avatar
Simon Wittl committed
Main repo for the RoboQuality project. Every workpackages is organized in an own repository and added as submodules to this main repository. 
Simon Wittl's avatar
Simon Wittl committed

Simon Wittl's avatar
Simon Wittl committed
## Development Installation
Simon Wittl's avatar
Simon Wittl committed

Simon Wittl's avatar
Simon Wittl committed
1. Clone repo. Check if all submodules are downloaded to the `src` folder recursivly:

```shell
git clone --recurse-submodules https://mygit.th-deg.de/roboct/robo_quality/rq_workflow
``` 

Simon Wittl's avatar
Simon Wittl committed
2. Install ROS2 Humble (LTS version):   
https://docs.ros.org/en/rolling/Releases/Release-Humble-Hawksbill.html 
Simon Wittl's avatar
Simon Wittl committed
3. Sources ROS2:

- Ubuntu:
```bash
source /opt/ros/humble/setup.bash
```
- Win / powershell:

```shell
C:\dev\ros2_humble\setup.ps1
```

Simon Wittl's avatar
Simon Wittl committed
5. Build the modules. Use the following command from the main folder of this repo:   
Simon Wittl's avatar
Simon Wittl committed
```shell
colcon build --merge-install
```
Simon Wittl's avatar
Simon Wittl committed
6. Launch all or single modules.
Simon Wittl's avatar
Simon Wittl committed

Simon Wittl's avatar
Simon Wittl committed
### Folder Structure (after building)


```
.  
├── build                    # Builded packages ...
│   ├── ...  
├── install                  # Local workspace ...
│   ├── local_setup.bash  
│   ├── ...  
├── log                      # Build and node logs ...
│   ├── ...  
Simon Wittl's avatar
Simon Wittl committed
├── src                      # Submodules
Simon Wittl's avatar
Simon Wittl committed
│   ├── rq_controller  
│   ├── rq_ddetection  
│   ├── rq_hardware  
Simon Wittl's avatar
Simon Wittl committed
│   ├── rq_interfaces
│   ├── rq_reconstruction  
Simon Wittl's avatar
Simon Wittl committed
│   ├── ros2_numpy_win       # (forked git module for win installation)
Simon Wittl's avatar
Simon Wittl committed
│   └── rq_trajectory  
└── README.md  

```

Simon Wittl's avatar
Simon Wittl committed
## Packages Overview

| Submodule          | Describtion                                   |  Link                                                                      |
|--------------------|-----------------------------------------------|----------------------------------------------------------------------------|
| `Controller`       |  Workflow controller. Holds all information.  | [rq_controller](https://mygit.th-deg.de/roboct/robo_quality/rq_controller) |
| `Defect Detection` |  Defect detection module                      | [rq_ddetection](https://mygit.th-deg.de/roboct/robo_quality/rq_ddetection) |
| `Hardware`         |  Interface to real / simulated system         | [rq_hardware](https://mygit.th-deg.de/roboct/robo_quality/rq_hardware)     |
| `Trajectory`       |  CT-Trajectory optimization                   | [rq_trajectory](https://mygit.th-deg.de/roboct/robo_quality/rq_trajectory) |
Simon Wittl's avatar
Simon Wittl committed
| `Reconstruction`   |  CT-Reconstruction node                       | [rq_reconstruction](https://mygit.th-deg.de/roboct/robo_quality/rq_reconstruction) |
Simon Wittl's avatar
Simon Wittl committed
| `Interfaces`       |  project intern interfaces for all msg / srv. | [rq_interfaces](https://mygit.th-deg.de/roboct/robo_quality/rq_interfaces) |