Make NonlinearSolve.jl an optional dependency #3850
Closed
Conversation
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
- Move NonlinearSolve and SCCNonlinearSolve from direct deps to weakdeps - Create MTKNonlinearSolveExt extension to handle NonlinearSolve functionality - Update linearization to use conditional loading of TrustRegion algorithm - Add error message when NonlinearSolve is required but not loaded This change allows ModelingToolkit to be used without NonlinearSolve.jl as a hard dependency, reducing the dependency footprint for users who don't need nonlinear solving functionality. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| # Export the TrustRegion algorithm for use in linearization | ||
| ModelingToolkit._get_default_nlsolve_alg() = TrustRegion() | ||
|
|
||
| end |
There was a problem hiding this comment.
[JuliaFormatter] reported by reviewdog 🐶
Suggested change
| end | |
| end |
| else | ||
| initialization_solver_alg | ||
| end | ||
|
|
There was a problem hiding this comment.
[JuliaFormatter] reported by reviewdog 🐶
Suggested change
Use single-line function definition for better readability. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
| @@ -379,4 +378,7 @@ PrecompileTools.@compile_workload begin | |||
| end | |||
| end | |||
|
|
|||
| # Default nonlinear solver algorithm - will be overridden by extension when NonlinearSolve is loaded | |||
| _get_default_nlsolve_alg() = error("NonlinearSolve.jl is required for linearization with initialization. Please load NonlinearSolve.jl to use this functionality.") | |||
There was a problem hiding this comment.
[JuliaFormatter] reported by reviewdog 🐶
Suggested change
| _get_default_nlsolve_alg() = error("NonlinearSolve.jl is required for linearization with initialization. Please load NonlinearSolve.jl to use this functionality.") | |
| function _get_default_nlsolve_alg() | |
| error("NonlinearSolve.jl is required for linearization with initialization. Please load NonlinearSolve.jl to use this functionality.") | |
| end |
Benchmark Results (Julia vlts)Time benchmarks
Memory benchmarks
|
Benchmark Results (Julia v1)Time benchmarks
Memory benchmarks
|
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.
Summary
Motivation
This change reduces the dependency footprint of ModelingToolkit for users who don't need nonlinear solving functionality. NonlinearSolve.jl brings in a significant dependency tree, and making it optional allows for faster installation and lighter deployments.
Changes
[weakdeps]sectionext/MTKNonlinearSolveExt/MTKNonlinearSolveExt.jlto load TrustRegion algorithm when NonlinearSolve is availableImpact
Test plan
🤖 Generated with Claude Code