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

ENH: Add an additional environment to tox to run notebooks #257

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jhlegarreta
Copy link
Collaborator

@jhlegarreta jhlegarreta commented Nov 8, 2024

Add an additional environment to tox to run notebooks.

Add a new table to pyproject.toml to host the jupyter, nbconvert and nbclient dependencies so that the notebooks can be run.

@jhlegarreta
Copy link
Collaborator Author

@effigies @oesteban sorry to tag you. I'd be interested in knowing whether you'd add a separate step to tox.ini for this or whether you think this is OK.

Copy link

codecov bot commented Nov 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.24%. Comparing base (795a9b7) to head (e061416).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #257   +/-   ##
=======================================
  Coverage   66.24%   66.24%           
=======================================
  Files          19       19           
  Lines         942      942           
  Branches      119      119           
=======================================
  Hits          624      624           
  Misses        274      274           
  Partials       44       44           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@effigies
Copy link
Member

effigies commented Nov 8, 2024

What's the old and new runtime? If they're long running, I'd suggest a new tox environment. If it's not a significant addition, this seems fine.

@jhlegarreta jhlegarreta force-pushed the RunNotebooksInTox branch 3 times, most recently from 8e6e5e9 to 8a95480 Compare November 9, 2024 00:32
@jhlegarreta
Copy link
Collaborator Author

jhlegarreta commented Nov 9, 2024

What's the old and new runtime? If they're long running, I'd suggest a new tox environment. If it's not a significant addition, this seems fine.

I see; before it was around 6 minutes, but after reading your comment I believe that it is better to add a new environment event if the running time is not that long. I am missing something, though, as the notebook environment is not being run. In fact, none of the other environments are being run either.

Edit: Figured out how to run the notebook environment. Need to figure out its issues with the Python kernel.

Edit: Working now. The notebook is failing because we have not uploaded the data that is requires somewhere to be able to share and use it:
https://github.com/nipreps/eddymotion/actions/runs/11751978527/job/32742871992?pr=257#step:11:1142

@jhlegarreta jhlegarreta force-pushed the RunNotebooksInTox branch 3 times, most recently from e061416 to a608c43 Compare November 9, 2024 00:56
Add an additional environment to `tox` to run notebooks.

Add a new table to `pyproject.toml` to host the `jupyter`, `nbconvert`
and `nbclient` dependencies so that the notebooks can be run.
@jhlegarreta jhlegarreta changed the title ENH: Run Jupyter notebooks in the tox testing step ENH: Add an additional environment to tox to run notebooks Nov 9, 2024
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.

2 participants