Improve Colab launch behavior and README landing documentation - #33
Merged
Conversation
VCUclse405
approved these changes
May 27, 2026
VCUclse405
approved these changes
May 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request
Summary
This pull request improves the public launch and documentation experience for the Peel Trace Evaluation for Soft Substrates repository. It adds Colab-safe notebook bootstrap behavior, revises the README landing/quick-start sections, adds a representative README QC plot, updates documentation indexing, and corrects notebook text-encoding artifacts.
The manuscript-baseline analysis method is unchanged.
Type of change
Select all that apply.
What changed?
README.mdwith a clearer landing section, badges, manuscript-baseline release line, and separated Binder/Colab/local quick-start instructions.Peel_Trace_Evaluation_for_Soft_Substrates.ipynbStep 0 with Colab-safe bootstrap logic.requirements.txtstack inside Colab to prevent NumPy/SciPy runtime mismatch errors.docs/example_outputs/scotch_tape_qc_trace.png.docs/example_outputs/.docs/README.mdto document the new visual asset.CHANGELOG.mdwith a sortedUnreleasedsection separating post-v1.4.0-rc15changes from the archivedv1.4.0-rc15release state.Why is this change needed?
Colab often opens only the notebook file rather than the full GitHub repository, which can cause the backend module import to fail. The updated Step 0 logic makes Colab behave more like Binder by automatically cloning the repository when needed.
The README updates improve first-screen clarity for new users while preserving the repository’s reproducibility framing. The example QC plot gives visitors a direct visual sense of what the workflow exports. The changelog update also separates already archived
v1.4.0-rc15release contents from newer post-release repository improvements.Reproducibility impact
Does this pull request affect any of the following?
If any item is checked, briefly explain the impact.
The checked items are documentation-facing only. A representative QC plot was added as a README display asset, and the changelog/release-history documentation was reorganized to separate post-
v1.4.0-rc15changes from the archived release section.This PR does not change input data, preprocessing, metric definitions, analysis settings, validation thresholds, backend calculations, dependency versions, or manuscript-baseline outputs.
Testing / verification
For notebook changes, complete the relevant checks below:
Additional notes:
Step 0 was tested in a clean Google Colab runtime. The notebook successfully cloned the repository automatically and imported
fabric_peel_guided_core_v1_4_0_rc15.pywithout runningpip install -r requirements.txtinside Colab.Step 1 Scotch Tape reference validation should be run before merge if it has not already been run after the final notebook save.
Manuscript or public-release relevance
For manuscript-linked repositories, state whether this change affects submitted, published, or archived results.
Explanation:
This PR does not change the manuscript-baseline method, backend calculations, metric definitions, analysis thresholds, validation thresholds, input data, or generated manuscript-baseline outputs. It improves README presentation, Colab launch behavior, documentation organization, and notebook text readability.
The existing
v1.4.0-rc15release/archive remains historically unchanged. New post-release changes are documented underUnreleasedinCHANGELOG.md.Checklist