Merge pull request #8 from Materials-Data-Science-and-Informatics/dev

Merge dev into master

Author: broeder-j

.gitignore

@@ -1,3 +1,6 @@
+# custom
+*.csv
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

.pre-commit-config.yaml

@@ -0,0 +1,52 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+    - id: double-quote-string-fixer
+      types: [python]
+    - id: end-of-file-fixer
+    - id: mixed-line-ending
+      types: [python]
+    - id: trailing-whitespace
+      types: [python]
+
+- repo: https://github.com/pre-commit/mirrors-yapf
+  rev: v0.32.0
+  hooks:
+  - id: yapf
+    name: yapf
+    types: [python]
+    exclude: &exclude_files >
+        (?x)^(
+            docs/.*|
+        )$
+    args: ['-i']
+    additional_dependencies: ['toml']
+  
+- repo: https://github.com/ikamensh/flynt/
+  rev: '0.76'
+  hooks:
+  -   id: flynt
+      args: [
+          '--line-length=120',
+          '--fail-on-change',
+      ]
+
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v2.31.1
+    hooks:
+    -   id: pyupgrade
+        args: [
+            '--py37-plus'
+        ]
+        exclude: '^(docs/)|(examples/)'
+
+- repo: local
+  hooks:
+
+  - id: pylint
+    name: pylint
+    entry: pylint
+    types: [python]
+    language: system
+    exclude: '^(docs/)|(examples/)'

Citation.cff

@@ -0,0 +1,50 @@
+cff-version: 1.2.0
+title: "survey-dashboard"
+message: "If you use this software, please cite it as below."
+version: 1.0.0
+type: software
+license: MIT
+date-released: '2022-09-25'
+repository-code: >-
+  https://github.com/Materials-Data-Science-and-Informatics/survey_dashboard
+url: >-
+  https://github.com/Materials-Data-Science-and-Informatics/survey_dashboard
+repository: >-
+  https://github.com/Materials-Data-Science-and-Informatics/survey_dashboard
+keywords:
+  - dashboard
+  - 'data visualization'
+  - 'survey data'
+  - 'categorical data'
+  - 'interactive visualization'
+  - bokeh
+  - panel
+authors:
+  - family-names: Bröder
+    given-names: Jens
+    orcid: 'https://orcid.org/0000-0001-7939-226X'
+    email: j.broeder@fz-juelich.de
+    affiliation: Forschungszentrum Jülich GmbH (FZJ)
+  - family-names: Gerlich
+    given-names: Silke Christine
+    orcid: 'https://orcid.org/0000-0003-3043-5657'
+    email: s.gerlich@fz-juelich.de
+    affiliation: Forschungszentrum Jülich GmbH (FZJ)
+  - family-names: Hofmann
+    given-names: Volker
+    orcid: 'https://orcid.org/0000-0002-5149-603X'
+    email: v.hofmann@fz-juelich.de
+    affiliation: Forschungszentrum Jülich GmbH (FZJ)
+abstract: |
+  A Dashboard displaying survey data in an 
+  interactive way and allow for interactive exploration.
+  Written for the data publication of the Helmholtz Metadata collaboration 
+  survey 2021: https://doi.org/10.7802/2433.
+  The code could be adapted to visualize other categorical data provided 
+  in a table.
+
+  Acknowledgements:
+  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.

codemeta.json

@@ -0,0 +1,62 @@
+{
+    "@context": [
+        "https://raw.githubusercontent.com/codemeta/codemeta/2.0/codemeta.jsonld",
+        "https://w3id.org/software-iodata",
+        "https://raw.githubusercontent.com/schemaorg/schemaorg/main/data/releases/13.0/schemaorgcontext.jsonld",
+        "https://w3id.org/software-types"
+    ],
+    "@id": "/survey-dashboard",
+    "@type": "SoftwareSourceCode",
+    "author": {
+        "@id": "/person/j.broeder",
+        "@type": "Person",
+        "email": "j.broeder@fz-juelich.de",
+        "familyName": "",
+        "givenName": "j.broeder"
+    },
+    "description": "A Dashboard displaying survey data interactively.",
+    "identifier": "survey-dashboard",
+    "license": "http://spdx.org/licenses/MIT",
+    "name": "survey-dashboard",
+    "runtimePlatform": [
+        "Python 3",
+        "Python 3.10",
+        "Python 3.8",
+        "Python 3.9"
+    ],
+    "softwareRequirements": [
+        {
+            "@id": "/dependency/bokeh-ge-2.4.3,-lt-3.0.0",
+            "@type": "SoftwareApplication",
+            "identifier": "bokeh",
+            "name": "bokeh",
+            "runtimePlatform": "Python 3",
+            "version": ">=2.4.3,<3.0.0"
+        },
+        {
+            "@id": "/dependency/pandas-ge-1.4.1,-lt-2.0.0",
+            "@type": "SoftwareApplication",
+            "identifier": "pandas",
+            "name": "pandas",
+            "runtimePlatform": "Python 3",
+            "version": ">=1.4.1,<2.0.0"
+        },
+        {
+            "@id": "/dependency/panel-ge-0.13.1,-lt-0.14.0",
+            "@type": "SoftwareApplication",
+            "identifier": "panel",
+            "name": "panel",
+            "runtimePlatform": "Python 3",
+            "version": ">=0.13.1,<0.14.0"
+        },
+        {
+            "@id": "/dependency/wordcloud-ge-1.8.2.2,-lt-2.0.0.0",
+            "@type": "SoftwareApplication",
+            "identifier": "wordcloud",
+            "name": "wordcloud",
+            "runtimePlatform": "Python 3",
+            "version": ">=1.8.2.2,<2.0.0.0"
+        }
+    ],
+    "version": "1.0.0"
+}