Skip to content

Commit 6f1a1d0

Browse files
Merge pull request #1143 from ChrisRackauckas-Claude/fix-ensemble-docs-markdown-1141
Fix markdown syntax errors and document repeat parameter in Ensembles.md
2 parents f232bea + dd4d441 commit 6f1a1d0

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

docs/src/interfaces/Ensembles.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ SciMLBase.EnsembleAnalysis.componentwise_vectors_timepoint
108108

109109
The available functions for time steps are:
110110

111-
```docs
111+
```@docs
112112
SciMLBase.EnsembleAnalysis.timestep_mean
113113
SciMLBase.EnsembleAnalysis.timestep_median
114114
SciMLBase.EnsembleAnalysis.timestep_quantile
@@ -151,14 +151,15 @@ timeseries_steps_weighted_meancov
151151

152152
The available functions for the time points are:
153153

154-
```docs
154+
```@docs
155155
SciMLBase.EnsembleAnalysis.timeseries_point_mean
156156
SciMLBase.EnsembleAnalysis.timeseries_point_median
157157
SciMLBase.EnsembleAnalysis.timeseries_point_quantile
158158
SciMLBase.EnsembleAnalysis.timeseries_point_meanvar
159159
SciMLBase.EnsembleAnalysis.timeseries_point_meancov
160160
SciMLBase.EnsembleAnalysis.timeseries_point_meancor
161161
SciMLBase.EnsembleAnalysis.timeseries_point_weighted_meancov
162+
```
162163

163164
### EnsembleSummary
164165

@@ -197,6 +198,12 @@ prob = ODEProblem((u, p, t) -> 1.01u, 0.5, (0.0, 1.0))
197198
For our ensemble simulation, we would like to change the initial condition around.
198199
This is done through the `prob_func`. This function takes in the base problem
199200
and modifies it to create the new problem that the trajectory actually solves.
201+
The `prob_func` has the signature `prob_func(prob, i, repeat)` where:
202+
203+
- `prob` is the base problem to be modified
204+
- `i` is the unique trajectory index (`1` to `trajectories`)
205+
- `repeat` is the repeat iteration number (starts at `1`, increments if `output_func` returned `rerun=true`)
206+
200207
Here, we will take the base problem, multiply the initial condition by a `rand()`,
201208
and use that for calculating the trajectory:
202209

0 commit comments

Comments
 (0)