MRG, DOC, ENH: new frequency-tagging tutorial

[dominikwelke]

What does this implement/fix?

we propose a new tutorial for basic analysis of frequency-tagging data.
it comes with an example dataset from visual stimulation with inverting checkerboards.

Reference issue

no fixes, but loosely related to discussion about a new spectra class (#7671)

authors

@dominikwelke @kalenkovich

[agramfort]

thx @dominikwelke !

how big are the files? can we add this to the doc build to see it rendered on circleci?

[dominikwelke]

hi @agramfort, thanks for the quick response!

how big are the files?

its about 40mb. i published the data on osf and the script fetches them from there

can we add this to the doc build to see it rendered on circleci?

locally it builds fine. how do i add it to the doc build?

[agramfort]

if you call your tutorial plot_ssvep.py it will be automatically rendered on the website.
Can you try here while fixing the conflicting file?

thanks

[larsoner]

@rob-luke @agramfort the latest rendering is here:

https://25353-1301584-gh.circle-artifacts.com/0/dev/auto_tutorials/time-freq/plot_ssvep.html

@dominikwelke can you add a conditional like https://github.com/mne-tools/mne-python/blob/main/tools/circleci_download.sh#L90-L92 ? It would get rid of the download inside the example rendering.

[dominikwelke]

@dominikwelke can you add a conditional like https://github.com/mne-tools/mne-python/blob/main/tools/circleci_download.sh#L90-L92 ? It would get rid of the download inside the example rendering.

the conditional alone didnt work.. the ci sais InputError: (...) no such file or directory
i guess the dataset has to be listed somewhere else too. can you direct me to the spot?

[larsoner]

the ci sais InputError: (...) no such file or directory

Fun! We've hit another release-related error, as PyQt5 5.15.3 came out 3 hours ago:

https://pypi.org/project/PyQt5/#history

I'll make a hotfix in main to pin us to !=5.15.3 and hopefully that fixes things for you

[larsoner]

hope this worked

If you have all doc-building dependencies installed (e.g., with pip install -r requirements_doc.txt) and do:

$ cd doc
$ PATTERN=ssvep make html_dev-pattern
...
$ make show

it will build the docs plus your specific example. Locally when I do this on your branch and wait a few minutes for the built to complete I see:

So clearly I got the syntax wrong. :) Changing it to:

.. contents:: Outline
   :depth: 2

and re-running PATTERN=ssvep make html_dev-pattern produces:

[dominikwelke]

If you have all doc-building dependencies installed

it worked fine locally but stopped working with the new theme (no theme named 'pydata_sphinx_theme' found (missing theme.conf?))
i'll update my environment

So clearly I got the syntax wrong. :) Changing it to:

.. contents:: Outline
   :depth: 2

great. i actually wondered whether this would be correct, but i blindly trusted you :)
changed

[rob-luke]

do you have a good reference for this @rob-luke ?

Don't bother unless you can find one easily. Youve changed it to 15.0 now, so its clear to the reader. Thanks for the extra info. Its a great addition to the tutorials.

[agramfort]

Ok to merge when CIs are green (except the ones already red in main)

Thanks a lot @dominikwelke !

[dominikwelke]

ok, all CIs are green @agramfort @larsoner @rob-luke @kalenkovich

I'll push a last commit with the changelog

[larsoner]

Other than two minor remaining issues, LGTM +1 for merge!

https://25558-1301584-gh.circle-artifacts.com/0/dev/auto_tutorials/time-freq/plot_ssvep.html

[kalenkovich]

Other than two minor remaining issues, LGTM +1 for merge!

https://25558-1301584-gh.circle-artifacts.com/0/dev/auto_tutorials/time-freq/plot_ssvep.html

Committed your suggestions.

[agramfort]

@dominikwelke can you merge main branch here to make sure CIs are green?

[dominikwelke]

@dominikwelke can you merge main branch here to make sure CIs are green?

@agramfort all CIs are green now

[agramfort]

thx a lot @dominikwelke and @kalenkovich !