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.

Sign up for GitHub

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

Add YASA Flaskified details to README and FAQ #198

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add YASA Flaskified details to README and FAQ #198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a6b238c
Add YASA Flaskified details to README and FAQ
bartromb Jan 11, 2025
784280b
Merge branch 'master' into add-yasa-flaskified-link
raphaelvallat Jan 18, 2025
f2dab23
Renamed section to Development and refined YASA Flaskified description
bartromb Jan 22, 2025
0a565fa
Merge branch 'add-yasa-flaskified-link' of https://github.com/bartrom…
bartromb Jan 22, 2025
680c994
Fix hyperlinks to reStructuredText format in Development section
bartromb Jan 22, 2025
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
11 changes: 8 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,15 +132,20 @@ 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
~~~~~~~~

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


22 changes: 22 additions & 0 deletions docs/faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,28 @@ Others
.. code-block:: shell

pip install --upgrade yasa
pip install --upgrade yasa


.. ----------------------------- DEVELOPMENT -----------------------------
.. raw:: html

<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">
<a data-toggle="collapse" href="#development">Development</a>
</h5>
</div>
<div id="development" class="panel-collapse collapse">
<div class="panel-body">

**YASA Flaskified**
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but I'd love to hear from @remrama's before final approval.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • The docs just got changed to restructured text (instead of HTML). The formatting is much simpler, but I'm not sure how to handle this merge (since Overhaul docs with PyData Sphinx Theme #194 is already merged into master). If anyone needs help with this, let me know.
  • Did an extra pip install --upgrade yasa get added to Line 222? If so, that should be removed.
  • I think the dropdown heading could be more informative than Are there any related projects? What about Can I use YASA online? or Can YASA be deployed on a remote server? If that makes sense...


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>
</div>

.. ----------------------------- DONATION -----------------------------
.. dropdown:: I am not a programmer, how can I contribute to YASA?
Expand Down