Commit b9a2613d authored by strakpe's avatar strakpe

doc update

parent 1457fee7
......@@ -12,8 +12,11 @@ This add-on has been developed at [IT4Innovations National Supercomputing Center
1. [Supported technologies](https://code.it4i.cz/raas/cyclesphi#supported-technologies)
2. [CyclesPhi working principle](https://code.it4i.cz/raas/cyclesphi#cyclesphi-working-principle)
4. [License](https://code.it4i.cz/raas/cyclesphi#license)
5. [Acknowledgement](https://code.it4i.cz/raas/cyclesphi#acknowledgement)
3. [Compatibility](https://code.it4i.cz/raas/cyclesphi#compatibility)
4. [Building process](https://code.it4i.cz/raas/cyclesphi#building-process)
5. [Running CyclesPhi example](https://code.it4i.cz/raas/cyclesphi#running-cyclesphi-example)
6. [License](https://code.it4i.cz/raas/cyclesphi#license)
7. [Acknowledgement](https://code.it4i.cz/raas/cyclesphi#acknowledgement)
---
# Supported technologies
......@@ -44,19 +47,20 @@ Overview of working principle is depicted in pictures below.
---
Although CyclesPhi is compatible only with modified version of Blender 2.8, scenes from standard Blender 2.8 are of course supported.
Modification of Blender is necessery to sufficiently support MPI technology on cluster.
Build of modified Blender version is part of CyclesPhi building procedure.
Modification of Blender is necessary for sufficien support of MPI technology on an HPC cluster.
The build of modified Blender version is part of CyclesPhi building procedure provided below.
---
# Building and running CyclesPhi
# Building process
---
For running CyclesPhi and modified version of Blender on HPC cluster it is necessary to prepare Singularity image with Debian OS first.
To build and run CyclesPhi and modified version of Blender on Salomon cluster it is first necessary to prepare Singularity image with Debian OS.
Simple description about how to do it is provided below.
### Creating Singularity image with Debian (under Ubuntu 18.04)
Singularity image with Debian OS is prepared on local computer.
Here it is described, how to prepare it under Ubuntu 18.04.
Singularity image with Debian OS is prepared on a local computer.
Here it is described, how to do it under Ubuntu 18.04.
```
sudo apt-get update
......@@ -84,14 +88,17 @@ scp debian_blender.img salomon.it4i.cz:~/.
### Building CyclesPhi and modified Blender version on HPC Cluster
Supplied shell script downloads source codes from git repository and builds CyclesPhi and Blender into selected directory on HPC cluster.
Supplied shell script downloads the source codes from git repository and builds CyclesPhi and Blender into selected directory on HPC cluster.
First, the CyclesPhi is built then Blender is built.
The script builds two versions of CyclesPhi.
One for CPU rendering and the other one for rendering on MIC accelerators.
To successfully compile both versions of CyclesPhi it is necessary to allocate accelerated node that consists of CPU and MIC alltogether.
One is for CPU rendering and the other one for rendering on MIC accelerators.
To successfully compile both versions of CyclesPhi it is necessary to allocate accelerated node that consists of CPU and MIC.
Second, the modified version of Blender is built.
To successfully build it on cluster Singularity image is required.
All process is automatically handled by supplied shell script.
The whole process is automatically handled by supplied shell script.
```
ssh salomon.it4i.cz
......@@ -108,13 +115,13 @@ exit
```
---
# Running CyclesPhi - example
# Running CyclesPhi example
---
After building CyclesPhi and Blender it is possible to run the rendering task either on CPU nodes or MIC nodes.
Descriptions is provided below.
To supply your own Blender scene to render you have to modify the script **run_blender_pre.sh**.
If you choose either of two rendering possibilities (CPU, MIC), you can specify how many resources to use in section **select=**, meaning the number of devices in case of MIC or number of nodes in case of CPU.
After building CyclesPhi and Blender it is possible to run the rendering task either on CPU or MIC nodes.
Description for both types is provided below.
To supply your own Blender scene for rendering you have to modify the script *run_blender_pre.sh*.
You can specify how many resources to use in section *select=*, meaning the number of devices in case of MIC or number of nodes in case of CPU.
### Running on MICs
......@@ -135,7 +142,8 @@ echo $pre '->' $rend '->' $post
```
### Result
After running the previously described CyclesPhi application, either on MIC or CPU, you can find the rendered example in folder **~/project-cyclesphi/data/**.
After running the example, you can find the rendering results in folder *~/project-cyclesphi/data/*.
Example contains a car demo - The popular BMW scene by Mike Pan (CC0), see below.
![](https://code.it4i.cz/raas/cyclesphi/raw/master/client/data/bmw27.png)
......@@ -144,12 +152,10 @@ Example contains a car demo - The popular BMW scene by Mike Pan (CC0), see below
---
# License
---
This software is licensed under the terms of the [GNU General Public License](https://code.it4i.cz/raas/cyclesphi/blob/master/COPYING).
---
# Acknowledgement
---
This work was supported by The Ministry of Education, Youth and Sports from the Large Infrastructures for Research, Experimental Development and Innovations project ”IT4Innovations National Supercomputing Center – LM2015070”.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment