Update maintenance branch to 0.1.0-beta.2

.gitignore

@@ -5,7 +5,7 @@ __pycache__*
 .DS_Store
 docs/.DS_Store
 dist/
-testgiacomovalli.egg-info/
+openhdemg.egg-info/
 
 prove.py
 prove_storage.py

CODEOWNERS

@@ -4,6 +4,6 @@
 # someone opens a pull request.
 *       @GiacomoValliPhD
 
-# When there are changes in the GUI folder, @giacomovalliphd
+# When there are changes in the GUI folder, @GiacomoValliPhD
 # and @PaulRitsche will be requested for review.
-/openhdemg/gui/ @giacomovalliphd @PaulRitsche
+/openhdemg/gui/ @GiacomoValliPhD @PaulRitsche

README.md

@@ -2,7 +2,7 @@
 <br/>
 
 <p align="center">
-  <img src="https://www.giacomovalli.com/openhdemg/md_graphics/Index/Banner_Logo.png" />
+  <img src="https://www.giacomovalli.com/openhdemg/md_graphics/index/banner_logo.png" />
 </p>
 
 <br/>
@@ -23,7 +23,7 @@ Electromyography (HD-EMG) recordings. Some of its main features are listed below
 7. **Save** the results of the analyses and the edited file.
 
 ## Start immediately
-If you already know how to use Python, that's the way to go! Otherwise, have a look at the tutorial explaining how to [Setup your Python working environment](https://www.giacomovalli.com/openhdemg/tutorials/Setup_working_env/).
+If you already know how to use Python, that's the way to go! Otherwise, have a look at the tutorial explaining how to [Setup your Python working environment](https://www.giacomovalli.com/openhdemg/tutorials/setup_working_env/).
 
 *openhdemg* can be easily installed using pip:
 
@@ -37,7 +37,7 @@ or conda:
 conda install -c conda-forge openhdemg
 ```
 
-If you want an overview of what you can do with the *openhdemg* library, have a look at the [Quick Start section](https://www.giacomovalli.com/openhdemg/Quick-Start/).
+If you want an overview of what you can do with the *openhdemg* library, have a look at the [Quick Start section](https://www.giacomovalli.com/openhdemg/quick-start/).
 
 ## Good to know
 In addition to the rich set of modules and functions presented in the **API documentation**, *openhdemg* offers also a practical graphical user interface (GUI) from which many tasks can be performed without writing a single line of code!
@@ -50,7 +50,7 @@ python -m openhdemg.gui.openhdemg_gui
 
 Once opened, it will look like this. It is cool, isn't it?
 
-![gui_preview](https://www.giacomovalli.com/openhdemg/md_graphics/Index/GUI_Preview.png)
+![gui_preview](https://www.giacomovalli.com/openhdemg/md_graphics/index/gui_preview.png)
 
 ## Why openhdemg
 The *openhdemg* project was born in 2022 with the aim to provide the HD-EMG community with a free and open-source framework to analyse motor units' properties.

docs/about-us.md

@@ -0,0 +1,92 @@
+## Mission
+
+<div style="text-align: center; padding: 10px;">
+<em>
+“To build the most complete, easy-to-use, free, and open-source framework for the analysis of High-Density Electromyography (HD-EMG) recordings”
+</em>
+</div>
+
+<br>
+But we cannot achieve this alone! That's why *openhdemg* is a community-driven project where everyone's [contribution](contribute.md) is welcomed and essential.
+
+## Goals
+
+:octicons-hash-24: community :octicons-hash-24: inclusion :octicons-hash-24: collaboration :octicons-hash-24: knowledgesharing
+
+We aim to cultivate a culture of knowledge sharing, collaboration, and open-source contributions within the HD-EMG community, ensuring that expertise and advancements are accessible to all.
+
+:octicons-hash-24: advance :octicons-hash-24: discover :octicons-hash-24: research
+
+We want to empower researchers with an efficient, effective and comprehensive framework for the analysis of HD-EMG recordings and single motor unit properties to advance their research.
+
+## Roadmap
+
+A roadmap is a collection of planned **milestones** and **tasks** that are necessary for the successful development and growth of the *openhdemg* project. It outlines the key steps and objectives that need to be achieved to meet the project's goals and deliver value to the community. The roadmap drives the project's evolution, ensuring that efforts are focused, organized, and aligned with the overall vision.
+
+At this stage, we have identified and set six major milestones for the *openhdemg* project. These milestones are divided into two categories: three on the development side and three on the engagement side.
+
+To read the complete roadmap, click on the next button.
+
+[Complete roadmap &nbsp; :fontawesome-solid-map-location-dot:](about-us/complete-roadmap.md){ .md-button .md-button--primary }
+
+<br>
+
+``` mermaid
+graph TB;
+    A[Development] --> B(Feedback from beta test)
+    B --> C(Stable release v0.1)
+    C --> D(Continuous updates)
+    E[Engagement] --> F(Reach)
+    E[Engagement] --> G(Outreach)
+    E[Engagement] --> H(New contributors)
+    F --> I(Feedback)
+    G --> I(Feedback)
+    I --> D
+    H --> D
+    D --> L(Release v1.0)
+```
+
+## Meet the developers
+
+Giacomo Valli:
+
+- giacomo.valli@phd.unipd.it
+
+- The creator of the project and the developer of the library.
+
+- Giacomo Valli obtained a master degree in Sports Science and a research fellowship in molecular biology of exercise at the University of Urbino (IT). He is currently a PhD student at the University of Padova (IT) in neuromuscular physiology. He is investigating the electrophysiological modifications happening during disuse, disease and aging and linking this information to the molecular alterations of the muscle.
+
+Paul Ritsche:
+
+- paul.ritsche@unibas.ch
+
+- The developer of the GUI.
+
+- Paul Ritsche obtained a master degree in Sports Science at the University of Basel (CH). He is currently a research associate at the University of Basel (CH) focusing on muscle ultrasonography. He is investigating automatic ultrasonography image analysis methods to evaluate muscle morphological as well architectural parameters.
+
+## Meet the contributors
+
+Francesco Negro:
+
+- francesco.negro@unibs.it
+
+- Contribution: &nbsp; :fontawesome-solid-brain: Knowledge sharing &nbsp; :fontawesome-solid-file-code: Code sharing &nbsp; :octicons-codescan-checkmark-24: Accuracy check
+
+- Francesco Negro is a Full Professor at the Department of Clinical and Experimental Sciences at Universita’ degli Studi di Brescia (IT). His research interests include applied physiology of the human motor system, signal processing of intramuscular and surface electromyography, and modeling of spinal neural networks.
+
+Andrea Casolo:
+
+- andrea.casolo@unipd.it
+
+- Contribution: &nbsp; :fontawesome-solid-brain: Knowledge sharing &nbsp; :octicons-codescan-checkmark-24: Accuracy check
+
+- Andrea Casolo is an Assistant Professor at the Department of Biomedical Sciences, University of Padova (IT). He obtained a MSc in Health and Physical Activity (2016) and a PhD in Human Movement and Sport Sciences (2020) from the University of Rome "Foro Italico". His research interests focus on the neural control of movement and the study of neuromuscular plasticity to physical exercise investigated with high-density surface electromyography.
+
+Giuseppe De Vito:
+
+- giuseppe.devito@unipd.it
+
+- Contribution: &nbsp; :fontawesome-solid-brain: Knowledge sharing
+
+- Giuseppe De Vito is a full Professor of Human Physiology in the Department of Biomedical Sciences at University of Padova (IT). He was, from 2007 until 2019, Professor and Dean in the School of Public Health, Physiotherapy & Sports Science at University College Dublin (IE) (Head of School between 2014 and 2019). Giuseppe does research in Human and Exercise Physiology.
+

docs/about-us/complete-roadmap.md

@@ -0,0 +1,109 @@
+<br>
+
+``` mermaid
+graph TB;
+    A[Development] --> B(Feedback from beta test)
+    B --> C(Stable release v0.1)
+    C --> D(Continuous updates)
+    E[Engagement] --> F(Reach)
+    E[Engagement] --> G(Outreach)
+    E[Engagement] --> H(New contributors)
+    F --> I(Feedback)
+    G --> I(Feedback)
+    I --> D
+    H --> D
+    D --> L(Release v1.0)
+```
+
+<br>
+
+A roadmap is a collection of planned **milestones** and **tasks** that are necessary for the successful development and growth of the *openhdemg* project. It outlines the key steps and objectives that need to be achieved to meet the project's goals and deliver value to the community. The roadmap drives the project's evolution, ensuring that efforts are focused, organized, and aligned with the overall vision.
+
+Milestones represent significant achievements and tasks are the actionable steps to reach those milestones. They provide a structured approach to project planning and execution, tracking progress and ensuring systematic completion. The roadmap is flexible, allowing us to incorporate users feedback and refine the plan based on community input.
+
+## Milestones
+
+Legend for milestones status:
+
+:fontawesome-solid-check: &nbsp; Completed
+
+:fontawesome-solid-clock: &nbsp; Ongoing 
+
+:fontawesome-solid-calendar-day: &nbsp; Planned date
+
+At this stage, we have identified and set six major milestones for the *openhdemg* project. These milestones are divided into two categories: three on the development side and three on the engagement side.
+
+--------------------------------------------
+
+### Development milestones
+
+The development milestones focus on advancing the framework's functionality, improving existing features, and introducing new algorithms and analysis techniques. These milestones aim to enhance the capabilities and performance of *openhdemg*, providing a more powerful and comprehensive tool for analyzing High-Density Electromyography (HD-EMG) recordings.
+
+**Going public** &nbsp; :fontawesome-solid-check:
+
+On 04/07/2023 the *openhdemg* project was released to the public with a beta release on [PyPI](https://pypi.org/project/openhdemg/){:target="_blank"}, a public [GitHub](https://github.com/GiacomoValliPhD/openhdemg){:target="_blank"} repository, a website and a [Twitter](https://twitter.com/openhdemg){:target="_blank"} page. This milestone marks the beginning of *openhdemg* as an open-source project.
+
+**Stable release v0.1** &nbsp; :fontawesome-solid-clock: &nbsp; :fontawesome-solid-calendar-day:
+
+Planned by end of 2023. While a beta release is meant for testing purpose, a stable release represents the transition to a production-ready version of the framework. The primary objective of this milestone is to ensure the reliability, robustness, and usability of *openhdemg* for a wide range of users.
+
+**Release v1.0** &nbsp; :fontawesome-solid-clock:
+
+The release of Version 1.0 is undoubtedly the most significant achievement for an open-source project like *openhdemg*, signifying a substantial enhancement in the project's completeness and usability. With this release, the project has achieved a level of maturity that fulfills the needs of a wide range of users in the field of HD-EMG.
+
+--------------------------------------------
+
+### Engagement milestones
+
+On the engagement side, the milestones aim to enhance the reach and outreach of *openhdemg* and to bring new [contributors](#meet-the-contributors) in the project. These milestones focus on expanding the visibility and impact of *openhdemg* within the HD-EMG community and beyond.
+
+**Reach 1** &nbsp; :fontawesome-solid-clock: &nbsp; :fontawesome-solid-calendar-day:
+
+Planned by end of 2023. By leveraging preferred channels such as [Twitter](https://twitter.com/openhdemg){:target="_blank"} and congresses, we aim to engage with new individuals and organizations interested in HD-EMG analysis. Target to complete 'Reach 1' = 100 [Twitter](https://twitter.com/openhdemg){:target="_blank"} followers.
+
+**Outreach 1** &nbsp; :fontawesome-solid-clock: &nbsp; :fontawesome-solid-calendar-day:
+
+Planned by end of 2023. This milestone involves improving documentation, providing tutorials and educational resources, and enhancing user support. By achieving these milestones, we aim to empower users with the knowledge and tools they need to effectively utilize *openhdemg* and conduct their own HD-EMG analyses. Target to complete 'Outreach 1' = cover all the functionalities of the *openhdemg* framework with specific tutorials.
+
+**Increase contributors 1** &nbsp; :fontawesome-solid-clock:
+
+Bringing new contributors to the *openhdemg* project is fundamental to increase the functionalities of the framework and to build a collaborative community of experts. Target to complete 'Increase contributors 1' = 5 external contributors
+
+## Tasks
+
+### Development tasks
+
+**Stable release v0.1**
+
+- Identify and address any critical bugs or issues reported during the beta testing phase.
+- Conduct extensive testing on different platforms and configurations to ensure the stability and reliability of the framework.
+- Incorporate user feedback and suggestions to improve the user interface, features, and overall user experience.
+- Create comprehensive documentation for installation, usage, and troubleshooting of *openhdemg*.
+
+**Release v1.0**
+
+- Enhance the framework's performance and efficiency to handle larger datasets and complex analyses.
+- Implement additional algorithms and analysis techniques to broaden the capabilities of *openhdemg*.
+- Conduct thorough testing and validation of the framework's functionalities to ensure accuracy and reliability.
+- Document and communicate the major updates and improvements in the release to the user community.
+
+### Engagement tasks
+
+**Reach 1**
+
+- Develop a social media strategy for *openhdemg*, including regular posting, engaging with relevant hashtags, and connecting with HD-EMG researchers and practitioners.
+- Share success stories, case studies, and relevant content about *openhdemg* on Twitter to attract a wider audience and increase followers.
+- Actively participate in HD-EMG-related congresses, conferences, and events to network with professionals in the field and promote *openhdemg*.
+
+**Outreach 1**
+
+- Create comprehensive tutorials and educational resources that cover various aspects of HD-EMG analysis using *openhdemg*.
+- Improve the documentation to provide clear instructions, examples, and explanations of the framework's functionalities.
+- Establish a user support system, such as a forum or mailing list and promote the use of the [*openhdemg* discussion section](https://github.com/GiacomoValliPhD/openhdemg/discussions){:target="_blank"}.
+
+**Increase contributors 1**
+
+- Actively encourage contributions from the community by creating a contributor-friendly environment and providing guidance on [how to get involved](../contribute.md).
+- Identify specific areas where external contributors can make meaningful contributions, such as implementing new algorithms, improving existing features, or conducting performance optimizations.
+- Collaborate with potential contributors through issue discussions, pull request reviews, and effective communication channels to onboard them into the *openhdemg* community.
+