Skip to content

Commit 9687a26

Browse files
committed
update README
1 parent fe1d87f commit 9687a26

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

autotune/README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,28 @@
11
# Installation using a virtual environment
2-
## Create a new venv
2+
3+
## Using Poetry (recommended)
4+
### Create a new environment and install the dependencies
5+
1. Get [poetry](https://python-poetry.org/docs/): `curl -sSL https://install.python-poetry.org | python3 -`
6+
2. In this directory, simply run `poetry install`
7+
8+
### Start the GUI
9+
```
10+
poetry run python3 autotune.py
11+
```
12+
13+
## Using venv
14+
### Create a new environment
315
```
416
python3.9 -m venv virtualenv-test
517
source virtualenv-test/bin/activate
618
```
719

8-
## Install the dependencies
20+
### Install the dependencies
921
```
10-
pip3 install scipy pyulog control pyqt5
22+
pip3 install numpy scipy pyulog control pyqt5
1123
```
1224

13-
## Start the GUI
25+
### Start the GUI
1426
```
1527
python3 autotune.py
1628
```

0 commit comments

Comments
 (0)