fix sim_1 docstring in compare_simulations

pmlmodelling · Feb 12, 2025 · 0a2d184 · 0a2d184
1 parent a45772e
commit 0a2d184
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/ecoval/differences.py b/ecoval/differences.py
@@ -275,10 +275,10 @@ def compare_simulations(
     Parameters
     -------------
 
-    sim_dir_1 : str
-        The directory containing the first model directory  
-    sim_dir_2 : str
-        The directory containing the second simulation
+    sim_1 : dict
+        A dictionary of the first simulation. Key, value pair should be the name of the simulation and the directory.
+    sim_2 : dict
+        A dictionary of the second simulation. Key, value pair should be the name of the simulation and the directory.
     surface_variables : dict
         A dictionary of variables to compare at the surface
     bottom_variables : dict