# Survey dashboard
A dashboard to display survey data in an interactive way.
## Overview
This repository contains a dashboard using Panel and Bokeh, developed to display data from
HMC surveys in an interactive exploratory way. It is designed such that the code for the interactive
visualizations might be reused for other projects.
Example of a deployed version can be found [here](https://dashboard.survey.helmholtz-metadaten.de/survey_dashboard)
Some impressions:
## Installation
After downloading the git repository you can install the software either with pip or poetry.
We recommend setting it up in a separate python virtual environment.
```shell
pip install survey_dashboard
```
or
```shell
poetry install .
```
## Usage
After installation you can start the app, i.e the panel server/bokeh server.
```shell
panel serve --port 50006 survey_dashboard/
```
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.
```shell
panel serve --port 50006 survey_dashboard/ --static-dirs en_files=./survey_dashboard/hmc_layout/static/en_files
```
* Navigate to `http://localhost:50006/` in your browser.
## Deployment
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)
Do steps under `usage` above, but for a public exposed URL, or what ever is used for deployment.
The Language verison of the dashboard can be set with the environment variable: 'L
Add the code from 'script' to you website:
```python
from bokeh.embed import server_document
script = server_document("url_to_running_server")
script
```
## Copyright and Licence
See [LICENSE](./LICENSE).
### Main used libraries and dependencies
The following libraries are used directly (i.e. not only transitively) in this project:
## Acknowledgements
<div>
<img style="vertical-align: middle;" alt="HMC Logo" src="https://github.com/Materials-Data-Science-and-Informatics/Logos/raw/main/HMC/HMC_Logo_M.png" width=50% height=50% />
<img style="vertical-align: middle;" alt="FZJ Logo" src="https://github.com/Materials-Data-Science-and-Informatics/Logos/raw/main/FZJ/FZJ.png" width=30% height=30% />
</div>
<br />
This project was developed at the Institute for Materials Data Science and Informatics
(IAS-9) of the Jülich Research Center and funded by the Helmholtz Metadata Collaboration
(HMC), an incubator-platform of the Helmholtz Association within the framework of the
Information and Data Science strategic initiative.
Raw data
{
"_id": null,
"home_page": "",
"name": "survey-dashboard",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "dashboard,data visualization,survey data,categorical data,interactive visualization,bokeh,panel",
"author": "Jens Broeder",
"author_email": "j.broeder@fz-juelich.de",
"download_url": "https://files.pythonhosted.org/packages/8f/9c/65eb67115fc8722b33e658237ef6ac4e867529757cdd72a201f1d5cd5563/survey_dashboard-0.1.0.tar.gz",
"platform": null,
"description": "# Survey dashboard\n\nA dashboard to display survey data in an interactive way.\n\n## Overview\n\nThis repository contains a dashboard using Panel and Bokeh, developed to display data from \nHMC surveys in an interactive exploratory way. It is designed such that the code for the interactive\nvisualizations might be reused for other projects.\nExample of a deployed version can be found [here](https://dashboard.survey.helmholtz-metadaten.de/survey_dashboard)\n\nSome impressions:\n\n\n\n\n## Installation\n\nAfter downloading the git repository you can install the software either with pip or poetry.\nWe recommend setting it up in a separate python virtual environment.\n\n```shell\npip install survey_dashboard\n```\nor\n\n```shell\npoetry install .\n```\n\n## Usage\n\n\nAfter installation you can start the app, i.e the panel server/bokeh server.\n```shell\npanel serve --port 50006 survey_dashboard/ \n```\nIf 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.\n```shell\npanel serve --port 50006 survey_dashboard/ --static-dirs en_files=./survey_dashboard/hmc_layout/static/en_files\n\n```\n\n* Navigate to `http://localhost:50006/` in your browser.\n\n## Deployment\n\nTo 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)\n\nDo steps under `usage` above, but for a public exposed URL, or what ever is used for deployment.\nThe Language verison of the dashboard can be set with the environment variable: 'L\n\n\nAdd the code from 'script' to you website:\n\n```python\nfrom bokeh.embed import server_document\nscript = server_document(\"url_to_running_server\")\nscript\n```\n\n## Copyright and Licence\n\nSee [LICENSE](./LICENSE).\n\n### Main used libraries and dependencies\n\nThe following libraries are used directly (i.e. not only transitively) in this project:\n\n\n## Acknowledgements\n\n<div>\n<img style=\"vertical-align: middle;\" alt=\"HMC Logo\" src=\"https://github.com/Materials-Data-Science-and-Informatics/Logos/raw/main/HMC/HMC_Logo_M.png\" width=50% height=50% />\n \n<img style=\"vertical-align: middle;\" alt=\"FZJ Logo\" src=\"https://github.com/Materials-Data-Science-and-Informatics/Logos/raw/main/FZJ/FZJ.png\" width=30% height=30% />\n</div>\n<br />\n\nThis project was developed at the Institute for Materials Data Science and Informatics\n(IAS-9) of the J\u00fclich Research Center and funded by the Helmholtz Metadata Collaboration\n(HMC), an incubator-platform of the Helmholtz Association within the framework of the\nInformation and Data Science strategic initiative.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Dashboard displaying survey data in an interactive way and allow for interactive exploration.",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [
"dashboard",
"data visualization",
"survey data",
"categorical data",
"interactive visualization",
"bokeh",
"panel"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fbbff0fd5c53bb7142b5dfb35b155dd7bdb36c019343b6334ddd9defadf5e693",
"md5": "18defe5671059be00c1db0d9ad351871",
"sha256": "7de338af7e2b1d050eec0931a6395f6e8f537a42e7633eba66d4a03e9da190e5"
},
"downloads": -1,
"filename": "survey_dashboard-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "18defe5671059be00c1db0d9ad351871",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 1495788,
"upload_time": "2023-06-05T11:45:22",
"upload_time_iso_8601": "2023-06-05T11:45:22.928228Z",
"url": "https://files.pythonhosted.org/packages/fb/bf/f0fd5c53bb7142b5dfb35b155dd7bdb36c019343b6334ddd9defadf5e693/survey_dashboard-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f9c65eb67115fc8722b33e658237ef6ac4e867529757cdd72a201f1d5cd5563",
"md5": "ddf4d12eb4a2eb01d20bbf28822b633b",
"sha256": "a1a1c71405659c4d9f1222dda0f7b4d7c9359460c7903917f860ecb24feceb93"
},
"downloads": -1,
"filename": "survey_dashboard-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "ddf4d12eb4a2eb01d20bbf28822b633b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 1484515,
"upload_time": "2023-06-05T11:45:25",
"upload_time_iso_8601": "2023-06-05T11:45:25.815288Z",
"url": "https://files.pythonhosted.org/packages/8f/9c/65eb67115fc8722b33e658237ef6ac4e867529757cdd72a201f1d5cd5563/survey_dashboard-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-05 11:45:25",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "survey-dashboard"
}
JSON