DiffEqDocs.jl icon indicating copy to clipboard operation
DiffEqDocs.jl copied to clipboard

Improved docs for EnsembleProblem

Open baggepinnen opened this issue 2 years ago • 2 comments

Looking into the advanced features of the EnsembleProblem, I find it hard to understand what the u, data and I arguments for the reduction function are. https://docs.sciml.ai/DiffEqDocs/latest/features/ensemble/#Performing-an-Ensemble-Simulation It would also be nice if slightly more informative docstrings were available

help?> EnsembleProblem
search: EnsembleProblem

  struct EnsembleProblem{T, T2, T3, T4, T5} <: SciMLBase.AbstractEnsembleProblem

baggepinnen avatar Mar 02 '23 11:03 baggepinnen

Hi! I'd like to take on this issue.

I'll work on improving the documentation for the 'reduction' function in ensemble simulations and enhance the docstring of 'EnsembleProblem' for clarity. Planning to add clearer explanations for 'u', 'data', and 'I', and improve the docstring content with examples.

@SciML Let me know if this sounds good or if there's anything I should be aware of before proceeding.

Zf98ai avatar Apr 16 '25 17:04 Zf98ai

Those are definitely needed.

ChrisRackauckas avatar Apr 16 '25 17:04 ChrisRackauckas