Skip to content

Proposed V16 README and index page updates#1432

Merged
TorkelE merged 15 commits intoSciML:masterfrom
isaacsas:readme_updates
Mar 6, 2026
Merged

Proposed V16 README and index page updates#1432
TorkelE merged 15 commits intoSciML:masterfrom
isaacsas:readme_updates

Conversation

@isaacsas
Copy link
Member

@isaacsas isaacsas commented Mar 5, 2026

No description provided.

isaacsas and others added 7 commits February 26, 2026 12:02
- Replace reusable Test workflow call with local jobs and add a per-version single-writer cache prewarm job using actions/cache restore/save
- Make test matrix jobs restore read-only from prewarmed caches to reduce cache write contention
- Update Extensions cache keying to explicit per-version cache names
- Upload Codecov on pushes and same-repo PRs in Test and Extensions workflows
- Refresh README status badges for Tests, Extensions, Documentation, and Codecov
The hashFiles('Project.toml', 'Manifest.toml', 'test/Manifest.toml')
produced different hashes before vs after julia-buildpkg because
Manifest.toml is gitignored and only exists after Pkg.instantiate().
This caused prewarm to save with one key and test jobs to look for
another, so caches were never restored.

Fix by computing the deps hash once from Project.toml (which is in git)
before buildpkg runs, passing it as a job output from prewarm to tests.
Bump cache key prefix to v2 to avoid stale entries.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Rewrite README with updated hero description, "What's new in v16" section,
condensed features list, new SDE example with @brownians, ecosystem table,
and fixed documentation links. Update docs/src/index.md analogously with
@ref links for API-documented functions. Add Turing.jl, Plots.jl, and
Makie.jl to ecosystem tables. Regenerate SDE plot SVG for example 3.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Rewrite README with updated hero description, "What's new in v16" section,
condensed features list, new SDE example with @brownians, ecosystem table,
and fixed documentation links. Update docs/src/index.md analogously with
@ref links for API-documented functions. Add Turing.jl, Plots.jl, and
Makie.jl to ecosystem tables. Regenerate SDE plot SVG for example 3.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@isaacsas isaacsas requested a review from TorkelE March 5, 2026 16:59
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@isaacsas isaacsas closed this Mar 5, 2026
@isaacsas isaacsas reopened this Mar 5, 2026
@isaacsas isaacsas closed this Mar 5, 2026
@isaacsas isaacsas reopened this Mar 5, 2026
isaacsas and others added 5 commits March 5, 2026 13:40
…dex.md

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
… docs

- Fix ~10 broken @ref links pointing to nonexistent constraint_equations
  anchors; redirect to coupled_models, coupled_models_dsl, or
  conservation_laws as appropriate
- Remove unnecessary mtkcompile=true from README/index.md SDE examples
  (brownians auto-enable it)
- Add @docs blocks for ode_model, sde_model, jump_model, ss_ode_model,
  hybrid_model in core_api.md
- Update ModelingToolkit references to ModelingToolkitBase where appropriate
- Fix @brownian typo to @brownians in FAQs
- Remove stale DiscreteProblem line from spatial jump tutorial
- Remove outdated latexify SDE bug note
- Fix Base.convert text to reference ode_model in introduction tutorial
- Update remake call syntax in interactive Brusselator example

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
…l docs

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Copy link
Member

@TorkelE TorkelE left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was quite fond of the previous README/Index, and this is a clear improvement, really like it!

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@TorkelE TorkelE merged commit d99b3cc into SciML:master Mar 6, 2026
17 of 19 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.

2 participants