Skip to content

Commit a9747ae

Browse files
committed
updated readme
1 parent d354adc commit a9747ae

File tree

1 file changed

+58
-51
lines changed

1 file changed

+58
-51
lines changed

Readme.md

+58-51
Original file line numberDiff line numberDiff line change
@@ -23,61 +23,68 @@ The figure below visualizes the basic concept of **blendtorch** used in the cont
2323
1. To get started with **blendtorch** for training data training read [\[examples/datagen\]](examples/datagen).
2424
1. To learn about using **blendtorch** for creating reinforcement training environments read [\[examples/control\]](examples/control).
2525

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**.
29-
30-
### Prerequisites
26+
## Prerequisites
3127
This package has been tested with
32-
- [Blender](https://www.blender.org/) >= 2.83/2.91/3.0 (Python 3.7/3.9)
33-
- [PyTorch](http://pytorch.org) >= 1.5/1.10 (Python 3.7/3.8)
34-
running Windows 10 and Linux.
35-
36-
Other versions might work as well, but have not been tested.
37-
38-
### Clone this repository
39-
```
40-
git clone https://github.com/cheind/pytorch-blender.git <DST>
41-
```
28+
- [Blender](https://www.blender.org/) >= 2.83/2.91/3.0/3.1 (Python >= 3.7)
29+
- [PyTorch](http://pytorch.org) >= 1.5/1.10 (Python >= 3.7)
4230

43-
### Extend `PATH`
44-
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,
50-
51-
```
52-
export PATH=/snap/blender/current/${PATH:+:${PATH}}
53-
```
31+
running Windows 10 and Linux. Other versions might work as well, but have not been tested.
5432

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).
57-
58-
### Install **blendtorch** Blender part
59-
```
60-
blender --background --python <DST>/scripts/install_btb.py
61-
```
62-
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
7934

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.
40+
41+
1. Clone this repository
42+
43+
```
44+
git clone https://github.com/cheind/pytorch-blender.git <DST>
45+
```
46+
1. Extend `PATH`
47+
48+
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,
53+
```
54+
export PATH=/snap/blender/current/${PATH:+:${PATH}}
55+
```
56+
1. Complete Blender settings
57+
58+
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).
59+
1. Install `blendtorch.btb`
60+
61+
Run
62+
```
63+
blender --background --python <DST>/scripts/install_btb.py
64+
```
65+
to `blendtorch-btb` into the Python environment bundled with Blender.
66+
1. Install `blendtorch.btt`
67+
68+
Run
69+
```
70+
pip install -e <DST>/pkg_pytorch
71+
```
72+
installs `blendtorch-btt` into the Python environment that you intend to run PyTorch from.
73+
1. Install `gym` [optional]
74+
75+
While not required, it is advised to install OpenAI gym if you intend to use **blendtorch** for reinforcement learning
76+
```
77+
pip install gym
78+
```
79+
1. Install dev requirements [optional]
80+
81+
This step is optional. If you plan to run the unit tests
82+
```
83+
pip install -r requirements_dev.txt
84+
pytest tests/
85+
```
86+
87+
## Troubleshooting
8188
Run
8289
```
8390
blender --version

0 commit comments

Comments
 (0)