Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs v7 rework #2317

Merged
merged 83 commits into from
Aug 26, 2024
Merged

docs v7 rework #2317

merged 83 commits into from
Aug 26, 2024

Conversation

ArnoStrouwen
Copy link
Member

Is this template what you had in mind @ChrisRackauckas?

@ChrisRackauckas
Copy link
Member

Yes exactly.

@ArnoStrouwen
Copy link
Member Author

I came up with a way to automate the same example over all the libs, but it's a pretty ugly hack.

@ChrisRackauckas
Copy link
Member

Looks like it works, I'll take it.

@ArnoStrouwen
Copy link
Member Author

The current dev version of docs removed documentation about threading, while this is still there on stable. Is this a regression?
dev
stable

@ChrisRackauckas
Copy link
Member

That's a regression

@ArnoStrouwen
Copy link
Member Author

Are the Anas* methods really OrdinaryDiffEqAlgorithm and not OrdinaryDiffEqAdaptiveAlgorithm?
Same question for:

RKO65
RKM
MSRK*
PSRK*
Alshina6

@ChrisRackauckas
Copy link
Member

Are the Anas* methods really OrdinaryDiffEqAlgorithm and not OrdinaryDiffEqAdaptiveAlgorithm?

IIRc they are non-adaptive. You can check the perform_step! on whether they calculate an EEst.

@ArnoStrouwen
Copy link
Member Author

How does HighOrderRK fit into the story? If I understand correctly, the recommended solver page skips over them in favor of Vern for lower tolerances.

@ChrisRackauckas
Copy link
Member

Yes they aren't recommended for most things. DP8 is legacy fallback to dop853 but Verner is just generally better unless you really need a non-lazy interpolation.

@ArnoStrouwen
Copy link
Member Author

AB5: Adams-Bashforth Explicit Method
The 3-step third order multistep method. Ralston's Second Order Method is used to calculate starting values.
"""
struct AB5 <: OrdinaryDiffEqAlgorithm end

Seems weird to me the 5 from AB5 does not occur anywhere in the description.

@ChrisRackauckas
Copy link
Member

Seems weird to me the 5 from AB5 does not occur anywhere in the description.

5th Order Adams-Bashforth method. History is prestarted using Ralston's 3rd order Runge-Kutta method.

@ArnoStrouwen
Copy link
Member Author

I'm not sure what of this JVODE stuff needs a docstring:

struct JVODE{bType, aType} <: OrdinaryDiffEqAdamsVarOrderVarStepAlgorithm
algorithm::Symbol
bias1::bType
bias2::bType
bias3::bType
addon::aType
end
function JVODE(algorithm = :Adams; bias1 = 6, bias2 = 6, bias3 = 10,
addon = 1 // 10^6)
JVODE(algorithm, bias1, bias2, bias3, addon)
end
JVODE_Adams(; kwargs...) = JVODE(:Adams; kwargs...)
JVODE_BDF(; kwargs...) = JVODE(:BDF; kwargs...)

And even less sure what then should be in that string.

@ChrisRackauckas
Copy link
Member

It should have a warning as experimental. JVODE is an adaptive BDF implementation in Nordsieck form, similar to VODE. However, FBDF is recommended in almost all scenarios, and so this is more of a development artifact.

@ChrisRackauckas ChrisRackauckas mentioned this pull request Aug 12, 2024
8 tasks
@ChrisRackauckas
Copy link
Member

We should also audit to ensure that every algorithm has its source reference in the docstring. I think almost all do, but a few may be missing some.

@ArnoStrouwen
Copy link
Member Author

@mortenpi we have some large pages in these docs. On Windows I need to do size_threshold_ignore = ["implicit\\Rosenbrock.md"]), instead of size_threshold_ignore = ["implicit/Rosenbrock.md"]), is this expected behavior?

@mortenpi
Copy link

On Windows I need to do size_threshold_ignore = ["implicit\\Rosenbrock.md"]), instead of size_threshold_ignore = ["implicit/Rosenbrock.md"]), is this expected behavior?

No. We should be normalizing the paths so they work cross-platform. Do you mind opening an issue?

Just to clarify: if you use the Unix-y path ("implicit/Rosenbrock.md"), it then doesn't work on Windows, right? A workaround you can do to get the PR passing would be to set is as joinpath("implicit", "Rosenbrock.md").

@@ -334,10 +367,19 @@ function KYKSSPRK42(stage_limiter!, step_limiter! = trivial_limiter!)
False())
end

@doc explicit_rk_docstring("TBD",
Copy link
Member

Choose a reason for hiding this comment

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

Looks like this got deleted.

"KYKSSPRK42")
@doc explicit_rk_docstring(
"Low dissipation and dispersion Runge-Kutta schemes for computational acoustics",
"SHLDDRK_2N",
Copy link
Member

@ChrisRackauckas ChrisRackauckas Aug 26, 2024

Choose a reason for hiding this comment

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

This should have been moved to low storage RK.

@ChrisRackauckas ChrisRackauckas merged commit 7aeb38b into SciML:master Aug 26, 2024
49 of 60 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.

4 participants