|
2 | 2 | 
|
3 | 3 | # Rmagine
|
4 | 4 |
|
5 |
| -Rmagine allows a robot to simulate sensor data for arbitrary range sensors directly on board via raytracing. Since robots typically only have limited computational resources, Rmagine aims at being flexible and lightweight, while scaling well even to large environment maps. It runs on several platforms like Laptops or embedded computing boards like Nvidia Jetson by putting an unified API over specific proprietary libraries provided by the hardware manufacturers. This work is designed to support the future development of robotic applications depending on simulation of range data that could previously not be computed in reasonable time on mobile systems. |
| 5 | +[Rmagine](https://github.com/uos/rmagine) allows a robot to simulate sensor data for arbitrary range sensors directly on board via raytracing. Since robots typically only have limited computational resources, [Rmagine](https://github.com/uos/rmagine) aims at being flexible and lightweight, while scaling well even to large environment maps. It runs on several platforms like Laptops or embedded computing boards like Nvidia Jetson by putting an unified API over specific proprietary libraries provided by the hardware manufacturers. This work is designed to support the future development of robotic applications depending on simulation of range data that could previously not be computed in reasonable time on mobile systems. |
6 | 6 |
|
7 | 7 | ## Design Goals
|
8 | 8 |
|
9 |
| -Rmagine is mainly designed for robotic applications: |
| 9 | +[Rmagine](https://github.com/uos/rmagine) is mainly designed for robotic applications: |
10 | 10 |
|
11 | 11 | - Perform multiple sensor simulations simultaneously and in realtime.
|
12 | 12 | - Compute the same operations on different computing devices (CPU, GPU..).
|
@@ -42,7 +42,7 @@ When using the Rmagine library or any related ideas in your scientific work, ple
|
42 | 42 |
|
43 | 43 | ## Table of Contents
|
44 | 44 |
|
45 |
| -This documentation cosists of several examples, guides and conceptual explanations to give users a more thourough understanding about Rmagine. |
| 45 | +This documentation cosists of several examples, guides and conceptual explanations to give users a more thourough understanding of [Rmagine](https://github.com/uos/rmagine). |
46 | 46 | As the name tells, new users should make themselfs familar with **Getting Started** first, before continuing to the more advanced examples.
|
47 | 47 |
|
48 | 48 | **Rmagine**
|
@@ -77,13 +77,13 @@ As the name tells, new users should make themselfs familar with **Getting Starte
|
77 | 77 |
|
78 | 78 | ## Contributions
|
79 | 79 |
|
80 |
| -You are welcome to contribute to the docs of [Rmagine](https://github.com/uos/rmagine)! Thorough and clear documentation is essential. You can help us by correcting mistakes, improving content, or adding examples that facilitate user navigation and usage of the project. Please submit any documentation-related issues to the repository https://github.com/uos/rmagine_docs. If you're making fixes or adding examples, don’t hesitate to submit a pull request afterward! |
| 80 | +You are welcome to contribute to the docs of [Rmagine](https://github.com/uos/rmagine)! Thorough and clear documentation is essential. You can help us by correcting mistakes, improving content, or adding examples that facilitate user navigation and usage of the project. Please submit any documentation-related issues to the repository [rmagine_docs](https://github.com/uos/rmagine_docs). If you're making fixes or adding examples, don’t hesitate to submit a pull request afterward! |
81 | 81 |
|
82 | 82 | ### PR workflow
|
83 | 83 |
|
84 | 84 | How to contribute to this documentation via pull requests:
|
85 | 85 |
|
86 |
| -1. Fork the repository: https://github.com/uos/rmagine_docs. |
| 86 | +1. Fork the repository: [rmagine_docs](https://github.com/uos/rmagine_docs). |
87 | 87 | 2. Make changes on your forked repository.
|
88 | 88 | 3. Check locally on your machine if mkdocs is able to compile your changes ([instructions](https://github.com/uos/rmagine_docs)).
|
89 | 89 | 4. Go to Github and click "Pull Request", select this repository's "main" branch as target.
|
|
0 commit comments