Commit 5feb314f authored by strakpe's avatar strakpe
Browse files

readme update

parent 6655c86e
......@@ -8,56 +8,15 @@ In this way, support for rendering on HPC cluster is provided.
---
# Content
---
1. [Add-on functionality](https://code.it4i.cz/raas/bheappe#add-on-functionality)
1. [Installation](https://code.it4i.cz/raas/bheappe#instalation)
2. [Compatibility](https://code.it4i.cz/raas/bheappe#compatibility)
3. [License](https://code.it4i.cz/raas/bheappe#license)
3. [Add-on functionality](https://code.it4i.cz/raas/bheappe#add-on-functionality)
4. [License](https://code.it4i.cz/raas/bheappe#license)
---
# Add-on functionality
---
Bheappe add-on is added to the *Render properties* menu of Blender. Add-on supports *Cycles* rendering only. Thus it is available only in case *Cycles* is selected as *Render Engine*, see figure below.
![](img/render_menu.png)
*BHeappe* menu is divided in *Status* menu and two other menues called *New Job* and *Jobs*.
See figure below.
***Status*** menu provides user with information about progress of ongoing action, e.g. sending query for job update etc.
***New Job*** menu lets user to define details about a rendering job that will be submitted.
You can set project name, specify the output image format, select type of the computing queue and choose whether only one image or sequence of images (animation) will be rendered.
![](img/bheappe_menu.png)
Within the *Queue* selection, *CPU/MIC/MPP* choices are available.
The *CPU* queue represents computation on just one CPU node of a cluster and it shall provide actual version of the Cycles renderer identical with the one from Blender.
This option is mainly for compatibility reasons.
The other two selections *MIC/MPP* allows user to perform multi node rendering on MIC accelerators or CPUs respectivelly.
Beside the mentioned options, there are the following settings to be specified by the user before the job can be submitted for computation:
- *Nodes* - number of allocated computational nodes for the job.
- *Walltime* - maximal processing time allocated for specific part of the whole rendering task such as *Preprocessing*, *Rendering*, *Postprocessing*.
- *Current Frame* or *Frame Start/End/Step* - depending whether one image or animation is being selected, user can choose a frame number or consecutive set of frames.
- *Resolution* - specific resolution in horizontal and vertical direction that can be selected.
- *%* - value representing percentage amount of selected resolution that will be used as a final rendering resolution.
- *Samples* - number of samples per pixel. Represents rendering quality of path-trace renderer. The higher the value the better quality is reached but also within a longer computational time.
After setting available values, rendering job is sent to the cluster by *Submit Job* button.
***Jobs*** menu provides user with the overview about the submitted jobs. Actual states of the jobs can be queued.
If some particular job from the list in the *Jobs* menu is selected and in FINISHED state, user can download the results to his/her local folder and browse them by opening a file explorer via button.
# Installation & authentication
---
# Compatibility
---
Add-on is compatible with Blender version 2.80 and higher. Older versions of Blender software are not supported.
Addo-on has been tested on Windows and MacOS platform.
---
# Instalation
---
For add-on installation you first need to have 2.80 or higher version of Blender.
Blender is a free and open-source software which can be downloaded at [https://www.blender.org](https://www.blender.org).
......@@ -98,11 +57,61 @@ $ ./pip install scp
After installing the necessary Python modules download the [bheappe.zip](https://code.it4i.cz/raas/bheappe/blob/master/bheappe.zip) file.
Open Blender and go to *Edit/Preferences*.
Click on *Add-ons* tab and from there hit the *Install* button.
Click on *Add-ons* tab and from there click the *Install* button.
It will open the file browser.
Locate the downloaded *bheappe.zip* file and click *Install Add-on* button.
Search for *bheappe* within the list of add-ons and check the tick mark at the add-on name.
Save the preferences at lower left corner of the Preferences window before you close it.
To be able to provide rendering on a supercomputer it is necessary to have a valid access.
This can be obtain within our service called Rendering-as-a-Service (RaaS).
For information about a service contact either petr.strakos
Requests will be solved individually.
Save the preferences at lower left corner of the *Preferences* window before you close it.
---
# Compatibility
---
Add-on is compatible with Blender version 2.80 and higher. Older versions of Blender software are not supported.
Addo-on has been tested on Windows and MacOS platform.
---
# Add-on functionality
---
Bheappe add-on is added to the *Render properties* menu of Blender. Add-on supports *Cycles* rendering only. Thus it is available only in case *Cycles* is selected as *Render Engine*, see figure below.
![](img/render_menu.png)
*BHeappe* menu is divided in *Status* menu and two other menues called *New Job* and *Jobs*.
See figure below.
***Status*** menu provides user with information about progress of ongoing action, e.g. sending query for job update etc.
***New Job*** menu lets user to define details about a rendering job that will be submitted.
You can set project name, specify the output image format, select type of the computing queue and choose whether only one image or sequence of images (animation) will be rendered.
![](img/bheappe_menu.png)
Within the *Queue* selection, *CPU/MIC/MPP* choices are available.
The *CPU* queue represents computation on just one CPU node of a cluster and it shall provide actual version of the Cycles renderer identical with the one from Blender.
This option is mainly for compatibility reasons.
The other two selections *MIC/MPP* allows user to perform multi node rendering on MIC accelerators or CPUs respectivelly.
Beside the mentioned options, there are the following settings to be specified by the user before the job can be submitted for computation:
- *Nodes* - number of allocated computational nodes for the job.
- *Walltime* - maximal processing time allocated for specific part of the whole rendering task such as *Preprocessing*, *Rendering*, *Postprocessing*.
- *Current Frame* or *Frame Start/End/Step* - depending whether one image or animation is being selected, user can choose a frame number or consecutive set of frames.
- *Resolution* - specific resolution in horizontal and vertical direction that can be selected.
- *%* - value representing percentage amount of selected resolution that will be used as a final rendering resolution.
- *Samples* - number of samples per pixel. Represents rendering quality of path-trace renderer. The higher the value the better quality is reached but also within a longer computational time.
After setting available values, rendering job is sent to the cluster by *Submit Job* button.
***Jobs*** menu provides user with the overview about the submitted jobs. Actual states of the jobs can be queued.
If some particular job from the list in the *Jobs* menu is selected and in FINISHED state, user can download the results to his/her local folder and browse them by opening a file explorer via button.
### External Dependencies
......
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