remove multirate=true argument from run! and infer it in ModelMapping

and update tests + doc

Author: VEZY

docs/src/API/API_public.md

@@ -60,14 +60,13 @@ Scope selection detail:
 ```julia
 req_hold = OutputRequest("Leaf", :A; name=:A_hourly, process=:assim, policy=HoldLast())
 req_day = OutputRequest("Leaf", :A; name=:A_daily_sum, process=:assim, policy=Integrate(), clock=ClockSpec(24.0, 1.0))
-run!(sim, meteo; multirate=true, tracked_outputs=[req_hold, req_day], executor=SequentialEx())
+run!(sim, meteo; tracked_outputs=[req_hold, req_day], executor=SequentialEx())
 out = collect_outputs(sim; sink=DataFrame)
 
 # or directly:
 out_status, out = run!(
     sim,
     meteo;
-    multirate=true,
     tracked_outputs=[req_hold, req_day],
     return_requested_outputs=true,
 )

docs/src/model_execution.md

@@ -131,7 +131,7 @@ mapping = ModelMapping(
 )
 ```
 
-When `multirate=true` is passed to `run!`, the runtime resolves inputs from producer temporal streams according to these policies.
+When the `ModelMapping` declares multirate configuration, the runtime resolves inputs from producer temporal streams according to these policies.
 Meteo rows are also sampled at each model clock. By default, meteo variables are aggregated from
 the finest weather step (for example `T` and `Rh` as weighted means, `Tmin/Tmax`, and radiation
 quantity aliases such as `Ri_SW_q` in MJ m-2). You can override these rules with `MeteoBindings(...)`
@@ -154,7 +154,7 @@ req = OutputRequest("Leaf", :carbon_assimilation;
     clock=ClockSpec(24.0, 1.0)
 )
 
-run!(sim, meteo; multirate=true, tracked_outputs=[req], executor=SequentialEx())
+run!(sim, meteo; tracked_outputs=[req], executor=SequentialEx())
 exported = collect_outputs(sim; sink=DataFrame)
 ```
 
@@ -165,7 +165,6 @@ You can also return them directly from `run!`:
 out_status, exported = run!(
     sim,
     meteo;
-    multirate=true,
     tracked_outputs=[req],
     return_requested_outputs=true,
 )

docs/src/multirate/multirate_tutorial.md

@@ -173,7 +173,6 @@ req_plant_weekly = OutputRequest("Plant", :plant_assim_w;
 out_status, exported = run!(
     sim,
     meteo_hourly;
-    multirate=true,
     executor=SequentialEx(),
     tracked_outputs=[req_leaf_hourly, req_plant_daily, req_plant_daily_T, req_plant_weekly],
     return_requested_outputs=true,

docs/src/planned_features.md

@@ -5,7 +5,7 @@
 ### Varying timesteps
 
 Model-level varying timesteps are now available experimentally for MTG simulations
-through multi-rate execution (`multirate=true`) and mapping-level `ModelSpec` transforms
+through mapping-declared multi-rate execution and mapping-level `ModelSpec` transforms
 such as `TimeStepModel`, `InputBindings`, `OutputRouting`, and `ScopeModel`.
 
 Current remaining gaps for this area are:

src/mtg/GraphSimulation.jl

@@ -31,6 +31,7 @@ struct GraphSimulation{T,S,U,O,V,TS,MS}
     outputs::Dict{String,O}
     outputs_index::Dict{String, Int}
     temporal_state::TS
+    is_multirate::Bool
 end
 
 function GraphSimulation(graph, mapping; nsteps=1, outputs=nothing, type_promotion=nothing, check=true, verbose=false)
@@ -47,6 +48,7 @@ get_models(g::GraphSimulation) = g.models
 get_model_specs(g::GraphSimulation) = g.model_specs
 outputs(g::GraphSimulation) = g.outputs
 temporal_state(g::GraphSimulation) = g.temporal_state
+is_multirate(g::GraphSimulation) = g.is_multirate
 
 """
     convert_outputs(sim_outputs::Dict{String,O} where O, sink; refvectors=false, no_value=nothing)

src/mtg/initialisation.jl

@@ -315,7 +315,11 @@ function init_simulation(mtg, mapping; nsteps=1, outputs=nothing, type_promotion
     end
 
     models = Dict(first(m) => parse_models(get_models(last(m))) for m in mapping)
-    model_specs = Dict(first(m) => parse_model_specs(last(m)) for m in mapping)
+    model_specs = if mapping isa ModelMapping && !isempty(mapping.info.model_specs)
+        deepcopy(mapping.info.model_specs)
+    else
+        Dict(first(m) => parse_model_specs(last(m)) for m in mapping)
+    end
     scale_reachability = _scale_reachability_from_mtg(mtg)
     infer_model_specs_configuration!(model_specs; scale_reachability=scale_reachability)
     validate_model_specs_configuration(model_specs)
@@ -356,5 +360,19 @@ function init_simulation(mtg, mapping; nsteps=1, outputs=nothing, type_promotion
 
     outputs_index = Dict{String, Int}(s => 1 for s in keys(outputs))
     temporal_state = TemporalState()
-    return (; mtg, statuses, status_templates, reverse_multiscale_mapping, vars_need_init, dependency_graph=dep_graph, models, model_specs, outputs, outputs_index, temporal_state)
+    mapping_is_multirate = mapping isa ModelMapping ? is_multirate(mapping) : false
+    return (;
+        mtg,
+        statuses,
+        status_templates,
+        reverse_multiscale_mapping,
+        vars_need_init,
+        dependency_graph=dep_graph,
+        models,
+        model_specs,
+        outputs,
+        outputs_index,
+        temporal_state,
+        is_multirate=mapping_is_multirate
+    )
 end