Skip to content

Commit

Permalink
working on wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
AntoineRichard committed Sep 10, 2024
1 parent 9314e2a commit 461cb59
Show file tree
Hide file tree
Showing 40 changed files with 222 additions and 1,855 deletions.
65 changes: 0 additions & 65 deletions wiki/Contribute.md

This file was deleted.

4 changes: 4 additions & 0 deletions wiki/FAQ/FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Frequently Asked Questions

> [!Warning]
> This page is under construction.
1 change: 1 addition & 0 deletions wiki/FAQ/_Footer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Antoine Richard -- University of Luxembourg -- Space Robotics Group -- 2023-24
2 changes: 2 additions & 0 deletions wiki/FAQ/_Sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
## Table of Contents
- [Back to Home](../Home)
Empty file removed wiki/GettingStarted.md
Empty file.
19 changes: 14 additions & 5 deletions wiki/Home.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Welcome to OmniLRS's Wiki
Welcome to OmniLRS's Wiki

<center>
<img src="media/Logov2.png" width=520/>
Expand All @@ -15,15 +15,24 @@ and the Space Robotics Lab from Tohoku University in Japan (SRL).

| <div style="width:70px">Name</div> | <div style="width:230px">Description</div> | Images |
|------------|-------------|---------------------------------|
| **Lunalab** | <div style="width:230px"> Digital-Twin of lunar analog at the University of Luxembourg. This environment also supports terrain deformation as the rover drives on it. </div> | <img src="wiki/media/env_img/lunalab.png" width=520/> |
| **Lunaryard** | <div style="width:230px">A small scale procedually generated lunar environment. If lunar coordinates and a date is provided the position of the earth and sun are computed using ephemerides resulting in realistic lighting. This feature is also available in the large scale environments. This environment also support terrain deformation as the rover drives on it.</div> | <img src="wiki/media/env_img/lunaryard_husky_ex1.png" width=520/> |
| **LargeScale** | <div style="width:230px">Semi procedural lunar environment. It uses real DEM to reconstuct the coarse terrain, usually 5meters per pixel and then uses procedural generation to augment it to 2.5cm per pixel. The terrain itself can be generated at a even higher resolution to smooth out shadows. This very fine terrain allows to reconstruct fine terrain features increasing the engineering value of the sim. The whole of this is bundled inside Geometry clip maps, allowing to render very large scenes.</div> | <img src="wiki/media/env_img/large_scale.png" width=520/>
| **Lunalab** | <div style="width:230px"> Digital-Twin of lunar analog at the University of Luxembourg. This environment also supports terrain deformation as the rover drives on it. </div> | <img src="media/env_img/lunalab.png" width=520/> |
| **Lunaryard** | <div style="width:230px">A small scale procedually generated lunar environment. If lunar coordinates and a date is provided the position of the earth and sun are computed using ephemerides resulting in realistic lighting. This feature is also available in the large scale environments. This environment also support terrain deformation as the rover drives on it.</div> | <img src="media/env_img/lunaryard_husky_ex1.png" width=520/> |
| **LargeScale** | <div style="width:230px">Semi procedural lunar environment. It uses real DEM to reconstuct the coarse terrain, usually 5meters per pixel and then uses procedural generation to augment it to 2.5cm per pixel. The terrain itself can be generated at a even higher resolution to smooth out shadows. This very fine terrain allows to reconstruct fine terrain features increasing the engineering value of the sim. The whole of this is bundled inside Geometry clip maps, allowing to render very large scenes.</div> | <img src="media/env_img/large_scale.png" width=520/>

> [!NOTE]
> Please note that this is a partial release. More robots will be made available at a later date. Should you run into a bug, or would like to request a new feature, feel free to open an issue. Want to collaborate, reach out to us!
## Wiki's overview

> [!CAUTION]
> [!WARNING]
> This wiki is still under construction, if you are looking for something in particular that's not yet docummented please open an issue.
- [Installation](installation/Installation.md)
- [Getting Started](getting_started/GettingStarted.md)
- [Interracting with the Scene](scene_interaction/ros_topics.md)
- [Configuring simulation modes](modes/Modes.md)
- [Configuring the environments](environments/Environments.md)
- [Configuring the rendering](rendering/Rendering.md)
- [Configuring the physics](physics/Physics.md)
- [Contribute](contribute/Contribute.md)
- [FAQ](FAQ/FAQ.md)
2 changes: 1 addition & 1 deletion wiki/_Footer.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2024 -- Antoine Richard -- University of Luxembourg -- SpaceR
Antoine Richard -- University of Luxembourg -- Space Robotics Group -- 2023-24
25 changes: 0 additions & 25 deletions wiki/_Sidebar.md

This file was deleted.

31 changes: 31 additions & 0 deletions wiki/contribute/Contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Contribute

We are continuously looking to expend our feature set. Because this project is not funded it's hard for the Space Robotic's group of the University of Luxembourg to support the whole of this development. Hence we would love the community to help us build new features. But also to tell us what are the features you'd like to see! We list below the features/improvements we'd like to push forward in the near future.

> [!Note]
> Feel free to suggest a new feature by opening an issue!

## Targeted Features

- [x] Thermal simulation. JAOPS
- [x] Solar power simulation. JAOPS
- [ ] Quadruped demo.
- [x] 3D Navigation demo. SpaceR
- [x] SLAM dataset generator. SpaceR
- [ ] Geographic Geometry clip map.
- [x] Improve procedural map generation. SpaceR
- [x] AI augmented low-resolution clipmaps. SpaceR
- [ ] Proper database to store object.
- [ ] Compression of CraterMetaData.
- [ ] Wheel traces for large scale terrains.
- [ ] Better lens flares.
- [ ] Terramechanics.
- [ ] Better rocks.
- [ ] Improved MDL textures for large scale environments.

## Contacts

Antoine Richard: [email protected]
Louis Burtz:

1 change: 1 addition & 0 deletions wiki/contribute/_Footer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Antoine Richard -- University of Luxembourg -- Space Robotics Group -- 2023-24
4 changes: 4 additions & 0 deletions wiki/contribute/_Sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## Table of Contents
- [Previous (Rendering Configuration)](../rendering/Rendering.md)
- [Nest (FAQ)](../FAQ/FAQ.md)
- [Back to Home](../Home)
82 changes: 0 additions & 82 deletions wiki/deformation_engine.md

This file was deleted.

Loading

0 comments on commit 461cb59

Please sign in to comment.