blob: 7722cffc6f7dc31afe014713b346ad460f7376a5 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
An open-source python toolkit to deal with gaze tracking and analysis in Augmented Reality (AR) environnement.
## Architecture
The ArGaze toolkit is divided in submodules dedicated to various purposes:
* ArUcoMarkers: ArUco markers generator, traking, camera calibration, ...
* RegionOfInterest: Region Of Interest (ROI) scene management for 2D and 3D environment.
* TobiiGlassesPro2: A gaze tracking device interface.
* utils: Collection of command-line high level features scripts based on ArGaze toolkit.
## Installation
Consider that all inline commands below needs to be executed into ArGaze root folder.
- Build package:
```
python -m build
```
- Then, install package (replace VERSION by what has been built into dist folder):
```
pip install ./dist/argaze-VERSION.whl
```
As Argaze library developper, you should prefer to install the package in developer mode to test live code changes:
```
pip install -e .
```
## Documentation
To generate html documentation using [pdoc](https://pdoc.dev/),
- Install 'pdoc' package:
```
pip install pdoc
```
- Then, build documentation into doc folder:
```
pdoc -o ./doc ./src/argaze/
```
As Argaze library developper, you should prefer to create a local html server to watch live documentation changes:
```
pdoc ./src/argaze/
```
|
