Skip to content

doc: Add PEtab v1 to v2 migration guide - #683

Open
dweindl wants to merge 2 commits into
mainfrom
doc-migration-guide
Open

dweindl wants to merge 2 commits into
mainfrom
doc-migration-guide

Conversation

@dweindl

@dweindl dweindl commented Oct 19, 2026 •

Copy link
Copy Markdown
Member

Adds a non-normative page "Upgrading from PEtab v1" to the v2 documentation (doc/v2/migration_guide.rst, linked from the v2 toctree after the tutorial).

Contents: a quick path for the typical case; the structural changes (handled by petab1to2) and what has to be done by hand; the numerical consequences of removing parameterScale, i.e., how PEtab v1 tools evaluated priors on log-scaled parameters (D2D, pyPESTO, libpetab-python at pinned commits), what PEtab v2 specifies, and why a faithful conversion reparametrizes log-scaled parameters as log10_k with k = 10^log10_k in the model; the step-by-step reparametrization recipe including measurement-table placeholders; the reparametrize option of petab1to2; the other changes affecting objective values (log10 observables, truncated priors, default prior); and a verification procedure.

Also allows line breaks in table cells (doc/_static/custom.css), since the RTD theme's nowrap made wider tables scroll horizontally.

The spec page is not modified. Infinite bounds follow erratum E1 (#684). The petab1to2 section describes petab.v2.reparametrize_log (PEtab-dev/libpetab-python#560, merged) and petab1to2(reparametrize=...) (PEtab-dev/libpetab-python#539, not merged yet; the option names may still change there). A second page on comparing objective values across tools will follow in a separate PR.

References #680.

🤖 Generated with Claude Code

👀 https://petab--683.org.readthedocs.build/en/683/v2/migration_guide.html

@dweindl dweindl self-assigned this Oct 19, 2026
@dweindl
dweindl force-pushed the doc-migration-guide branch 2 times, most recently from d3634c4 to 6f027e9 Compare October 21, 2026 14:19
@dweindl
dweindl force-pushed the doc-migration-guide branch 8 times, most recently from e25b048 to a8fccef Compare October 21, 2026 19:48
dweindl and others added 2 commits October 21, 2026 21:51
Add a non-normative page "Upgrading from PEtab v1" to the v2
documentation. It lists the structural changes, explains the numerical
consequences of the removal of `parameterScale`, describes how to
reparametrize log-scaled parameters (`log10_k` with `k = 10^log10_k`),
the `reparametrize` option of `petab1to2`, the other changes affecting
objective values (log10 observables, truncated priors, default prior),
and how to verify a conversion.

References #680.
The `petab1to2` section describes PEtab-dev/libpetab-python#539.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
The sphinx_rtd_theme sets `white-space: nowrap` on all table cells,
which makes tables with longer text, such as the structural changes
table in the migration guide, require horizontal scrolling. Override
this in `custom.css` so that cell contents wrap.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@dweindl
dweindl force-pushed the doc-migration-guide branch from a8fccef to c45e978 Compare October 21, 2026 19:51
@dweindl
dweindl marked this pull request as ready for review October 21, 2026 20:08
@dweindl
dweindl requested a review from a team as a code owner October 21, 2026 20:08
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.

1 participant