Skip to content

Commit ebb83ec

Browse files
committed
Update installations and usage instructions in README
1 parent 516ce41 commit ebb83ec

1 file changed

Lines changed: 21 additions & 1 deletion

File tree

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,31 @@ A dashboard using bokeh sever, developed to display data from HMC surveys in an
88

99
## Installation
1010

11+
After downloading the git repository you can install the software either with pip or poetry.
12+
We recomment setting it up in a seperate pyhon virtual environment.
13+
14+
```shell
15+
pip install survey_dashboard
16+
```
17+
or
18+
19+
```shell
20+
poetry install .
21+
```
22+
1123

1224
## Usage
1325

26+
After installation you can start the app, i.e the panel server/bokeh server.
27+
```shell
28+
panel serve --port 50006 survey_dashboard/
29+
```
30+
If you have given the dashboard a specific layout like the layout specific to HMC, which is on the hmc_specific branch, you might have to
31+
```shell
32+
panel serve --port 50006 survey_dashboard/ --static-dirs en_files=./survey_dashboard/hmc_layout/static/en_files
33+
```
1434

15-
* Navigate to `http://localhost:8000/` in your browser.
35+
* Navigate to `http://localhost:50006/` in your browser.
1636

1737

1838
## Development

0 commit comments

Comments
 (0)