Skip to content

Commit

Permalink
Add YASA Flaskified details to README and FAQ
Browse files Browse the repository at this point in the history
  • Loading branch information
bartromb committed Jan 11, 2025
1 parent 608fd07 commit a6b238c
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,3 +144,12 @@ Citation
To cite YASA, please use the `eLife publication <https://elifesciences.org/articles/70092>`_:

* Vallat, Raphael, and Matthew P. Walker. "An open-source, high-performance tool for automated sleep staging." Elife 10 (2021). doi: https://doi.org/10.7554/eLife.70092

Related Projects
~~~~~~~~~~~~~~~~~

Looking for a web-based solution to utilize YASA? Check out **YASA Flaskified**: a Flask-based application designed to process and analyze EEG data via an intuitive web interface.

**YASA Flaskified** also supports straightforward deployment on your own physical or virtual server using a preconfigured deployment script.

Repository: `YASA Flaskified <https://github.com/bartromb/YASAFlaskified>`_
33 changes: 33 additions & 0 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,39 @@ Whenever a new release is out there, you can upgrade your version by typing the
.. code-block:: shell
pip install --upgrade yasa
.. ----------------------------- RELATED PROJECTS -----------------------------
.. raw:: html

<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">
<a data-toggle="collapse" href="#related_projects">Are there any related projects?</a>
</h5>
</div>
<div id="related_projects" class="panel-collapse collapse">
<div class="panel-body">

**YASA Flaskified**

YASA Flaskified is a Flask-based web application that provides an intuitive interface for analyzing EEG data using the YASA library. It allows users to perform sleep analysis directly from their browser, simplifying workflows for those unfamiliar with Python or command-line tools.

**Features of YASA Flaskified:**

- **Web-based Interface:** YASA Flaskified transforms YASA's functionality into an accessible web application, enabling sleep analysis without direct Python programming.
- **Deployment Options:** Users can deploy YASA Flaskified on their own physical or virtual server using a preconfigured deployment script. This allows for private, secure, and scalable use of the application.
- **Integration with YASA:** The application is built around the YASA library, ensuring full compatibility and access to its core features, including sleep staging, event detection, and more.

**Where to find it?**

YASA Flaskified is available on GitHub:
`YASA Flaskified <https://github.com/bartromb/YASAFlaskified>`_

</div>
</div>
</div>


.. ----------------------------- DONATION -----------------------------
.. raw:: html
Expand Down

0 comments on commit a6b238c

Please sign in to comment.