Spaces:
Running
Running
nahue-passano
commited on
Commit
·
6fce70c
1
Parent(s):
f7fb447
update: readme.md
Browse files
README.md
CHANGED
@@ -1,62 +1,9 @@
|
|
1 |
-
|
2 |
-
|
3 |
-
|
4 |
-
|
5 |
-
|
6 |
-
|
7 |
-
|
8 |
-
|
9 |
-
|
10 |
-
|
11 |
-
|
12 |
-
<img src="docs/images/aira-gui.png" alt="AIRA gui" style="display: block; margin: 0 auto; width:800px"/>
|
13 |
-
|
14 |
-
|
15 |
-
|
16 |
-
---
|
17 |
-
## 🆕 **Demo running**
|
18 |
-
1. Download the repository
|
19 |
-
```bash
|
20 |
-
git clone https://github.com/nahue-passano/AIRA.git
|
21 |
-
cd AIRA
|
22 |
-
```
|
23 |
-
|
24 |
-
2. Create and initialize [poetry](https://python-poetry.org/) environment
|
25 |
-
```bash
|
26 |
-
poetry install
|
27 |
-
poetry shell
|
28 |
-
```
|
29 |
-
|
30 |
-
3. Run the GUI file
|
31 |
-
```bash
|
32 |
-
python3 aira/gui.py
|
33 |
-
```
|
34 |
-
|
35 |
-
> **Usage note:** In case you do not have your own measurements, import test measurements from `test/mock_data/regio_theater`
|
36 |
-
|
37 |
-
---
|
38 |
-
|
39 |
-
## 🌱 **Getting started (develop)**
|
40 |
-
|
41 |
-
1. Download the repository
|
42 |
-
```bash
|
43 |
-
git clone https://github.com/nahue-passano/AIRA.git
|
44 |
-
cd AIRA
|
45 |
-
```
|
46 |
-
|
47 |
-
2. Create and initialize [poetry](https://python-poetry.org/) environment
|
48 |
-
```bash
|
49 |
-
poetry install
|
50 |
-
poetry shell
|
51 |
-
```
|
52 |
-
|
53 |
-
> **Note**: If the environment already exists, run `poetry update` for possible changes in `pyproject.toml`.
|
54 |
-
|
55 |
-
3. Install the pre-commit hooks for code formating and linting with `black` and `pylint`.
|
56 |
-
```bash
|
57 |
-
pre-commit install
|
58 |
-
```
|
59 |
-
|
60 |
-
> **Note**: If the changes to be commited are reformated, `black` will cancel the commit. You must add again the changes with `git add` and commit again
|
61 |
-
|
62 |
-
---
|
|
|
1 |
+
title: AIRA
|
2 |
+
emoji: 🦔
|
3 |
+
colorFrom: indigo
|
4 |
+
colorTo: gray
|
5 |
+
sdk: streamlit
|
6 |
+
sdk_version: 1.21.0
|
7 |
+
app_file: app.py
|
8 |
+
pinned: false
|
9 |
+
license: gpl-2.0
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|