Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update url from ReSurfEMG to resurfemg-org #360

Merged
merged 1 commit into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ authors:
given-names: Eline
orcid: "https://orcid.org/0000-0002-0150-306X"

repository-code: 'https://github.com/ReSurfEMG/ReSurfEMG'
repository-code: 'https://github.com/resurfemg-org/ReSurfEMG'
repository-artifact: 'https://pypi.org/project/resurfemg/'

keywords:
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ The sections below outline the steps in each case.

## You have a question

1. use the search functionality [here](https://github.com/resurfemg/resurfemg/issues) to see if someone already filed the same issue;
1. use the search functionality [here](https://github.com/resurfemg-org/ReSurfEMG/issues) to see if someone already filed the same issue;
1. in some cases checking the documentation may help but if your issue search did not yield any relevant results, make a new issue;
1. apply the "Question" label; apply other labels when relevant.

## You think you may have found a bug

1. use the search functionality [here](https://github.com/resurfemg/resurfemg/issues) to see if someone already filed the same issue;
1. use the search functionality [here](https://github.com/resurfemg-org/ReSurfEMG/issues) to see if someone already filed the same issue;
1. if your issue search did not yield any relevant results, make a new issue, making sure to provide enough information to the rest of the community to understand the cause and context of the problem. Depending on the issue, you may want to include:
- the [SHA hashcode](https://help.github.com/articles/autolinked-references-and-urls/#commit-shas) of the commit that is causing your problem;
- some identifying information (name and version number) for dependencies you're using;
Expand Down
20 changes: 10 additions & 10 deletions README.md
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>

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6811553.svg)](https://doi.org/10.5281/zenodo.6811553)
[![PyPI](https://img.shields.io/pypi/v/resurfemg.svg)](https://pypi.python.org/pypi/resurfemg/)
[![Sanity](https://github.com/resurfemg/resurfemg/actions/workflows/on-commit.yml/badge.svg)](https://github.com/resurfemg/resurfemg/actions/workflows/on-commit.yml)
[![Sanity](https://github.com/resurfemg/resurfemg/actions/workflows/on-tag.yml/badge.svg)](https://github.com/resurfemg/resurfemg/actions/workflows/on-tag.yml)
[![Sanity](https://github.com/resurfemg-org/ReSurfEMG/actions/workflows/on-commit.yml/badge.svg)](https://github.com/resurfemg-org/ReSurfEMG/actions/workflows/on-commit.yml)
[![Sanity](https://github.com/resurfemg-org/ReSurfEMG/actions/workflows/on-tag.yml/badge.svg)](https://github.com/resurfemg-org/ReSurfEMG/actions/workflows/on-tag.yml)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/6487/badge)](https://bestpractices.coreinfrastructure.org/projects/6487)
[![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F-green)](https://fair-software.eu)
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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:
Expand Down Expand Up @@ -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.


Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/developers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ This project has CI setup that uses GitHub Actions
platform.


.. _GitHub repo: https://github.com/ReSurfEMG/ReSurfEMG
.. _GitHub Actions dashboard: https://github.com/ReSurfEMG/ReSurfEMG/actions
.. _GitHub repo: https://github.com/resurfemg-org/ReSurfEMG
.. _GitHub Actions dashboard: https://github.com/resurfemg-org/ReSurfEMG/actions


Style
Expand Down
2 changes: 1 addition & 1 deletion docs/medical-professionals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Surface EMG interpretation is a rapidly evolving field without many standards.
We build interfaces for ongoing research in the form of Jupyter notebooks,
as well as tools for clinical research. The main tool for clinical researchers is
the dashboard.
The dashboard is in a separate repository (https://github.com/ReSurfEMG/ReSurfEMG-dashboard).
The dashboard is in a separate repository (https://github.com/resurfemg-org/ReSurfEMG-dashboard).
At present to create a dashboard for the first time you need to use some kind of terminal.
After you have created/installed the dashboard once, you will be able to run it like the
executable programs you are used to. If you want to get a new release you will need to repeat the process.
Expand Down
Loading
Loading