docs/installation.md


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

---
title: Package installation
---

How to install ArGaze
=====================

!!! warning

    *ArGaze is a public read-only git repository: [contact ArGaze teams](mailto:argaze-contact@recherche.enac.fr) for requests or patchs.*

Clone ArGaze repository:

```console
git clone https://gitpub.recherche.enac.fr/argaze
```

!!! note

    *Consider that all inline commands below have to be executed at the root of ArGaze package folder.*

Install build tool package:

```console
pip install build
```

Then, build ArGaze package:
```console
python -m build
```

Then, install ArGaze package (replace VERSION by what has been built into dist folder):
```console
pip install ./dist/argaze-VERSION.whl
```

!!! note "As ArGaze package contributor"

    *You should prefer to install the package in editable mode to test live code changes:*

    ```
    pip install --editable .
    ```