Skip to content

Commit 0fd6ff5

Browse files
authored
Update README
Include some screenshots
1 parent 038d878 commit 0fd6ff5

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,20 @@ A dashboard to display survey data in an interactive way.
44

55
## Overview
66

7-
A dashboard using bokeh sever, developed to display data from HMC surveys in an interactive explorer way.
7+
This repository contains a dashboard using Panel and Bokeh, developed to display data from
8+
HMC surveys in an interactive exploratory way. It is designed such that the code for the interactive
9+
visualizations might be reused for other projects.
10+
Example of a deployed version can be found [here](https://dashboard.survey.helmholtz-metadaten.de/survey_dashboard)
11+
12+
Some impressions:
13+
![dashboard_overview](https://user-images.githubusercontent.com/24694833/230306080-9ca68ff8-5b8b-4ac4-b2fa-51e2c5361c7d.png)
14+
![dashboard_methods](https://user-images.githubusercontent.com/24694833/230306091-637188a9-359e-4ea0-8432-4d05a1ccc68f.png)
15+
![Dashboard_survey_data_explorer](https://user-images.githubusercontent.com/24694833/230306099-4cf71bda-0990-4f9d-be14-9a65812e7ac4.png)
816

917
## Installation
1018

1119
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.
20+
We recommend setting it up in a separate python virtual environment.
1321

1422
```shell
1523
pip install survey_dashboard
@@ -20,26 +28,27 @@ or
2028
poetry install .
2129
```
2230

23-
2431
## Usage
2532

2633
After installation you can start the app, i.e the panel server/bokeh server.
2734
```shell
2835
panel serve --port 50006 survey_dashboard/
2936
```
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
37+
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 link to to a specific template.
3138
```shell
3239
panel serve --port 50006 survey_dashboard/ --static-dirs en_files=./survey_dashboard/hmc_layout/static/en_files
3340
```
3441

3542
* Navigate to `http://localhost:50006/` in your browser.
3643

3744

38-
## Development
45+
## Deployment
3946

4047
To embed the dashboard into any website, first you have to host a bokeh server with this application somewhere and then you can embed it with bokehs `sever_document` function [see](https://docs.bokeh.org/en/latest/docs/user_guide/embed.html#app-documents)
4148

42-
Do steps under `usage` above, but for a public exposed URL.
49+
Do steps under `usage` above, but for a public exposed URL, or what ever is used for deployment.
50+
The Language verison of the dashboard can be set with the environment variable: 'L
51+
4352

4453
Add the code from 'script' to you website:
4554

0 commit comments

Comments
 (0)