DFlee Flood rules for move chances implemented. #81

flee/SimulationSettings.py

@@ -245,18 +245,25 @@ def ReadFromYML(ymlfile: str):
         for a in ["ChildrenAvoidHazards", "BoysTakeRisk", "MatchCampEthnicity", "MatchTownEthnicity", "MatchConflictEthnicity"]:
             SimulationSettings.move_rules[a] = bool(fetchss(dpr,a,False))
 
+
+        # DFlee Flood Location Move rules
         dpf = fetchss(dp, "flood_rules", None)
         if dpf is not None:
           SimulationSettings.move_rules["FloodRulesEnabled"] = True
           SimulationSettings.spawn_rules["MaxFloodLevel"] = int(fetchss(dpf,"max_flood_level", -1))
 
-          # Move rules
+          # FloodMovechances *override* move chances when flood level is higher than 0.
           SimulationSettings.move_rules["FloodMovechances"] = fetchss(dps,"flood_movechances", None) # Expect an array or dict
           print("Flood Movechances set to:", SimulationSettings.spawn_rules["FloodMovechances"], file=sys.stderr)
+
+          # FloodLocWeights *multiply* existing location weights when flood level is higher than 0.
           SimulationSettings.move_rules["FloodLocWeights"] = fetchss(dps,"flood_loc_weights", None) # Expect an array or dict
           print("Flood Location Weights set to:", SimulationSettings.spawn_rules["FloodLocWeights"], file=sys.stderr)
+
+          # FloodLinkWeights *multiply* existing link weights when flood level is higher than 0.
           SimulationSettings.move_rules["FloodLinkWeights"] = fetchss(dps,"flood_link_weights", None) # Expect an array or dict
           print("Flood Link Weights set to:", SimulationSettings.spawn_rules["FloodLinkWeights"], file=sys.stderr)
+          print("Note: Flood Link Weights are not supported yet in this version of DFlee.")
 
           #TODO: Add verification code.
 

flee/moving.py

@@ -252,8 +252,15 @@ def calculateMoveChance(a, ForceTownMove: bool) -> float:
         return 1.0
     else: # called first time in loop
         movechance = a.location.movechance
+        # Population-based scaling
         movechance *= (float(max(a.location.pop, a.location.capacity)) / SimulationSettings.move_rules["MovechancePopBase"])**SimulationSettings.move_rules["MovechancePopScaleFactor"]
 
+    # DFlee Flood Location Movechance implementation
+    if SimulationSettings.move_rules["FloodRulesEnabled"] is True:
+        flood_level = a.location.attributes.get("flood_level",0)
+        if flood_level > 0:
+            return float(SimulationSettings.move_rules["FloodMovechances"][flood_level])
+
     return movechance
 
 

tests/test_dflee.py

@@ -43,7 +43,7 @@ def test_flood_level_location_attribute():
     flee.SimulationSettings.ReadFromYML("empty.yml")
     flee.SimulationSettings.move_rules["FloodRulesEnabled"] = True
     flee.SimulationSettings.move_rules["FloodLocWeights"] = [0.0,1.0,1.0,1.0,1.0]
-    flee.SimulationSettings.move_rules["FloodMoveChances"] = [0.0,1.0,1.0,1.0,1.0]
+    flee.SimulationSettings.move_rules["FloodMovechances"] = [0.0,1.0,1.0,1.0,1.0]
 
     e = flee.Ecosystem()