Skip to content

Commit

Permalink
Renamed section to Development and refined YASA Flaskified description
Browse files Browse the repository at this point in the history
  • Loading branch information
bartromb committed Jan 22, 2025
1 parent a6b238c commit f2dab23
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 25 deletions.
16 changes: 6 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,11 +132,14 @@ Below some plots demonstrating the functionalities of YASA. To reproduce these,
Development
~~~~~~~~~~~

YASA was created and is maintained by `Raphael Vallat <https://raphaelvallat.com>`_, a former postdoctoral researcher in `Matthew Walker's lab <https://www.humansleepscience.com/>`_ at UC Berkeley. Contributions are more than welcome so feel free to contact me, open an issue or submit a pull request!
* YASA was created and is maintained by `Raphael Vallat <https://raphaelvallat.com>`_, a former postdoctoral researcher in `Matthew Walker's lab <https://www.humansleepscience.com/>`_ at UC Berkeley. Contributions are more than welcome so feel free to contact me, open an issue or submit a pull request!

To see the code or report a bug, please visit the `GitHub repository <https://github.com/raphaelvallat/yasa>`_.
To see the code or report a bug, please visit the `GitHub repository <https://github.com/raphaelvallat/yasa>`_.

Note that this program is provided with NO WARRANTY OF ANY KIND.

* YASA Flaskified is a web-based tool built on YASA that allows EEG analysis through a browser interface. It requires deployment on a server, which can be done using the preconfigured scripts available in the repository. For more details, visit the **[YASA Flaskified GitHub repository](https://github.com/bartromb/YASAFlaskified)**.

Note that this program is provided with NO WARRANTY OF ANY KIND.

Citation
~~~~~~~~
Expand All @@ -145,11 +148,4 @@ To cite YASA, please use the `eLife publication <https://elifesciences.org/artic

* 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>`_
19 changes: 4 additions & 15 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -326,32 +326,21 @@ Whenever a new release is out there, you can upgrade your version by typing the
pip install --upgrade yasa
.. ----------------------------- RELATED PROJECTS -----------------------------
.. ----------------------------- DEVELOPMENT -----------------------------
.. 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>
<a data-toggle="collapse" href="#development">Development</a>
</h5>
</div>
<div id="related_projects" class="panel-collapse collapse">
<div id="development" 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>`_
YASA Flaskified is a web-based application for analyzing EEG data using YASA. It requires deployment on a physical or virtual server, which can be done using the scripts provided in its repository. For more details, visit the **[YASA Flaskified GitHub repository](https://github.com/bartromb/YASAFlaskified)**.

</div>
</div>
Expand Down

0 comments on commit f2dab23

Please sign in to comment.