Skip to content

Fix markdown syntax errors and document repeat parameter in Ensembles.md #1143

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 9, 2025
Merged

Fix markdown syntax errors and document repeat parameter in Ensembles.md #1143

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions docs/src/interfaces/Ensembles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ SciMLBase.EnsembleAnalysis.componentwise_vectors_timepoint

The available functions for time steps are:

```docs
```@docs
SciMLBase.EnsembleAnalysis.timestep_mean
SciMLBase.EnsembleAnalysis.timestep_median
SciMLBase.EnsembleAnalysis.timestep_quantile
Expand Down Expand Up @@ -151,14 +151,15 @@ timeseries_steps_weighted_meancov

The available functions for the time points are:

```docs
```@docs
SciMLBase.EnsembleAnalysis.timeseries_point_mean
SciMLBase.EnsembleAnalysis.timeseries_point_median
SciMLBase.EnsembleAnalysis.timeseries_point_quantile
SciMLBase.EnsembleAnalysis.timeseries_point_meanvar
SciMLBase.EnsembleAnalysis.timeseries_point_meancov
SciMLBase.EnsembleAnalysis.timeseries_point_meancor
SciMLBase.EnsembleAnalysis.timeseries_point_weighted_meancov
```

### EnsembleSummary

Expand Down Expand Up @@ -197,6 +198,12 @@ prob = ODEProblem((u, p, t) -> 1.01u, 0.5, (0.0, 1.0))
For our ensemble simulation, we would like to change the initial condition around.
This is done through the `prob_func`. This function takes in the base problem
and modifies it to create the new problem that the trajectory actually solves.
The `prob_func` has the signature `prob_func(prob, i, repeat)` where:

- `prob` is the base problem to be modified
- `i` is the unique trajectory index (`1` to `trajectories`)
- `repeat` is the repeat iteration number (starts at `1`, increments if `output_func` returned `rerun=true`)

Here, we will take the base problem, multiply the initial condition by a `rand()`,
and use that for calculating the trajectory:

Expand Down
Loading