Skip to content

Conversation

@oesteban
Copy link
Member

@oesteban oesteban commented Oct 7, 2025

Summary

  • ensure the CI download step writes the tutorial dataset to dwi_full_brainmask.h5
  • add a shared tutorial_data helper that caches the DWI dataset and exposes loading utilities
  • update the tutorial notebooks to import the helper instead of duplicating download logic

Testing

  • not run (not requested)

https://chatgpt.com/codex/tasks/task_e_68e59037bbc88330aec3ed01b3bceb52

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting

Comment on lines 42 to 45
from nifreeze.data.splitting import lovo_split
from nireports.reportlets.modality.dwi import plot_dwi
from tutorial_data import load_tutorial_dmri_dataset
dmri_dataset = DWI.from_filename("../../data/dwi.h5")
dmri_dataset = load_tutorial_dmri_dataset()

Choose a reason for hiding this comment

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

P1 Badge Make tutorial_data importable during notebook execution

The notebooks now rely on from tutorial_data import load_tutorial_dmri_dataset, but tutorial_data.py lives in the repository root and is neither installed nor added to PYTHONPATH. When the pages are executed from docs/tutorial (the default working directory for jupyter-book and for users running a single notebook), only that directory is on sys.path, so the import raises ModuleNotFoundError and the build fails before any cells run. Consider moving the helper into the docs tree or explicitly adding the repo root to sys.path before the import.

Useful? React with 👍 / 👎.

@oesteban oesteban changed the title Factor tutorial dataset access into helper ENH: Factor tutorial dataset access into helper Oct 8, 2025
@oesteban oesteban merged commit c428c58 into main Oct 8, 2025
1 check passed
@oesteban oesteban deleted the codex/update-book.yml-and-tutorial-markdown-files branch October 8, 2025 05:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants