You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Readme.md
+58-51
Original file line number
Diff line number
Diff line change
@@ -23,61 +23,68 @@ The figure below visualizes the basic concept of **blendtorch** used in the cont
23
23
1. To get started with **blendtorch** for training data training read [\[examples/datagen\]](examples/datagen).
24
24
1. To learn about using **blendtorch** for creating reinforcement training environments read [\[examples/control\]](examples/control).
25
25
26
-
## Installation
27
-
28
-
**blendtorch** is composed of two distinct sub-packages: `bendtorch.btt` (in [pkg_pytorch](./pkg_pytorch)) and `blendtorch.btb` (in [pkg_blender](./pkg_blender)), providing the PyTorch and Blender views on **blendtorch**.
Ensure Blender executable is in your environments lookup `PATH`. On Windows this can be accomplished by
45
-
```
46
-
set PATH=c:\Program Files\Blender Foundation\Blender 2.91;%PATH%
47
-
```
48
-
49
-
On Ubuntu when blender is [installed using snap](https://snapcraft.io/install/blender/ubuntu), the path may be included by adding the following line to your ~/.bashrc,
running Windows 10 and Linux. Other versions might work as well, but have not been tested.
54
32
55
-
### Complete Blender settings
56
-
Open Blender at least once, and complete the initial settings. If this step is missed, some of the tests (especially the tests relating RL) will fail (Blender 2.91).
installs `blendtorch-btb` into the Python environment bundled with Blender.
63
-
64
-
### Install **blendtorch** PyTorch part
65
-
```
66
-
pip install -e <DST>/pkg_pytorch
67
-
```
68
-
installs `blendtorch-btt` into the Python environment that you intend to run PyTorch from. While not required, it is advised to install OpenAI gym if you intend to use **blendtorch** for reinforcement learning
69
-
```
70
-
pip install gym
71
-
```
72
-
73
-
### Developer instructions
74
-
This step is optional. If you plan to run the unit tests
75
-
```
76
-
pip install -r requirements_dev.txt
77
-
pytest tests/
78
-
```
33
+
## Installation
79
34
80
-
### Troubleshooting
35
+
**blendtorch** is composed of two distinct sub-packages:
36
+
-`bendtorch.btt` located in [pkg_pytorch](./pkg_pytorch) and
37
+
-`blendtorch.btb` located in [pkg_blender](./pkg_blender),
38
+
39
+
providing the PyTorch and Blender views on **blendtorch**. `bendtorch.btt` will be installed to your local Python environment, while `blendtorch.btb` will be installed to the Python environment that ships with Blender.
Ensure Blender executable is in your environments lookup `PATH`. On Windows this can be accomplished by
49
+
```
50
+
set PATH=c:\Program Files\Blender Foundation\Blender 2.91;%PATH%
51
+
```
52
+
On Ubuntu when blender is [installed using snap](https://snapcraft.io/install/blender/ubuntu), the path may be included by adding the following line to your ~/.bashrc,
Open Blender at least once, and complete the initial settings. If this step is missed, some of the tests (especially the tests relating RL) will fail (Blender 2.91).
0 commit comments