Skip to content

Commit ac7372d

Browse files
committed
added newer version to conda install
1 parent 58d20e9 commit ac7372d

File tree

4 files changed

+35
-33
lines changed

4 files changed

+35
-33
lines changed

README.md

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

55
## Build locally
66

7-
```console
7+
```bash
88
sudo apt install python3-pip
99
pip3 install "mkdocs>=1.6" mkdocs-material
1010
```
@@ -15,18 +15,16 @@ pip3 install "mkdocs>=1.6" mkdocs-material
1515

1616
After downloading go into the folder of this repository.
1717

18-
```console
18+
```bash
1919
conda env create -f environment.yml
2020
```
2121

2222
Will create an conda environment named "rmagine_docs". Enable it by calling
2323

24-
```console
24+
```bash
2525
conda activate rmagine_docs
2626
```
2727

28-
29-
3028
### Build Static Files
3129

3230
```

docs/installation.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ The following instructions are tested on an Ubuntu 20.04 operating system.
88

99
For loading commonly used mesh/scene formats.
1010

11-
```bash
12-
user@pc:~$ sudo apt install libassimp-dev
11+
```bash title="Terminal"
12+
sudo apt install libassimp-dev
1313
```
1414

1515
## Backbones
@@ -22,7 +22,7 @@ Rmagine provides an interface to integrate ray tracing libraries, we call backbo
2222

2323
We support Embree in its latest version (tested: v4.0.1, v4.2.0):
2424

25-
```bash
25+
```bash title="Terminal"
2626
user@pc:~$ git clone https://github.com/embree/embree.git
2727
user@pc:~$ mkdir embree/build && cd embree/build
2828
user@pc:~/embree/build$ cmake -DCMAKE_BUILD_TYPE=Release ..
@@ -56,7 +56,7 @@ The Headers require a specific GPU driver and CUDA version to be installed on yo
5656

5757
Download the Rmagine repository.
5858

59-
```bash
59+
```bash title="Terminal"
6060
user@pc:~/rmagine$ mkdir build
6161
user@pc:~/rmagine$ cd build
6262
user@pc:~/rmagine/build$ cmake ..
@@ -69,7 +69,7 @@ The path to OptiX-Headers should be specified with the CMake-Variable `OptiX_INC
6969

7070
Alternatively, cmake checks for the environment variable `OPTIX_INCLUDE_DIR` to exist. After downloading the OptiX-SDK you can add the following command to your `.bashrc`:
7171

72-
```bash
72+
```bash title="Terminal"
7373
export OPTIX_INCLUDE_DIR=~/.../NVIDIA-OptiX-SDK-7.4.0-linux64-x86_64/include
7474
```
7575

@@ -79,7 +79,7 @@ After adding this path, the project should compile without changing the cmake fl
7979

8080
You can check if everything went wrong by running the benchmark that was build besides the library:
8181

82-
```bash
82+
```bash title="Terminal"
8383
user@pc:~/rmagine/build$ ./bin/rmagine_benchmark_cpu ../dat/sphere.ply
8484
...
8585
[ 100% - velos/s: 6261.9, mean: 6244.84]
@@ -88,7 +88,7 @@ Result: 6244.84 velos/s
8888

8989
or if the OptiX support was successfully build:
9090

91-
```bash
91+
```bash title="Terminal"
9292
user@pc:~/rmagine/build$ ./bin/rmagine_benchmark_gpu ../dat/sphere.ply
9393
...
9494
[ 100% - velos/s: 383094, mean: 383457, rays/s: 5.52178e+09]
@@ -99,15 +99,15 @@ Result: 383457 velos/s
9999

100100
After compilation do
101101

102-
```bash
102+
```bash title="Terminal"
103103
user@pc:~/rmagine/build$ sudo make install
104104
```
105105

106106
### Optional: Check Installation
107107

108108
You can check if everything went wrong by running the benchmark that was build besides the library:
109109

110-
```bash
110+
```bash title="Terminal"
111111
user@pc:~$ rmagine_benchmark_cpu rmagine/dat/sphere.ply
112112
...
113113
[ 100% - velos/s: 6261.9, mean: 6244.84]
@@ -116,7 +116,7 @@ Result: 6244.84 velos/s
116116

117117
or if the OptiX support was successfully build:
118118

119-
```bash
119+
```bash title="Terminal"
120120
user@pc:~$ rmagine_benchmark_gpu rmagine/dat/sphere.ply
121121
...
122122
[ 100% - velos/s: 383094, mean: 383457, rays/s: 5.52178e+09]
@@ -125,7 +125,7 @@ Result: 383457 velos/s
125125

126126
## Uninstall Rmagine
127127

128-
```bash
128+
```bash title="Terminal"
129129
user@pc:~/rmagine/build$ sudo make uninstall
130130
```
131131

@@ -135,30 +135,30 @@ We are working on creating debian packages for easier installations.
135135

136136
## Dependencies
137137

138-
```console
138+
```bash title="Terminal"
139139
sudo apt install libassimp-dev libeigen3-dev
140140
```
141141

142142
## Install
143143
Download latest Rmagine debian packages from Github releases page (v2.3.0). Install the core by calling
144144

145-
```console
145+
```bash title="Terminal"
146146
sudo apt install ./rmagine-core_2.3.0_amd64.deb
147147
```
148148

149149
### Embree Backbone
150150

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

153-
```console
153+
```bash title="Terminal"
154154
sudo apt install ./rmagine-embree_2.3.0_amd64.deb
155155
```
156156

157157
### OptiX Backbone
158158

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

161-
```console
161+
```bash title="Terminal"
162162
sudo apt install ./rmagine-cuda_2.3.0_amd64.deb
163163
sudo apt install ./rmagine-optix_2.3.0_amd64.deb
164164
```
@@ -167,7 +167,7 @@ sudo apt install ./rmagine-optix_2.3.0_amd64.deb
167167

168168
To uninstall everything related to rmagine, call:
169169

170-
```console
170+
```bash title="Terminal"
171171
sudo apt-get remove rmagine-core
172172
```
173173

environment.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
name: rmagine_docs
22
dependencies:
33
- python=3.12
4-
- mkdocs>=1.6
5-
- mkdocs-material
4+
- pip
5+
6+
- pip:
7+
- mkdocs-material>=9.6
8+

mkdocs.yml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,17 @@ repo_url: https://github.com/uos/rmagine
66

77
docs_dir: docs
88
theme:
9-
name: material
10-
features:
11-
- navigation.instant
12-
- navigation.tabs
13-
- navigation.sections
14-
- navigation.footer
15-
logo: resources/img/rmagine_logo.png
16-
favicon: resources/img/rmagine_icon.png
17-
palette:
18-
primary: blue grey
9+
name: material
10+
features:
11+
- navigation.instant
12+
- navigation.tabs
13+
- navigation.sections
14+
- navigation.footer
15+
- content.code.copy
16+
logo: resources/img/rmagine_logo.png
17+
favicon: resources/img/rmagine_icon.png
18+
palette:
19+
primary: blue grey
1920

2021
markdown_extensions:
2122
- pymdownx.highlight

0 commit comments

Comments
 (0)