Skip to content

Conversation

@clmould
Copy link
Collaborator

@clmould clmould commented Nov 3, 2025

Description

Adds a binder badge to the README - when clicked takes you to the binder site which renders PROCESS online, allowing the examples to be run there. Also added some instructions to the README and the docs to explain.

image

Checklist

I confirm that I have completed the following checks:

  • My changes follow the PROCESS style guide
  • I have justified any large differences in the regression tests caused by this pull request in the comments.
  • I have added new tests where appropriate for the changes I have made.
  • If I have had to change any existing unit or integration tests, I have justified this change in the pull request comments.
  • If I have made documentation changes, I have checked they render correctly.
  • I have added documentation for my change, if appropriate.

@clmould clmould linked an issue Nov 3, 2025 that may be closed by this pull request
@codecov-commenter
Copy link

codecov-commenter commented Nov 3, 2025

Codecov Report

❌ Patch coverage is 1.51515% with 65 lines in your changes missing coverage. Please review.
✅ Project coverage is 45.94%. Comparing base (0548fed) to head (b122737).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
process/io/plot_proc.py 1.51% 65 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3967      +/-   ##
==========================================
+ Coverage   45.89%   45.94%   +0.04%     
==========================================
  Files         123      123              
  Lines       29066    29791     +725     
==========================================
+ Hits        13340    13687     +347     
- Misses      15726    16104     +378     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@clmould clmould force-pushed the 3919-binder-for-process-teaching-notebook branch 2 times, most recently from 8d0c8f7 to a9877c4 Compare November 5, 2025 14:27
@clmould clmould requested a review from timothy-nunn November 5, 2025 14:27
Copy link
Collaborator

@timothy-nunn timothy-nunn left a comment

Choose a reason for hiding this comment

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

Image

We need to ensure that the optional examples dependencies are also installed in the binder environment

@clmould clmould requested a review from jonmaddock November 13, 2025 14:03
@jonmaddock jonmaddock removed their request for review December 5, 2025 14:15
@clmould clmould force-pushed the 3919-binder-for-process-teaching-notebook branch 2 times, most recently from 8c26c03 to 8c61f22 Compare December 12, 2025 16:28
@clmould clmould force-pushed the 3919-binder-for-process-teaching-notebook branch from 8c61f22 to 31907e4 Compare December 12, 2025 16:31
# Current drive
# plot_current_drive_info(fig1.add_subplot(236), m_file_data, scan)
fig1.subplots_adjust(wspace=0.25, hspace=0.25)
plot_current_drive_info(figs[1].add_subplot(236), m_file_data, scan)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'm not sure why this was commented out on main ? I can comment back out/remove if needed

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Copy link
Collaborator

Choose a reason for hiding this comment

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

@chris-ashe any idea?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Spoke with @chris-ashe and have commented it back out in this PR

@clmould
Copy link
Collaborator Author

clmould commented Dec 12, 2025

I have removed the need for pdf2image by giving plot_proc an optional argument to produce png output instead of pdf, so the png files can be rendered in examples.ipynb by using %pip install pillow at the start of the notebook. pdf2image relies on poppler-utils which cannot be installed in the binder environment. Now the plot_proc cell runs in the binder:
image

This also solves #3981 :
image

Copy link
Collaborator

@je-cook je-cook left a comment

Choose a reason for hiding this comment

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

A few things here and there but overall looks good

@clmould clmould requested a review from je-cook December 15, 2025 11:19
@clmould clmould requested a review from timothy-nunn December 17, 2025 11:46
Copy link
Collaborator

@timothy-nunn timothy-nunn left a comment

Choose a reason for hiding this comment

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

Happy with the code changes, it works locally.

I need your help testing on binder before I approve

@clmould clmould merged commit a188483 into main Dec 18, 2025
18 checks passed
@timothy-nunn timothy-nunn deleted the 3919-binder-for-process-teaching-notebook branch December 18, 2025 15:58
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.

Binder for PROCESS teaching notebook

5 participants