-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update url from ReSurfEMG to resurfemg-org
- Loading branch information
1 parent
1cda1d4
commit b6fa7f6
Showing
8 changed files
with
45 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,11 @@ | ||
<p align="center"> | ||
<img style="width: 35%; height: 35%" src="https://github.com/resurfemg/resurfemg/blob/main/Logo_rond_tekst.svg"> | ||
<img style="width: 35%; height: 35%" src="https://github.com/resurfemg-org/ReSurfEMG/blob/main/Logo_rond_tekst.svg"> | ||
</p> | ||
|
||
[](https://doi.org/10.5281/zenodo.6811553) | ||
[](https://pypi.python.org/pypi/resurfemg/) | ||
[](https://github.com/resurfemg/resurfemg/actions/workflows/on-commit.yml) | ||
[](https://github.com/resurfemg/resurfemg/actions/workflows/on-tag.yml) | ||
[](https://github.com/resurfemg-org/ReSurfEMG/actions/workflows/on-commit.yml) | ||
[](https://github.com/resurfemg-org/ReSurfEMG/actions/workflows/on-tag.yml) | ||
[](https://opensource.org/licenses/Apache-2.0) | ||
[](https://bestpractices.coreinfrastructure.org/projects/6487) | ||
[](https://fair-software.eu) | ||
|
@@ -15,16 +15,16 @@ | |
of respiratory electromyography (EMG). On the same site as | ||
the repository for this library we keep [related resources](https://github.com/ReSurfEMG?tab=repositories). | ||
|
||
ReSurfEMG includes a [main code library](https://github.com/ReSurfEMG/ReSurfEMG) where the user can access the code to change various filter and analysis settings directly and/or in our [researcher interface notebooks](https://github.com/ReSurfEMG/ReSurfEMG/tree/main/notebooks/researcher_interface). | ||
In addition, ReSurfEMG has a [dashboard interface](https://github.com/ReSurfEMG/ReSurfEMG-dashboard) which contains default settings for preprocessing and analysis which can be changed through a graphical (no code) interface. We have some functionality available through a [command line interface](#command-line-interface) as well. | ||
ReSurfEMG includes a [main code library](https://github.com/resurfemg-org/ReSurfEMG) where the user can access the code to change various filter and analysis settings directly and/or in our [researcher interface notebooks](https://github.com/resurfemg-org/ReSurfEMG/tree/main/notebooks/researcher_interface). | ||
In addition, ReSurfEMG has a [dashboard interface](https://github.com/resurfemg-org/ReSurfEMG-dashboard) which contains default settings for preprocessing and analysis which can be changed through a graphical (no code) interface. We have some functionality available through a [command line interface](#command-line-interface) as well. | ||
|
||
The library was initially built for surface EMG, however many functions will also work for | ||
invasively measured respiratory EMG. This library supports the ongoing research at University of Twente on respiratory EMG. | ||
|
||
|
||
### Program files | ||
|
||
The core functions of ReSurfEMG are in the folder [resurfemg](https://github.com/ReSurfEMG/ReSurfEMG/tree/main/resurfemg): | ||
The core functions of ReSurfEMG are in the folder [resurfemg](https://github.com/resurfemg-org/ReSurfEMG/tree/main/resurfemg): | ||
|
||
- **cli:** Scripts for the command line interface | ||
- **data_connector:** Converter functions for discovering, loading, simulating and handling data. | ||
|
@@ -42,7 +42,7 @@ The core functions of ReSurfEMG are in the folder [resurfemg](https://github.com | |
|
||
### Folders and Notebooks | ||
|
||
Our [guide to notebooks](https://github.com/ReSurfEMG/ReSurfEMG/blob/main/notebooks_guide.md) is under construction. To look around keep in mind the following distinction on folders: | ||
Our [guide to notebooks](https://github.com/resurfemg-org/ReSurfEMG/blob/main/notebooks_guide.md) is under construction. To look around keep in mind the following distinction on folders: | ||
|
||
dev: | ||
- These notebooks are used in feature development and debugging by core members of the ReSurfEMG team. They can provide a basic example how to use some of the functionality. | ||
|
@@ -62,7 +62,7 @@ Dr. Eline Mos-Oppersma( 📫 [email protected]) to discuss any | |
questions on data configuration for your datasets. | ||
|
||
If you want to use a standardized dataset for any purpose we recommend | ||
the data in the [ReSurfEMG/test_data](https://github.com/ReSurfEMG/ReSurfEMG/blob/main/test_data), which is also used in testing the ReSurfEMG functions. | ||
the data in the [ReSurfEMG/test_data](https://github.com/resurfemg-org/ReSurfEMG/blob/main/test_data), which is also used in testing the ReSurfEMG functions. | ||
Data there can be used with any respiratory EMG algorithms in any program. Thus that data can function as a benchmarking set to compare algorithms across different programs. | ||
|
||
Alternatively, the data in the ReSurfEMG/synthetic_data repository: | ||
|
@@ -172,7 +172,7 @@ pip install resurfemg[dev] | |
command in your terminal. This opens a browser window where you can browse, | ||
open and run the notebooks. (We use [Jupyter notebooks](https://jupyter.org/try-jupyter/retro/notebooks/?path=notebooks/Intro.ipynb)) | ||
The ReSurfEMG notebooks are located in the notebooks folder. Navigate there | ||
and open a notebook of interest. The [basic_emg_analysis](https://github.com/ReSurfEMG/ReSurfEMG/blob/main/researcher_interface/basic_emg_analysis.ipynb) | ||
and open a notebook of interest. The [basic_emg_analysis](https://github.com/resurfemg-org/ReSurfEMG/blob/main/researcher_interface/basic_emg_analysis.ipynb) | ||
notebook can be used to understand how to use the package. | ||
|
||
|
||
|
@@ -257,7 +257,7 @@ The project has a sub-project of a related dashboard. Dashboard is a GUI that | |
exposes some of the project's functionality. In the past, we kept a a legacy | ||
dashboard in the same repository with ReSurfEMG code but we have deleted it. | ||
The current version of the dashboard into it's own repository: | ||
https://github.com/ReSurfEMG/ReSurfEMG-dashboard | ||
https://github.com/resurfemg-org/ReSurfEMG-dashboard | ||
|
||
|
||
### New commands | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.