Skip to content

Cap ModelingToolkit to v9 to fix docs build under MTK v11#64

Merged
ChrisRackauckas merged 1 commit into
SciML:mainfrom
ChrisRackauckas-Claude:fix-mtk-v11-docs-compat
Jun 21, 2026
Merged

Cap ModelingToolkit to v9 to fix docs build under MTK v11#64
ChrisRackauckas merged 1 commit into
SciML:mainfrom
ChrisRackauckas-Claude:fix-mtk-v11-docs-compat

Conversation

@ChrisRackauckas-Claude

Copy link
Copy Markdown
Contributor

Problem

The Documentation build on main is failing. The last dependabot bump (#62, "Bump the all-julia-packages group") widened compat across several deps, the critical one being:

-ModelingToolkit = "9"
+ModelingToolkit = "9, 11.26"

This let ModelingToolkit v11.26.8 resolve. MTK v11 is a major breaking release that moved the modeling DSL out of ModelingToolkit core:

  • @mtkmodel and @connector now require SciCompDSL.jl (To use this @connector syntax, please import SciCompDSL.jl)
  • ModelingToolkit.missing_variable_defaults and ModelingToolkit.defaults were removed
  • NewtonRaphson is no longer re-exported by DifferentialEquations (which also jumped to v8)

The course lecture @example blocks are written against the MTK v9 DSL, so the docs build failed across lecture1.md, lecture2.md, lecture6.md and lecture8.md with @mtkmodel / @connector / missing_variable_defaults / defaults UndefVarErrors.

Fix

Revert the #62 dependabot widening, restoring the last-known-green compat (cap ModelingToolkit back to "9" and the other coupled deps to their pre-bump bounds). This is a compat-cap fix; no lecture content is changed.

Local verification

On Julia 1.11 (the version the Documentation workflow pins), Pkg.resolve() of the docs environment now selects the v9-era stack the lectures were authored against:

package resolved
ModelingToolkit 9.15.0
Symbolics 5.28.0
OrdinaryDiffEq 6.74.1
DifferentialEquations 7.13.0
Sundials 4.24.0
ForwardDiff 0.10.39
DataInterpolations 5.0.0
ModelingToolkitStandardLibrary 2.11.0
NonlinearSolve 3.11.0

With MTK 9.15.0 the removed/moved APIs (@mtkmodel, @connector, missing_variable_defaults, defaults) are all present again, and DifferentialEquations 7.13.0 re-exports NewtonRaphson. OrdinaryDiffEq stays pinned at =6.74.1 per the existing note in docs/make.jl.

Please ignore until reviewed by @ChrisRackauckas

The dependabot bump in SciML#62 widened compat to allow ModelingToolkit
v11.26 (and ForwardDiff 1.4, Sundials 6.2, DataInterpolations 8.10,
DifferentialEquations 8.0, OrdinaryDiffEq 7.0, Symbolics 7.26), which
resolved ModelingToolkit v11.26.8. MTK v11 is a major breaking release
that moved the modeling DSL out of ModelingToolkit: `@mtkmodel` and
`@connector` now require SciCompDSL.jl, and `missing_variable_defaults`
and `defaults` were removed. The course lecture `@example` blocks are
written against the MTK v9 DSL, so the Documentation build failed across
lecture1/2/6/8 with `@mtkmodel`/`@connector`/`missing_variable_defaults`
UndefVarErrors and a `NewtonRaphson not defined` error (the latter from
DifferentialEquations v8 no longer re-exporting it).

Revert the SciML#62 dependabot widening, restoring the last-known-green
compat. Locally on Julia 1.11 the docs environment now resolves to
ModelingToolkit 9.15.0, Symbolics 5.28.0, OrdinaryDiffEq 6.74.1,
DifferentialEquations 7.13.0, Sundials 4.24.0, ForwardDiff 0.10.39,
DataInterpolations 5.0.0, ModelingToolkitStandardLibrary 2.11.0 - the
v9-era stack the lectures were authored against. OrdinaryDiffEq is kept
pinned to =6.74.1 per the existing note in docs/make.jl.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@ChrisRackauckas ChrisRackauckas marked this pull request as ready for review June 21, 2026 11:29
@ChrisRackauckas ChrisRackauckas merged commit 8758938 into SciML:main Jun 21, 2026
5 of 6 checks passed
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.

3 participants