Skip to content

Commit 047b10b

Browse files
Merge pull request #64 from renderbus/1_add_rayvision_api
feat: update installation guide
2 parents 6088029 + 975aa3c commit 047b10b

File tree

1 file changed

+45
-19
lines changed

1 file changed

+45
-19
lines changed

render/installation_guide.rst

Lines changed: 45 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,66 @@
11
.. important::
2-
Make sure local Python environment and PIP are available before use.
2+
Make sure local Python environment and PIP are available before use,
3+
Complete use analysis, upload, download automation process, in addition to the analysis package of the rendered software, you also need to install:
4+
`rayvision_api`, `rayvision_log`, `rayvision_utils`, `rayvision_sync`.
35

46

57
Installation Guide
68
====================
79

8-
**Method One (recommended):**
10+
1. Software analysis packages
11+
-------------------------------
912

10-
.. note::
11-
Users who have limited access to the Python official address network
12-
can download and install from our custom server。
13+
SDK Maya:
14+
- rayvision_maya
1315

14-
- Download from Python official pypi (recommended)
16+
SDK Houdini:
17+
- rayvision_houdini
1518

16-
``pip install rayvision_maya``
19+
SDK Clarisse:
20+
- rayvision_clarisse
1721

18-
``pip install rayvision_clarisse``
22+
SDK 3ds Max:
23+
- rayvision_max
1924

20-
``pip install rayvision_houdini``
25+
SDK Katana
26+
- rayvision_katana
2127

22-
- Install from a custom PIP server
28+
SDK C4D
29+
- rayvision_c4d
2330

24-
Before using specific rendering modules, such as Houdini rendering,
25-
please refer to the following installation method to install the modules in turn
26-
`rayvision_log`, `rayvision_api` , `rayvision_utils` , `rayvision_sync`,
31+
SDK Blender
32+
- rayvision_blender
2733

28-
**Method Two:**
34+
2. other model packages
35+
------------------------
36+
37+
upload/download package:
38+
- rayvision_sync
39+
40+
log package:
41+
- rayvision_log
42+
43+
interface/check package:
44+
- rayvision_api
45+
46+
common method package:
47+
- rayvision_utils
2948

30-
Download source code directly from GitHub:
3149

32-
``git clone https://github.com/foxrenderfarm/rayvision_log.git``
50+
3. Installation
51+
------------------
52+
53+
**Method One (recommended):**
54+
55+
- Download from Python official pypi (example for maya)
56+
57+
``pip install rayvision_maya``
58+
59+
**Method Two:**
3360

34-
``git clone https://github.com/foxrenderfarm/rayvision_api.git``
61+
Download source code directly from GitHub(example for maya):
3562

36-
``git clone https://github.com/foxrenderfarm/rayvision_utils.git``
63+
``git clone https://github.com/foxrenderfarm/rayvision_maya.git``
3764

38-
``git clone https://github.com/foxrenderfarm/rayvision_sync.git``
3965

4066
*other modules are installed similarly to the secondary installation method*

0 commit comments

Comments
 (0)