Skip to content

Commit 58d20e9

Browse files
committed
added conda instructions for mkdocs. updated installation instructions for OptiX headers from github
1 parent 398f538 commit 58d20e9

File tree

4 files changed

+45
-16
lines changed

4 files changed

+45
-16
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,29 @@ These docs are built with [MkDocs](https://mkdocs.org) and published to [uos.git
44

55
## Build locally
66

7-
```
7+
```console
88
sudo apt install python3-pip
99
pip3 install "mkdocs>=1.6" mkdocs-material
1010
```
1111

1212
*Note: you may need to adapt your path `export PATH=$PATH:/home/<USER>/.local/bin` to access mkdocs binary*
1313

14+
## Using Anaconda
15+
16+
After downloading go into the folder of this repository.
17+
18+
```console
19+
conda env create -f environment.yml
20+
```
21+
22+
Will create an conda environment named "rmagine_docs". Enable it by calling
23+
24+
```console
25+
conda activate rmagine_docs
26+
```
27+
28+
29+
1430
### Build Static Files
1531

1632
```
@@ -40,4 +56,4 @@ How to contribute to this documentation via pull requests:
4056
3. Check locally on your machine if mkdocs is able to compile your changes ([instructions](https://github.com/uos/rmagine_docs)).
4157
3. Go to Github and click "Pull Request", select this repository's "main" branch as target.
4258
4. If you added new content, please provide a brief explanation of why you believe it is beneficial for the documentation.
43-
5. Send PR.
59+
5. Send PR.

docs/extra/news.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# News
22

3+
## 12.09.2024
4+
5+
Alongside the new version 2.2.6 we released a minimal viewer that demonstrates the sensor models of rmagine. Check it out here: https://github.com/amock/rmagine_viewer.
6+
37
## 05.12.2023
48

59
New version 2.2.2 is available now and brings convenience updates for ROS-users. Just place Rmagine into your ROS-workspace and it will compile. Via `find_package(rmagine COMPONENTS [...])` you can still find Rmagine's components as if you would install it globally on your system. We tested it with
@@ -19,20 +23,20 @@ Especially if you place Rmagine into your ROS-workspace this option becomes very
1923
From version >= 2.2.0 we enabled component-wise compilation and packaging for easier installation of Rmagine. In "Releases" section you can find the first pre-compiled binaries. Install the core library via
2024

2125
```console
22-
$ sudo dpkg -i rmagine-core_2.2.1_amd64.deb
26+
sudo dpkg -i rmagine-core_2.2.1_amd64.deb
2327
```
2428

2529
Then additionally for the Embree backend:
2630

2731
```console
28-
$ sudo dpkg -i rmagine-embree_2.2.1_amd64.deb
32+
sudo dpkg -i rmagine-embree_2.2.1_amd64.deb
2933
```
3034

3135
And if you have a NVIDIA GPU:
3236

33-
```
34-
$ sudo dpkg -i rmagine-cuda_2.2.1_amd64.deb
35-
$ sudo dpkg -i rmagine-optix_2.2.1_amd64.deb
37+
```console
38+
sudo dpkg -i rmagine-cuda_2.2.1_amd64.deb
39+
sudo dpkg -i rmagine-optix_2.2.1_amd64.deb
3640
```
3741

3842
Using the pre-compiled binaries, you are not required to download the OptiX-headers anymore. However, CUDA and Embree are still required to be installed on your system.

docs/installation.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ For older Embree versions we refer to [this](/extra/embree3.md).
3434

3535
### OptiX Backbone (optional)
3636

37-
Rmagine supports NVIDIA OptiX versions of 7.2 or newer (experimental support for OptiX 8).
37+
Rmagine supports NVIDIA OptiX versions of 7.2 or newer (experimental support for OptiX 8+).
3838
The OptiX-Library is installed via the GPU driver.
39-
The OptiX-Headers can be downloaded [here](https://developer.nvidia.com/designworks/optix/download).
39+
The OptiX-Headers can be downloaded from [GitHub](https://github.com/NVIDIA/optix-dev).
4040
The Headers require a specific GPU driver and CUDA version to be installed on your system:
4141

4242
| OptiX Version | Minimum Driver Version |
@@ -48,6 +48,10 @@ The Headers require a specific GPU driver and CUDA version to be installed on yo
4848
| 7.6 | 520.00 (untested) |
4949
| 7.7 | 530.41 |
5050

51+
!!! note
52+
53+
Check NVIDIA docs for newer versions.
54+
5155
## Compilation
5256

5357
Download the Rmagine repository.
@@ -59,7 +63,7 @@ user@pc:~/rmagine/build$ cmake ..
5963
user@pc:~/rmagine/build$ make
6064
```
6165

62-
The path to OptiX-Headers should be specified with the CMake-Variable `OptiX_INCLUDE_DIR`. This can be done using ccmake, for example.
66+
The path to OptiX-Headers should be specified with the CMake-Variable `OptiX_INCLUDE_DIR`. This can be done using `ccmake`, for example.
6367

6468
### Bash Variable (Alternative)
6569

@@ -132,31 +136,31 @@ We are working on creating debian packages for easier installations.
132136
## Dependencies
133137

134138
```console
135-
$ sudo apt install libassimp-dev libeigen3-dev
139+
sudo apt install libassimp-dev libeigen3-dev
136140
```
137141

138142
## Install
139-
Download latest Rmagine debian packages from Github releases page (v2.2.2). Install the core by calling
143+
Download latest Rmagine debian packages from Github releases page (v2.3.0). Install the core by calling
140144

141145
```console
142-
sudo apt install ./rmagine-core_2.2.2_amd64.deb
146+
sudo apt install ./rmagine-core_2.3.0_amd64.deb
143147
```
144148

145149
### Embree Backbone
146150

147151
We support Embree in its latest version (tested: v4.0.1 - v4.3.0). Make sure you have Embree installed on your system.
148152

149153
```console
150-
sudo apt install ./rmagine-embree_2.2.2_amd64.deb
154+
sudo apt install ./rmagine-embree_2.3.0_amd64.deb
151155
```
152156

153157
### OptiX Backbone
154158

155159
Make sure you have a current NVIDIA driver installed, then install rmagine-cuda and rmagine-optix by:
156160

157161
```console
158-
sudo apt install ./rmagine-cuda_2.2.2_amd64.deb
159-
sudo apt install ./rmagine-optix_2.2.2_amd64.deb
162+
sudo apt install ./rmagine-cuda_2.3.0_amd64.deb
163+
sudo apt install ./rmagine-optix_2.3.0_amd64.deb
160164
```
161165

162166
## Uninstall

environment.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
name: rmagine_docs
2+
dependencies:
3+
- python=3.12
4+
- mkdocs>=1.6
5+
- mkdocs-material

0 commit comments

Comments
 (0)