Data

Tools

Indexes

Applications

Experiments

Open Source Science

resurfemg-dashboard

Dashboard to use the ReSurfEMG library

https://github.com/resurfemg-org/resurfemg-dashboard

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (10.2%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Dashboard to use the ReSurfEMG library

Basic Info
  • Host: GitHub
  • Owner: resurfemg-org
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Size: 7.19 MB
Statistics
  • Stars: 4
  • Watchers: 2
  • Forks: 0
  • Open Issues: 14
  • Releases: 5
Created over 3 years ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.md

ReSurfEMG-dashboard

Dashboard to use the ReSurfEMG library

DOI

Getting started

1) This dashboard requires that you have an environment with certain dependencies including dash. We recommend that you do the following: * For Windows users: sh python -m venv .venv_dashboard .venv_dashboard\Scripts\activate pip install PATH_TO_DASHBOARD

  • For Linux/OSx users: sh python3 -m venv .venv_dashboard source .venv_dashboard/bin/activate python3 -m pip install PATH_TO_DASHBOARD

2) Once you have entered an environment with the necessary packages, run the resurfemgdashboard module with Python and a url for the dashboard should appear in your terminal (open the url). ``` sh python -m resurfemgdashboard `` (For Linux/OSx use:python3`)

Building executable file

! WARNING The executable is work-in-progress, and might not work as expected ! To ease the distribution and the use of the ReSurfEMG Dashboard, it is possible to build an executable file, through the following steps:

  • Activate the virtual environment
  • Install the PyInstaller by running sh pip install pyinstaller
  • Run sh pyinstaller resurfemg_dashboard/main.spec

If the process is successful, the resurfemg_dashboard.exe file can be found in the /dist/main folder. By launching the executable file, the dashboard will be prompted.

N.B. The dist folder containing the executable file should be created and uploaded when a new release of the dashboard is created.

Testing

Linting tests are included in this project. Build the environment in the pyproject.toml and enter it. You should then be able to use the python setup.py lint command. With care in the proper situation you may also use the --fast option.

Owner

  • Name: ReSurfEMG
  • Login: resurfemg-org
  • Kind: organization

Transforming surface electromyography into clinical insights

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: ReSurfEMG-dashboard
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Walter
    family-names: Baccinelli
    email: w.baccinelli@esciencecenter.nl
    affiliation: Netherlands eScience Center
    orcid: 'https://orcid.org/0000-0001-8888-4792'
  - given-names: Candace Makeda
    family-names: Moore
    name-particle: Candace
    email: c.moore@esciencecenter.nl
    affiliation: Netherlands eScience Center
    orcid: 'https://orcid.org/0000-0003-1672-7565'

keywords:
  - EMG
  - respiratory
  - Python
  - surface EMG
  - GUI
license: Apache-2.0

repository-code: "https://github.com/ReSurfEMG/ReSurfEMG-dashboard"
title: "ReSurfEMG-dashboard"
version: "0.0.1"
date-released: 20/01/2023

GitHub Events

Total
  • Create event: 3
  • Release event: 2
  • Issues event: 5
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 21
  • Pull request review event: 1
  • Pull request event: 5
Last Year
  • Create event: 3
  • Release event: 2
  • Issues event: 5
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 21
  • Pull request review event: 1
  • Pull request event: 5

Dependencies

.github/workflows/on-commit.yml actions
  • actions/checkout v3 composite
  • s-weigand/setup-conda v1 composite
setup.py pypi
  • matplotlib *
  • pandas *
  • pyxdf *
  • scipy *
environment.yml pypi