Skip to content

Commit

Permalink
added tutorials
Browse files Browse the repository at this point in the history
  • Loading branch information
Fabi committed Oct 2, 2024
1 parent 231c611 commit 304b5fb
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions doc/source/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,23 @@ Introductory
This notebook gets you familiar with the IRASA algorithm and shows you the basic functionality
of PyRASA.

:doc:`View the notebook <../examples/basic_functionality>` or run interactively:
:doc:`Getting Started <../examples/basic_functionality>`

******************************
2. Improving your IRASA models
******************************

This notebook shows you how to improve your IRASA model fits.

:doc:`View the notebook <../examples/improving_irasa_models>` or run interactively:
:doc:`Improve your IRASA <../examples/improving_irasa_models>`

****************************
3. Pitfalls when using IRASA
****************************

This notebook outlines common pitfalls when fitting IRASA models.

:doc:`View the notebook <../../examples/irasa_pitfalls>` or run interactively:
:doc:`Pitfalls <../../examples/irasa_pitfalls>`


*********************
Expand All @@ -41,7 +41,7 @@ This notebook outlines common pitfalls when fitting IRASA models.
IRASA comes only with a single hyperparameter - the set of up-/downsampling factors.
Here we introduce a method to optimize this hset to get the most out of your model.

:doc:`View the notebook <../../examples/hset_optimization>` or run interactively:
:doc:`Optimization <../../examples/hset_optimization>`

************
4. IRASA MNE
Expand All @@ -50,7 +50,7 @@ Here we introduce a method to optimize this hset to get the most out of your mod
Are you analysing M/EEG data using MNE Python? You might be happy to hear that you can directly
apply IRASA to your raw or epoched data objects. Open the notebook to see how its done.

:doc:`View the notebook <../../examples/irasa_mne>` or run interactively:
:doc:`IRASA in MNE <../../examples/irasa_mne>`


***********************
Expand All @@ -60,7 +60,7 @@ apply IRASA to your raw or epoched data objects. Open the notebook to see how it
Did you know that IRASA can be used in the timefrequency domain for a time resolved spectral parametrization?
Open this notebook to see how its done.

:doc:`View the notebook <../../examples/irasa_sprint>` or run interactively:
:doc:`Time-Frequency IRASA <../../examples/irasa_sprint>`



Expand All @@ -74,5 +74,4 @@ Advanced
PyRASA allows you to define your own functions to model aperiodic activity.
This notebook shows you how its done.

:doc:`View the notebook <../../examples/custom_fit_functions>` or run interactively:

:doc:`Custom Aperiodic models <../../examples/custom_fit_functions>`

0 comments on commit 304b5fb

Please sign in to comment.