ReSurfEMG is an open source collaborative python library for analysis of respiratory electromyography (EMG). The library was initially built for surface EMG, however many functions will also work for respiratory EMG directly acquired (trans-esophageal). This library supports the ongoing research at University of Twente on respiratory EMG.
researcher_interface:
- These are a growing series of interactive notebooks that allow
researchers to investigate questions about their own EMG data
- ⚡ Important: in almost all data there will be a time difference between EMG signals and ventilator signals. You can pre-process to correct for this lead or lag with the notebook called lead_lag_mismatch_upsample.
open_work:
- This folder contains experimental work by core members of the rsemg team
The main program in this repository contains functions for analysis of EMG.
The notebooks are configured to run on various datasets. Contact Candace Makeda Moore (c.moore@esciencecenter.nl) to discuss any questions on data configuration.
How to get the notebooks running? Assuming the raw data set and metadata is available.
- Install all Python packages required, using conda and the
environment.ymlfile.- The command for Windows/Anaconda users can be something like:
conda env create -f environment.yml. - Linux users can create their own environment by hand.
- The command for Windows/Anaconda users can be something like:
- Open a notebook in researcher_interface and interactively run the cells.
Up to date documentation can be generated in command-line as follows (in bash terminal):
sphinx-apidoc -o ./docs -f --separate ./resurfemg
rm -rf ./built_documentation
sphinx-build -b html ./docs ./built_documentationIf you are working in a VScode command line interface (terminal cmd):
sphinx-apidoc -o ./docs -f --separate ./resurfemg
rm -rf ./built_documentation
sphinx-build -b html ./docs ./built_documentationOnline documentation can be found at https://resurfemg.github.io/ReSurfEMG/ or on https://readthedocs.org/ by searching for ReSurfEMG
✨Copyright 2022 Netherlands eScience Center and U. Twente Licensed under the Apache License, version 2.0. See LICENSE for details.✨