Skip to content

Commit 5500b8c

Browse files
committed
Add local app launcher script
1 parent 4811801 commit 5500b8c

2 files changed

Lines changed: 58 additions & 1 deletion

File tree

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,22 @@ It showcases:
4242
- CSV, JSON, HTML, and Markdown exports
4343
- Local output saving under `Computations/Results`
4444

45+
## Screenshots
46+
47+
> Screenshots will be added as the interface matures.
48+
49+
### Project overview
50+
51+
![Project overview](CodeDocumentations/images/project_overview.png)
52+
53+
### File index
54+
55+
![File index](CodeDocumentations/images/file_index.png)
56+
57+
### Reproducibility report
58+
59+
![Reproducibility report](CodeDocumentations/images/reproducibility_report.png)
60+
4561
## Project structure
4662

4763
```text
@@ -60,4 +76,13 @@ FSS-Navigator-App/
6076
├── logs/
6177
├── environment.yml
6278
├── requirements.txt
63-
└── README.md
79+
└── README.md
80+
```
81+
82+
## Run the app
83+
84+
Recommended:
85+
86+
```bash
87+
python run_app.py
88+
```

run_app.py

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
"""
2+
Launcher for FSS Navigator App.
3+
4+
Run with:
5+
6+
python run_app.py
7+
"""
8+
9+
import subprocess
10+
import sys
11+
from pathlib import Path
12+
13+
14+
APP_PATH = Path("Computations/Code/app/app.py")
15+
16+
17+
def main() -> None:
18+
"""
19+
Launch the local Streamlit app.
20+
"""
21+
22+
if not APP_PATH.exists():
23+
raise FileNotFoundError(f"Could not find app file: {APP_PATH}")
24+
25+
subprocess.run(
26+
[sys.executable, "-m", "streamlit", "run", str(APP_PATH)],
27+
check=True,
28+
)
29+
30+
31+
if __name__ == "__main__":
32+
main()

0 commit comments

Comments
 (0)