Skip to content

Commit 8b45601

Browse files
authored
Update README.md
1 parent 1f14a48 commit 8b45601

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
11
# fibirr-GUI
2+
**February 25<sup>th</sup>, 2026**
3+
24
GUI for fibirr setup based on AvaSpec library
35

46
## Installation
57
Python 3.12 or higher is required
68

79
### Conda
810
The Anaconda Powershell Prompt is a good tool.
9-
#### Create a new Python environment and install pip
11+
#### 1) Create a new Python environment and install pip
1012
```bash
1113
(base) conda create -n fibirr-GUI
1214
(base) conda activate fibirr-GUI
1315
(fibirr-GUI) conda install pip
1416
```
1517

16-
#### Download the source files
18+
#### 2) Download the source files
1719
##### Clone using URL at desired location (for example, Desktop):
1820
```bash
1921
(fibirr-GUI) conda install git
@@ -22,22 +24,26 @@ The Anaconda Powershell Prompt is a good tool.
2224
```
2325
A folder called "fibirr-GUI" is downloaded.
2426

25-
#### Add AvaSpec library
27+
#### 3) Add AvaSpec library
28+
- Inside `fibirr-GUI` directory, create a directory called `avantes`
29+
- Place DLL inside `avantes` directory (e.g., avaspecx64.dll)
2630

27-
#### Install
31+
#### 4) Install
2832
```bash
2933
(fibirr-GUI) \Desktop> cd fibirr-GUI
3034
(fibirr-GUI) \Desktop\fibirr-GUI> pip install -e .
3135
```
3236

3337
## Run
3438
Make sure to activate the environment, and then call the .pyw file using Python:
35-
(working on command-line script)
39+
3640
```
3741
(base) conda activate fibirr-GUI
3842
(fibirr-GUI) \Desktop\fibirr-GUI> python GUI.pyw
3943
```
4044
The GUI should appear after a short while.
4145

46+
(*command-line script coming soon*)
47+
4248
### Configuration
4349
The user can adjust the desired default settings in the `settings.py` file that is located in the folder `user`.

0 commit comments

Comments
 (0)