updated readme files (#54)
[platform/upstream/dldt.git] / inference-engine / ie_bridges / python / README.md
1 ## Software Requirements
2 - [CMake\*](https://cmake.org/download/) 3.9 or later
3 - Microsoft\* Visual Studio 2015 or later on Windows\*
4 - gcc 4.8 or later on Linux
5 - Python 2.7 or higher on Linux\*
6 - Python 3.4 or higher on Windows\*
7
8 ## Prerequisites
9
10 Install the following Python modules:
11 - opencv-python
12 - numpy
13 - cython
14
15 ## Building on Windows
16 ```shellscript
17         mkdir build
18         cd build
19         set PATH=C:\Program Files\Python36\Scripts;%PATH%
20         cmake -G "Visual Studio 14 2015 Win64" -DInferenceEngine_DIR=..\..\..\build ^
21                 -DPYTHON_EXECUTABLE="C:\Program Files\Python36\python.exe" ^
22                 -DPYTHON_INCLUDE_DIR="C:\Program Files\Python36\include" ^
23                 -DPYTHON_LIBRARY="C:\Program Files\Python36\libs\python36.lib" ..
24 ```
25
26 Then build generated solution INFERENCE_ENGINE_DRIVER.sln using Microsoft\* Visual Studio.
27
28 ## Building on Linux
29
30 ```shellscript
31   mkdir -p build
32   cd build
33   cmake -DInferenceEngine_DIR=`realpath ../../../build` -DPYTHON_EXECUTABLE=`which python3.6` \
34         -DPYTHON_LIBRARY=/usr/lib/x86_64-linux-gnu/libpython3.6m.so \
35         -DPYTHON_INCLUDE_DIR=/usr/include/python3.6 ..
36   make -j16
37 ```
38
39 Note: `-DInferenceEngine_DIR` parameter is needed to specify the folder with generated make files or Visual Studio solution used to build Inference Engine (see readme file in the inference-engine root folder).
40
41 Before running the Python samples, please manually replicate OpenVINO folders structure with Python modules:
42 - create an empty folder `openvino/inference_engine`
43 - move built `ie_api.so` and `__init__.py` files from the `<build_folder>/inference_engine` to `openvino/inference_engine` folder
44 - create an empty `__init__.py` file in the `openvino` folder
45 - add the root folder where `openvino` folder is located to the PYTHONPATH environment variable.
46 - add the folder with Inference Engine libraries to LD_LIBRARY_PATH variable on Linux (or PATH on Windows).