Merge remote-tracking branch 'origin/main' into Mapping-rework-experimentation

Author: Samuel-amap

.github/workflows/Benchmarks.yml

@@ -15,6 +15,7 @@ jobs:
       matrix:
         version:
           - "1"
+          - "1.10"
         os:
           - ubuntu-latest
         arch:

src/dependencies/dependencies.jl

@@ -99,3 +99,31 @@ end
 function dep(m::NamedTuple, nsteps=1; verbose::Bool=true)
     dep(nsteps; verbose=verbose, m...)
 end
+
+function dep(mapping::Dict{String,T}; verbose::Bool=true) where {T}
+    # First step, get the hard-dependency graph and create SoftDependencyNodes for each hard-dependency root. In other word, we want 
+    # only the nodes that are not hard-dependency of other nodes. These nodes are taken as roots for the soft-dependency graph because they
+    # are independant.
+    soft_dep_graphs_roots, hard_dep_dict = hard_dependencies(mapping; verbose=verbose)
+    
+    mapped_vars = mapped_variables(mapping, soft_dep_graphs_roots, verbose=false)
+    reverse_multiscale_mapping = reverse_mapping(mapped_vars, all=false)
+    
+    # Second step, compute the soft-dependency graph between SoftDependencyNodes computed in the first step. To do so, we search the 
+    # inputs of each process into the outputs of the other processes, at the same scale, but also between scales. Then we keep only the
+    # nodes that have no soft-dependencies, and we set them as root nodes of the soft-dependency graph. The other nodes are set as children
+    # of the nodes that they depend on.
+    dep_graph = soft_dependencies_multiscale(soft_dep_graphs_roots, reverse_multiscale_mapping, hard_dep_dict)
+    # During the building of the soft-dependency graph, we identified the inputs and outputs of each dependency node, 
+    # and also defined **inputs** as MappedVar if they are multiscale, i.e. if they take their values from another scale.
+    # What we are missing is that we need to also define **outputs** as multiscale if they are needed by another scale.
+
+    # Checking that the graph is acyclic:
+    iscyclic, cycle_vec = is_graph_cyclic(dep_graph; warn=false)
+    # Note: we could do that in `soft_dependencies_multiscale` but we prefer to keep the function as simple as possible, and 
+    # usable on its own.
+
+    iscyclic && error("Cyclic dependency detected in the graph. Cycle: \n $(print_cycle(cycle_vec)) \n You can break the cycle using the `PreviousTimeStep` variable in the mapping.")
+    # Third step, we identify which 
+    return dep_graph
+end

src/mtg/initialisation.jl

@@ -21,7 +21,7 @@ a dictionary of variables that need to be initialised or computed by other model
 
 `(;statuses, status_templates, reverse_multiscale_mapping, vars_need_init, nodes_with_models)`
 """
-function init_statuses(mtg, mapping, dependency_graph#=first(hard_dependencies(mapping; verbose=false, orchestrator=Orchestrator()))=#; type_promotion=nothing, verbose=false, check=true, orchestrator=Orchestrator())
+function init_statuses(mtg, mapping, dependency_graph=first(hard_dependencies(mapping; verbose=false, orchestrator=Orchestrator())); type_promotion=nothing, verbose=false, check=true, orchestrator=Orchestrator())
     # We compute the variables mapping for each scale:
     mapped_vars = mapped_variables(mapping, dependency_graph, verbose=verbose,orchestrator=orchestrator)
 
@@ -340,6 +340,26 @@ function init_simulation(mtg, mapping; nsteps=1, outputs=nothing, type_promotion
         init_statuses(mtg, mapping, soft_dep_graph_roots; type_promotion=type_promotion, verbose=verbose, check=check, orchestrator=orchestrator)
 
 
+    # First step, get the hard-dependency graph and create SoftDependencyNodes for each hard-dependency root. In other word, we want 
+    # only the nodes that are not hard-dependency of other nodes. These nodes are taken as roots for the soft-dependency graph because they
+    # are independant.
+    # Second step, compute the soft-dependency graph between SoftDependencyNodes computed in the first step. To do so, we search the 
+    # inputs of each process into the outputs of the other processes, at the same scale, but also between scales. Then we keep only the
+    # nodes that have no soft-dependencies, and we set them as root nodes of the soft-dependency graph. The other nodes are set as children
+    # of the nodes that they depend on.
+    dep_graph = soft_dependencies_multiscale(soft_dep_graphs_roots, reverse_multiscale_mapping, hard_dep_dict)
+    # During the building of the soft-dependency graph, we identified the inputs and outputs of each dependency node, 
+    # and also defined **inputs** as MappedVar if they are multiscale, i.e. if they take their values from another scale.
+    # What we are missing is that we need to also define **outputs** as multiscale if they are needed by another scale.
+
+    # Checking that the graph is acyclic:
+    iscyclic, cycle_vec = is_graph_cyclic(dep_graph; warn=false)
+    # Note: we could do that in `soft_dependencies_multiscale` but we prefer to keep the function as simple as possible, and 
+    # usable on its own.
+
+    iscyclic && error("Cyclic dependency detected in the graph. Cycle: \n $(print_cycle(cycle_vec)) \n You can break the cycle using the `PreviousTimeStep` variable in the mapping.")
+    # Third step, we identify which 
+    
     # Print an info if models are declared for nodes that don't exist in the MTG:
     if check && any(x -> length(last(x)) == 0, statuses)
         model_no_node = join(findall(x -> length(x) == 0, statuses), ", ")

src/run.jl

@@ -400,7 +400,7 @@ function run!(
     executor=ThreadedEx()
 )
 
-    dep_graph = dep(object)
+    dep_graph = object.dependency_graph
     models = get_models(object)
     # st = status(object)
 

test/test-mtg-multiscale.jl

@@ -127,8 +127,10 @@ end
 end
 
 @testset "Status initialisation" begin
-    @test_throws "Variable `carbon_biomass` is not computed by any model, not initialised by the user in the status, and not found in the MTG at scale Internode (checked for MTG node 4)." PlantSimEngine.init_statuses(mtg, mapping_1)
-    organs_statuses, others = PlantSimEngine.init_statuses(mtg_init, mapping_1)
+    # Samuel : internal function, suppressing REPL display errors
+    hard_dep_graph = first(PlantSimEngine.hard_dependencies(mapping_1; verbose=false));
+    @test_throws "Variable `carbon_biomass` is not computed by any model, not initialised by the user in the status, and not found in the MTG at scale Internode (checked for MTG node 4)." PlantSimEngine.init_statuses(mtg, mapping_1, hard_dep_graph)  
+    organs_statuses, others = PlantSimEngine.init_statuses(mtg_init, mapping_1, hard_dep_graph)
 
     @test collect(keys(organs_statuses)) == ["Soil", "Internode", "Plant", "Leaf"]
     # Check that the soil_water_content is linked between the soil and the leaves:
@@ -148,7 +150,7 @@ end
     @test organs_statuses["Leaf"][1][:carbon_demand] == -Inf
 
     # Testing with a different type:
-    organs_statuses, others = PlantSimEngine.init_statuses(mtg_init, mapping_1, type_promotion=Dict(Float64 => Float32, Vector{Float64} => Vector{Float32}))
+    organs_statuses, others = PlantSimEngine.init_statuses(mtg_init, mapping_1, hard_dep_graph, type_promotion=Dict(Float64 => Float32, Vector{Float64} => Vector{Float32}))
 
     @test isa(organs_statuses["Plant"][1][:carbon_assimilation], PlantSimEngine.RefVector{Float32})
     @test isa(organs_statuses["Plant"][1][:carbon_allocation], PlantSimEngine.RefVector{Float32})
@@ -168,7 +170,8 @@ end
     type_promotion = nothing
     nsteps = 2
     dependency_graph = dep(mapping_1)
-    organs_statuses, others = PlantSimEngine.init_statuses(mtg_init, mapping_1, first(PlantSimEngine.hard_dependencies(mapping_1; verbose=false)); type_promotion=type_promotion)
+    hard_dep_graph = first(PlantSimEngine.hard_dependencies(mapping_1; verbose=false))
+    organs_statuses, others = PlantSimEngine.init_statuses(mtg_init, mapping_1, hard_dep_graph; type_promotion=type_promotion)
 
     @test collect(keys(organs_statuses)) == ["Soil", "Internode", "Plant", "Leaf"]
     @test collect(keys(organs_statuses["Soil"][1])) == [:node, :soil_water_content]
@@ -194,7 +197,7 @@ end
     @test PlantSimEngine.to_initialize(mapping_1, mtg) == Dict("Internode" => [:carbon_biomass], "Leaf" => [:carbon_biomass])
     @test PlantSimEngine.to_initialize(mapping_1, mtg_init) == Dict{String,Symbol}()
 
-    statuses, status_templates, reverse_multiscale_mapping, vars_need_init = PlantSimEngine.init_statuses(mtg_init, mapping_1)
+    statuses, status_templates, reverse_multiscale_mapping, vars_need_init = PlantSimEngine.init_statuses(mtg_init, mapping_1, hard_dep_graph)
     @test collect(keys(statuses)) == ["Soil", "Internode", "Plant", "Leaf"]
 
     @test length(statuses["Internode"]) == length(statuses["Leaf"]) == 2