docs: prepare 2.1.2 release notes and re-execute the ICA and batch tutorials - #870
Merged
Conversation
…h tutorials Turn the flat [Unreleased] list in HISTORY.md into a real [2.1.2] section grouped by theme, folding in the interim v2.1.1.post7 / post8 tags and the v2.1.2a1-a4 pre-releases, then fix the documentation errors found while reviewing it. The Incremental capacity analysis and Batch processing tutorials taught API that was removed in 2.1 and could not be run as written; the batch page failed on its very first configuration cell, because prms.Paths no longer exists. Since the published .md pages are generated from the notebooks by dev/render_example_notebooks.py, editing them directly would not have survived the next render, so the fixes were made in the .ipynb sources. Both notebooks were then executed (against the vendored paper01 dataset and example_data) and the markdown regenerated, so every code cell, table and figure is real output again. Executing the notebooks surfaced three breakages that reading them had not: paper01 has no ir_charge column, so the second summary subplot now plots coulombic efficiency; get_cap returns potential rather than voltage; and b.summaries is a long-format polars frame, which does not support attribute column access. Also correct the pandas-only framing in the fundamentals page, nine factual errors in the About loaders section of the developers guide, and the "deprecated, removal in 2.1" wording in the migration guides for API that has since been removed. The separate, still-stale top-level examples/ notebook tree is tracked in #869. Closes #866 Co-authored-by: Cursor <cursoragent@cursor.com>
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
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.
Release prep for v2.1.2: the changelog, plus the documentation errors found while reviewing it.
What changed
HISTORY.md. The flat[Unreleased]list is now a real## [2.1.2] - 2026-08-09section, grouped by theme, with a lead paragraph noting that the interimv2.1.1.post7/v2.1.1.post8tags and thev2.1.2a1–a4pre-releases fold into it. Coverage was checked againstgit log v2.1.1.post6..master; nothing invented or dropped.Two tutorials rewritten and re-executed. Incremental capacity analysis and Batch processing taught API removed in 2.1 and could not be run as written — the batch page failed on its very first configuration cell, since
prms.Pathsdoes not exist in 2.x.The published
.mdpages are generated from the notebooks bydev/render_example_notebooks.py, so editing them directly would not have survived the next render. The fixes were made in the.ipynbsources; both notebooks were then executed, their plotly figures backfilled to PNG, and the markdown regenerated through the official script. Every code cell, table and figure on those pages is now real output.Migrations applied:
prms.Paths.<name>cellpy.config.paths.<name>collectors.Batch*Collector+.show()cellpy.collectcollectors +.plot()ica.dqdv_cycle/dqdv_cycles/dqdv_npica.dqdv(three input forms)y="dq"y="dqdv"get_cap().voltageget_cap().potentialb.summaries.<col>b.summaries.pivot(...)(long-format polars)Executing the notebooks — rather than only reading them — surfaced three breakages that a code review had missed: paper01 has no
ir_chargecolumn (the second summary subplot now plots coulombic efficiency),get_capreturnspotentialnotvoltage, andb.summariesis a polars frame without attribute column access.Other documentation fixes. The pandas-only framing in The fundamentals of cellpy (pandas per-cell, polars in
cellpy.collect, parquet on disk); nine factual errors in the About loaders developers-guide section; and "deprecated, removal in 2.1" wording in the migration guides for API that has since been removed.How to test
uv run pytest -m essential— 703 passed, 1 skipped locally.uv run --group docs python dev/render_example_notebooks.pyleaves the other seven example pages byte-identical.docs/examples/batch_utility/out/tree.Notes for reviewers
*_1.png→*_0.pngrenames in the batch figures are output-index renumbering from re-execution, not lost figures — the page still has all eight.metadata/execution_countkeys from output records, which makesnbconvertrefuse the file; the committed notebooks already had this defect and it was repaired.examples/notebook tree is not touched here — tracked in Top-level examples/ notebooks still use removed 1.x API #869.Closes #866
Made with Cursor