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.

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

initial draft of new TD-fNIRS KF2 example #586

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

JohnGriffiths
Copy link

@JohnGriffiths JohnGriffiths commented Nov 13, 2024

Following from this PR discussion, this example demonstrates I/O of TD-FNIRS data, and also serves as an introduction to KF2 data.

Code and data based on example code from @julien-dubois-k

Remaining to-do:

  • Modify installation target to the above-linked PR
  • Add data download functionality
  • Modify some of the hdf access bits with references to getting the info from the mne snirf loader

@JohnGriffiths JohnGriffiths marked this pull request as ready for review November 14, 2024 06:05
@JohnGriffiths
Copy link
Author

PR adding KF2 tutorial example, as discussed.

I have verified that this builds an correct-looking example webpage with Make html

@larsoner - do need some help here with getting the CI to pass

Some things to note re: the contents of this example:

  1. It currently uses gdown to pull the example file. I suggest we keep this as-in, and consider updating to something with mne-misc-data after this one is merged

  2. Likewise, I suggest we edit the mne dependency back to the mne-tools/mne-python master in a later PR, once the PR in the above-linked thread has been resolved.

  3. Some of the contents regarding pulling stuff from the hdf5 archive could be modified in future versions to show pulling this info from the hdf archive directly or from the mne reader. However I don't believe this functionality is in the MNE .snirf reader yet, so we would need to complete a new PR with that code first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant