Skip to content

Commit 0bcb39c

Browse files
committed
docs: update readme credits, description, and usage
1 parent 79bd1fa commit 0bcb39c

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.md

+21-7
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# EMGdecomPy
22

3-
[![ci-cd](https://github.com/UBC-SPL-MDS/emg-decomPy/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/UBC-SPL-MDS/emg-decomPy/actions/workflows/ci-cd.yml)
4-
[![codecov](https://codecov.io/gh/UBC-SPL-MDS/EMGdecomPy/branch/main/graph/badge.svg?token=78ZU40UEOE)](https://codecov.io/gh/UBC-SPL-MDS/EMGdecomPy)
3+
[![ci-cd](https://github.com/UBC-SPL-MDS/emgdecompy/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/UBC-SPL-MDS/emgdecompy/actions/workflows/ci-cd.yml)
4+
[![codecov](https://codecov.io/gh/UBC-SPL-MDS/emgdecompy/branch/main/graph/badge.svg?token=78ZU40UEOE)](https://codecov.io/gh/UBC-SPL-MDS/emgdecompy)
55

6-
A package for decomposing raw EMG signals into individual motor unit activity.
6+
A package for decomposing multi-channel intramuscular and surface EMG signals into individual motor unit activity based off the blind source algorithm described in [`Negro et al. (2016)](https://iopscience.iop.org/article/10.1088/1741-2560/13/2/026027/meta).
77

88
## Proposal
99

@@ -19,20 +19,34 @@ To generate the proposal locally, run the following command from the root direct
1919
pip install emgdecompy
2020
```
2121

22-
## Usage
22+
## Usage and Example
2323

24-
- TODO
24+
After installing `EMGdecomPy`, to use the package import it with the following commands:
25+
26+
```
27+
from emgdecompy.decomposition import decomposition
28+
```
29+
30+
**Run the blind source separation algorithm on your data to extract out the separation vectors, motor unit firing times, and associated silhouette scores and pulse-to-noise ratios.**
31+
32+
```
33+
decomposition(data)
34+
```
2535

2636
## Contributing
2737

2838
Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.
2939

3040
## License
3141

32-
`emgdecompy` was created by Daniel King, Jasmine Ortega, Rada Rudyak, and Rowan Sivanandam. It is licensed under the terms of the MIT license.
42+
`EMGdecomPy` was created by [Daniel King](github.com/danfke), [Jasmine Ortega](github.com/jasmineortega), [Rada Rudyak](github.com/Radascript), and [Rowan Sivanandam](github.com/Rowansiv). It is licensed under the terms of the MIT license.
3343

3444
## Credits
3545

36-
`emgdecompy` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).
46+
`EMGdecomPy` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).
47+
48+
The blind source separation algorithm in this package was based off of [`Negro et al. (2016)](https://iopscience.iop.org/article/10.1088/1741-2560/13/2/026027/meta).
3749

3850
The data used for validation was obtained from [`Hug et al. (2021)`](https://figshare.com/articles/dataset/Analysis_of_motor_unit_spike_trains_estimated_from_high-density_surface_electromyography_is_highly_reliable_across_operators/13695937).
51+
52+
[Guilherme Ricioli](https://github.com/guilhermerc) was consulted for his work on [`semg-decomposition`](https://github.com/guilhermerc/semg-decomposition).

0 commit comments

Comments
 (0)