You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+31Lines changed: 31 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,37 @@ All notable changes to this repository are documented here.
4
4
5
5
This changelog is for software, notebook-interface, documentation, and repository-structure changes. The manuscript-baseline method profile should not be changed without explicit versioning and disclosure.
6
6
7
+
## Unreleased
8
+
9
+
### Method status
10
+
11
+
- Manuscript-baseline calculations are unchanged.
12
+
- No metric definitions, preprocessing settings, analysis thresholds, validation thresholds, or backend calculations were changed.
13
+
- This update improves repository usability, Colab launch behavior, README first-screen clarity, README visual documentation, and notebook text readability only.
14
+
15
+
### Added
16
+
17
+
- Added a Google Colab badge to the README.
18
+
- Added Google Colab quick-start instructions explaining that Step 0 automatically clones the repository when the backend file is missing.
19
+
- Added Colab-safe Step 0 bootstrap logic to the notebook so Colab can load the backend module without requiring manual repository setup.
20
+
- Added a representative QC plot under `docs/example_outputs/scotch_tape_qc_trace.png`.
21
+
- Added an Example outputs section to the README showing a processed peel trace, selected analysis window, Top5/Bot5 extraction points, force descriptors, and QC diagnostics.
22
+
- Documented the new README visual asset in `docs/README.md`.
23
+
24
+
### Changed
25
+
26
+
- Simplified the README title by moving `v1.4.0-rc15` from the main heading into a separate manuscript-baseline release line.
27
+
- Revised the README opening description to frame the repository as a multi-criteria peel-trace analysis workflow for soft substrates.
28
+
- Updated the README Quick start section to separate Binder, Colab, and local execution paths.
29
+
- Updated the README repository layout tree to include `docs/example_outputs/`.
30
+
- Cleaned notebook text-encoding artifacts in displayed markdown and UI labels, including corrupted dash, multiplication, inequality, registered-trademark, bullet, and stick–slip symbols.
31
+
32
+
### Notes
33
+
34
+
- In Colab, the notebook intentionally does not force-install the full `requirements.txt` file because replacing NumPy/SciPy inside an active Colab runtime can cause package mismatch errors.
35
+
- Binder and local installations continue to use the repository environment and `requirements.txt`.
36
+
- The new example QC image is a README display asset and does not change the analysis workflow or generated manuscript-baseline outputs.
0 commit comments