2023-09-25 22:39:20 +03:00
|
|
|
## Installation
|
|
|
|
|
2023-10-22 16:08:14 +03:00
|
|
|
1. Install `Python`
|
2023-09-25 22:39:20 +03:00
|
|
|
|
2023-10-22 16:08:14 +03:00
|
|
|
2. Install `python3-venv` by the following command: `apt install python3-venv`
|
2023-09-25 22:39:20 +03:00
|
|
|
|
2023-10-22 16:08:14 +03:00
|
|
|
3. Create and activate your virtual environment following the [instructions](https://docs.python.org/3/tutorial/venv.html)
|
|
|
|
|
|
|
|
4. Install the `requirements.txt` dependencies following the commands:
|
2023-09-27 10:00:37 +03:00
|
|
|
```
|
2023-09-25 22:39:20 +03:00
|
|
|
cd ./scada_system
|
2023-10-22 16:08:14 +03:00
|
|
|
pip3 install -r requirements.txt
|
2023-09-27 10:00:37 +03:00
|
|
|
```
|
|
|
|
|
2023-10-22 16:08:14 +03:00
|
|
|
5. Install the package in editable mode:
|
2023-09-27 10:00:37 +03:00
|
|
|
```
|
2023-10-22 16:08:14 +03:00
|
|
|
pip3 install -e .
|
2023-09-27 10:00:37 +03:00
|
|
|
```
|
2023-09-25 22:39:20 +03:00
|
|
|
|
2023-10-22 16:08:14 +03:00
|
|
|
6. To generate documentation in HTML format, you need to run the following commands:
|
2023-09-27 10:00:37 +03:00
|
|
|
```
|
2023-09-25 22:39:20 +03:00
|
|
|
cd ./docs
|
|
|
|
make html
|
2023-09-27 10:00:37 +03:00
|
|
|
```
|