feat(mf6-lake): add helper function to create lake connections (#1163)

Author: jdhughes-dev

.docs/code.rst

@@ -198,6 +198,7 @@ Contents:
    ./source/flopy.mf6.utils.output_util.rst
    ./source/flopy.mf6.utils.postprocessing.rst
    ./source/flopy.mf6.utils.reference.rst
+   ./source/flopy.mf6.utils.lakpak_utils.rst
 
 
 MODFLOW 6 Data

autotest/t016_test.py

@@ -48,8 +48,10 @@ def test_usg_disu_load():
     ):
         if isinstance(value1, (flopy.utils.Util2d, flopy.utils.Util3d)):
             assert np.array_equal(value1.array, value2.array)
-        elif isinstance(value1, list): #this is for the jagged _get_neighbours list
-            assert np.all([np.all(v1 == v2) for v1,v2 in zip(value1,value2)])
+        elif isinstance(
+            value1, list
+        ):  # this is for the jagged _get_neighbours list
+            assert np.all([np.all(v1 == v2) for v1, v2 in zip(value1, value2)])
         elif not isinstance(value1, flopy.utils.reference.TemporalReference):
             assert value1 == value2
 
@@ -136,8 +138,11 @@ def test_usg_model():
             success, buff = mf.run_model()
             assert success
 
+
 def test_usg_load_01B():
-    print("testing 1-layer unstructured mfusg model loading: 01A_nestedgrid_nognc.nam")
+    print(
+        "testing 1-layer unstructured mfusg model loading: 01A_nestedgrid_nognc.nam"
+    )
     pthusgtest = os.path.join(
         "..", "examples", "data", "mfusg_test", "01A_nestedgrid_nognc"
     )
@@ -162,11 +167,10 @@ def test_usg_load_01B():
     msg = "flopy failed on loading mfusg sms package"
     assert isinstance(m.sms, flopy.modflow.mfsms.ModflowSms), msg
 
+
 def test_usg_load_45usg():
     print("testing 3-layer unstructured mfusg model loading: 45usg.nam")
-    pthusgtest = os.path.join(
-        "..", "examples", "data", "mfusg_test", "45usg"
-    )
+    pthusgtest = os.path.join("..", "examples", "data", "mfusg_test", "45usg")
     fname = os.path.join(pthusgtest, "45usg.nam")
     assert os.path.isfile(fname), "nam file not found {}".format(fname)
 
@@ -192,50 +196,66 @@ def test_usg_load_45usg():
     msg = "flopy failed on loading mfusg wel package"
     assert isinstance(m.wel, flopy.modflow.mfwel.ModflowWel), msg
 
+
 def test_usg_rch_evt_models01():
     # this test has RCH nrchop == 1, and EVT nevtop == 1
-    print("testing unstructured mfusg RCH nrchop == 1, and EVT nevtop == 1: \
-usg_rch_evt.nam")
+    print(
+        "testing unstructured mfusg RCH nrchop == 1, and EVT nevtop == 1: \
+usg_rch_evt.nam"
+    )
     model_ws = os.path.join(
-        '..', 'examples', 'data', 'mfusg_test', 'rch_evt_tests')
-    nam = 'usg_rch_evt.nam'
+        "..", "examples", "data", "mfusg_test", "rch_evt_tests"
+    )
+    nam = "usg_rch_evt.nam"
     m = flopy.modflow.Modflow.load(
-        nam, model_ws=model_ws, version='mfusg', exe_name=v)
+        nam, model_ws=model_ws, version="mfusg", exe_name=v
+    )
     m.model_ws = tpth
     m.write_input()
     if run:
         success, buff = m.run_model()
         assert success
 
+
 def test_usg_rch_evt_models02():
     # this test has RCH nrchop == 2, and EVT nevtop == 2
-    print("testing unstructured mfusg RCH nrchop == 2, and EVT nevtop == 2: \
-usg_rch_evt_nrchop2.nam")
+    print(
+        "testing unstructured mfusg RCH nrchop == 2, and EVT nevtop == 2: \
+usg_rch_evt_nrchop2.nam"
+    )
     model_ws = os.path.join(
-        '..', 'examples', 'data', 'mfusg_test', 'rch_evt_tests')
-    nam = 'usg_rch_evt_nrchop2.nam'
+        "..", "examples", "data", "mfusg_test", "rch_evt_tests"
+    )
+    nam = "usg_rch_evt_nrchop2.nam"
     m = flopy.modflow.Modflow.load(
-        nam, model_ws=model_ws, version='mfusg', exe_name=v)
+        nam, model_ws=model_ws, version="mfusg", exe_name=v
+    )
     m.model_ws = tpth
     m.write_input()
     if run:
         success, buff = m.run_model()
-        assert success    
+        assert success
+
 
 def test_usg_rch_evt_models02a():
     # this test has RCH nrchop == 2, and EVT nevtop == 2
-    print("testing unstructured mfusg RCH nrchop == 2, and EVT nevtop == 2,\
- but with fewer irch nodes: than in nodelay[0] usg_rch_evt_nrchop2.nam")
+    print(
+        "testing unstructured mfusg RCH nrchop == 2, and EVT nevtop == 2,\
+ but with fewer irch nodes: than in nodelay[0] usg_rch_evt_nrchop2.nam"
+    )
     model_ws = os.path.join(
-        '..', 'examples', 'data', 'mfusg_test', 'rch_evt_tests')
-    nam = 'usg_rch_evt_nrchop2a.nam'
+        "..", "examples", "data", "mfusg_test", "rch_evt_tests"
+    )
+    nam = "usg_rch_evt_nrchop2a.nam"
     m = flopy.modflow.Modflow.load(
-        nam, model_ws=model_ws, version='mfusg', exe_name=v)
+        nam, model_ws=model_ws, version="mfusg", exe_name=v
+    )
     m.model_ws = tpth
     m.write_input()
     if run:
         success, buff = m.run_model()
-        assert success    
+        assert success
+
 
 if __name__ == "__main__":
     test_usg_disu_load()
@@ -246,4 +266,3 @@ def test_usg_rch_evt_models02a():
     test_usg_rch_evt_models01()
     test_usg_rch_evt_models02()
     test_usg_rch_evt_models02a()
-    

autotest/t029_test.py

@@ -241,7 +241,7 @@ def test_faceflows():
     sim.run_simulation()
 
     # get output
-    gwf = sim.get_model("gwf_1")
+    gwf = sim.get_model("freyberg")
     head = gwf.output.head().get_data()
     cbc = gwf.output.budget()
 
@@ -305,7 +305,7 @@ def test_flowja_residuals():
     )
 
     # get output
-    gwf = sim.get_model("gwf_1")
+    gwf = sim.get_model("freyberg")
     grb_file = os.path.join(tpth, "freyberg.dis.grb")
     cbc = gwf.output.budget()
 

autotest/t039_test.py

@@ -218,7 +218,9 @@ def test_zonbud_readwrite_zbarray():
     """
     x = np.random.randint(100, 200, size=(5, 150, 200))
     ZoneBudget.write_zone_file(os.path.join(outpth, "randint"), x)
-    ZoneBudget.write_zone_file(os.path.join(outpth, "randint"), x, fmtin=35, iprn=2)
+    ZoneBudget.write_zone_file(
+        os.path.join(outpth, "randint"), x, fmtin=35, iprn=2
+    )
     z = ZoneBudget.read_zone_file(os.path.join(outpth, "randint"))
     assert np.array_equal(x, z), "Input and output arrays do not match."
     return
@@ -397,7 +399,7 @@ def test_zonebudget_6():
     except ImportError:
         return
 
-    exe_name = 'mf6'
+    exe_name = "mf6"
     zb_exe_name = "zbud6"
     cpth = os.path.join(".", "temp", "t039")
 
@@ -407,8 +409,8 @@ def test_zonebudget_6():
     sim.write_simulation()
     success, _ = sim.run_simulation()
 
-    grb_file = os.path.join(cpth, 'test001e_UZF_3lay.dis.grb')
-    cbc_file = os.path.join(cpth, 'test001e_UZF_3lay.cbc')
+    grb_file = os.path.join(cpth, "test001e_UZF_3lay.dis.grb")
+    cbc_file = os.path.join(cpth, "test001e_UZF_3lay.cbc")
 
     ml = sim.get_model("gwf_1")
     idomain = np.ones(ml.modelgrid.shape, dtype=int)

autotest/t065_test_gridintersect.py

@@ -1360,5 +1360,6 @@ def test_rasters():
 
     del rio
 
+
 if __name__ == "__main__":
-    test_rasters()
+    test_rasters()