refactor(Notebooks): apply pyformat and black QA tools (#1879)

modflowpy · Jul 24, 2023 · c261ee8 · c261ee8
1 parent 8b03916
commit c261ee8
Show file tree

Hide file tree

Showing 57 changed files with 424 additions and 450 deletions.
diff --git a/.docs/Notebooks/array_output_tutorial.py b/.docs/Notebooks/array_output_tutorial.py
@@ -53,9 +53,9 @@
     os.makedirs(modelpth)
 
 print(sys.version)
-print("numpy version: {}".format(np.__version__))
-print("matplotlib version: {}".format(mpl.__version__))
-print("flopy version: {}".format(flopy.__version__))
+print(f"numpy version: {np.__version__}")
+print(f"matplotlib version: {mpl.__version__}")
+print(f"flopy version: {flopy.__version__}")
 
 # +
 ml = flopy.modflow.Modflow.load(
@@ -73,10 +73,10 @@
 files = ["freyberg.hds", "freyberg.cbc"]
 for f in files:
     if os.path.isfile(os.path.join(modelpth, f)):
-        msg = "Output file located: {}".format(f)
+        msg = f"Output file located: {f}"
         print(msg)
     else:
-        errmsg = "Error. Output file cannot be found: {}".format(f)
+        errmsg = f"Error. Output file cannot be found: {f}"
         print(errmsg)
 
 # + [markdown] pycharm={"name": "#%% md\n"}

diff --git a/.docs/Notebooks/dis_triangle_example.py b/.docs/Notebooks/dis_triangle_example.py
@@ -37,9 +37,9 @@
 workspace = Path(temp_dir.name)
 
 print(sys.version)
-print("numpy version: {}".format(np.__version__))
-print("matplotlib version: {}".format(mpl.__version__))
-print("flopy version: {}".format(flopy.__version__))
+print(f"numpy version: {np.__version__}")
+print(f"matplotlib version: {mpl.__version__}")
+print(f"flopy version: {flopy.__version__}")
 # -
 
 # ## Creating Meshes with the Triangle Class
@@ -247,8 +247,8 @@ def chdhead(x):
 chd = flopy.mf6.ModflowGwfchd(gwf, stress_period_data=chdlist)
 oc = flopy.mf6.ModflowGwfoc(
     gwf,
-    budget_filerecord="{}.cbc".format(name),
-    head_filerecord="{}.hds".format(name),
+    budget_filerecord=f"{name}.cbc",
+    head_filerecord=f"{name}.hds",
     saverecord=[("HEAD", "LAST"), ("BUDGET", "LAST")],
     printrecord=[("HEAD", "LAST"), ("BUDGET", "LAST")],
 )

diff --git a/.docs/Notebooks/dis_voronoi_example.py b/.docs/Notebooks/dis_voronoi_example.py
@@ -41,9 +41,9 @@
 workspace = Path(temp_dir.name)
 
 print(sys.version)
-print("numpy version: {}".format(np.__version__))
-print("matplotlib version: {}".format(mpl.__version__))
-print("flopy version: {}".format(flopy.__version__))
+print(f"numpy version: {np.__version__}")
+print(f"matplotlib version: {mpl.__version__}")
+print(f"flopy version: {flopy.__version__}")
 # -
 
 # ### Use Triangle to Generate Points for Voronoi Grid
@@ -164,8 +164,8 @@
 chd = flopy.mf6.ModflowGwfchd(gwf, stress_period_data=chdlist)
 oc = flopy.mf6.ModflowGwfoc(
     gwf,
-    budget_filerecord="{}.bud".format(name),
-    head_filerecord="{}.hds".format(name),
+    budget_filerecord=f"{name}.bud",
+    head_filerecord=f"{name}.hds",
     saverecord=[("HEAD", "ALL"), ("BUDGET", "ALL")],
     printrecord=[("HEAD", "LAST"), ("BUDGET", "LAST")],
 )
@@ -229,8 +229,8 @@
 fmi = flopy.mf6.ModflowGwtfmi(gwt, packagedata=pd)
 oc = flopy.mf6.ModflowGwtoc(
     gwt,
-    budget_filerecord="{}.cbc".format(name),
-    concentration_filerecord="{}.ucn".format(name),
+    budget_filerecord=f"{name}.cbc",
+    concentration_filerecord=f"{name}.ucn",
     saverecord=[("CONCENTRATION", "ALL"), ("BUDGET", "ALL")],
 )
 

diff --git a/.docs/Notebooks/drain_return_example.py b/.docs/Notebooks/drain_return_example.py
@@ -29,9 +29,9 @@
 import flopy
 
 print(sys.version)
-print("numpy version: {}".format(np.__version__))
-print("matplotlib version: {}".format(mpl.__version__))
-print("flopy version: {}".format(flopy.__version__))
+print(f"numpy version: {np.__version__}")
+print(f"matplotlib version: {mpl.__version__}")
+print(f"flopy version: {flopy.__version__}")
 
 # +
 # temporary directory
@@ -78,7 +78,7 @@
     raise ValueError("Failed to run.")
 
 # plot heads for the drt model
-hds = flopy.utils.HeadFile(os.path.join(m.model_ws, m.name + ".hds"))
+hds = flopy.utils.HeadFile(os.path.join(m.model_ws, f"{m.name}.hds"))
 hds.plot(colorbar=True)
 
 # remove the drt package and create a standard drain file
@@ -98,7 +98,7 @@
     raise ValueError("Failed to run.")
 
 # plot the heads for the model with the drain
-hds = flopy.utils.HeadFile(os.path.join(m.model_ws, m.name + ".hds"))
+hds = flopy.utils.HeadFile(os.path.join(m.model_ws, f"{m.name}.hds"))
 hds.plot(colorbar=True)
 
 try:

diff --git a/.docs/Notebooks/export_tutorial.py b/.docs/Notebooks/export_tutorial.py
@@ -27,7 +27,7 @@
 import flopy
 
 print(sys.version)
-print("flopy version: {}".format(flopy.__version__))
+print(f"flopy version: {flopy.__version__}")
 # -
 
 # Load our old friend...the Freyberg model
@@ -60,12 +60,12 @@
 pth = temp_dir.name
 
 # export the whole model (inputs and outputs)
-fnc = ml.export(os.path.join(pth, ml.name + ".in.nc"))
+fnc = ml.export(os.path.join(pth, f"{ml.name}.in.nc"))
 
 # export outputs using spatial reference info
 hds = flopy.utils.HeadFile(os.path.join(model_ws, "freyberg.hds"))
 flopy.export.utils.output_helper(
-    os.path.join(pth, ml.name + ".out.nc"), ml, {"hds": hds}
+    os.path.join(pth, f"{ml.name}.out.nc"), ml, {"hds": hds}
 )
 
 # ### Export an array to netCDF or shapefile

diff --git a/.docs/Notebooks/export_vtk_tutorial.py b/.docs/Notebooks/export_vtk_tutorial.py
@@ -41,7 +41,7 @@
 import notebook_utils
 
 print(sys.version)
-print("flopy version: {}".format(flopy.__version__))
+print(f"flopy version: {flopy.__version__}")
 # -
 
 # load model for examples
@@ -384,10 +384,10 @@
 files = ["mp7p2.hds", "mp7p2.cbb"]
 for f in files:
     if os.path.isfile(modelpth / f):
-        msg = "Output file located: {}".format(f)
+        msg = f"Output file located: {f}"
         print(msg)
     else:
-        errmsg = "Error. Output file cannot be found: {}".format(f)
+        errmsg = f"Error. Output file cannot be found: {f}"
         print(errmsg)
 
 # +

diff --git a/.docs/Notebooks/external_file_handling_tutorial.py b/.docs/Notebooks/external_file_handling_tutorial.py
@@ -32,8 +32,8 @@
 from flopy.utils import flopy_io
 
 print(sys.version)
-print("numpy version: {}".format(np.__version__))
-print("flopy version: {}".format(flopy.__version__))
+print(f"numpy version: {np.__version__}")
+print(f"flopy version: {flopy.__version__}")
 
 # +
 # make a model
@@ -57,7 +57,7 @@
 vka = np.zeros_like(hk)
 fnames = []
 for i, h in enumerate(hk):
-    fname = os.path.join(array_dir, "hk_{0}.ref".format(i + 1))
+    fname = os.path.join(array_dir, f"hk_{i + 1}.ref")
     fnames.append(fname)
     np.savetxt(fname, h)
     vka[i] = i + 1
@@ -84,7 +84,7 @@
 
 # We see that a copy of the ``hk`` files as well as the important recharge file were made in the ```model_ws```.Let's looks at the ```lpf``` file
 
-open(os.path.join(ml.model_ws, ml.name + ".lpf"), "r").readlines()[:20]
+open(os.path.join(ml.model_ws, f"{ml.name}.lpf")).readlines()[:20]
 
 # We see that the ```open/close``` approach was used - this is because ``ml.array_free_format`` is ``True``.  Notice that ```vka``` is written internally
 
@@ -137,7 +137,7 @@
 vka = np.zeros_like(hk)
 fnames = []
 for i, h in enumerate(hk):
-    fname = os.path.join(array_dir, "hk_{0}.ref".format(i + 1))
+    fname = os.path.join(array_dir, f"hk_{i + 1}.ref")
     fnames.append(fname)
     np.savetxt(fname, h)
     vka[i] = i + 1
@@ -189,7 +189,7 @@
 vka = np.zeros_like(hk)
 fnames = []
 for i, h in enumerate(hk):
-    fname = os.path.join(array_dir, "hk_{0}.ref".format(i + 1))
+    fname = os.path.join(array_dir, f"hk_{i + 1}.ref")
     fnames.append(fname)
     np.savetxt(fname, h)
     vka[i] = i + 1
@@ -206,16 +206,16 @@
 
 # We see that now the external arrays are being handled through the name file.  Let's look at the name file
 
-open(os.path.join(ml.model_ws, ml.name + ".nam"), "r").readlines()
+open(os.path.join(ml.model_ws, f"{ml.name}.nam")).readlines()
 
 # ### Free and binary format
 
 ml.dis.botm[0].format.binary = True
 ml.write_input()
 
-open(os.path.join(ml.model_ws, ml.name + ".nam"), "r").readlines()
+open(os.path.join(ml.model_ws, f"{ml.name}.nam")).readlines()
 
-open(os.path.join(ml.model_ws, ml.name + ".dis"), "r").readlines()
+open(os.path.join(ml.model_ws, f"{ml.name}.dis")).readlines()
 
 # ### The ```.how``` attribute
 # ```Util2d``` includes a ```.how``` attribute that gives finer grained control of how arrays will written
@@ -240,11 +240,11 @@
 
 ml.write_input()
 
-open(os.path.join(ml.model_ws, ml.name + ".dis"), "r").readlines()
+open(os.path.join(ml.model_ws, f"{ml.name}.dis")).readlines()
 
-open(os.path.join(ml.model_ws, ml.name + ".lpf"), "r").readlines()
+open(os.path.join(ml.model_ws, f"{ml.name}.lpf")).readlines()
 
-open(os.path.join(ml.model_ws, ml.name + ".nam"), "r").readlines()
+open(os.path.join(ml.model_ws, f"{ml.name}.nam")).readlines()
 
 try:
     # ignore PermissionError on Windows

diff --git a/.docs/Notebooks/feat_working_stack_examples.py b/.docs/Notebooks/feat_working_stack_examples.py
@@ -40,10 +40,10 @@
     import flopy
 
 print(sys.version)
-print("numpy version: {}".format(np.__version__))
-print("matplotlib version: {}".format(mpl.__version__))
-print("pandas version: {}".format(pd.__version__))
-print("flopy version: {}".format(flopy.__version__))
+print(f"numpy version: {np.__version__}")
+print(f"matplotlib version: {mpl.__version__}")
+print(f"pandas version: {pd.__version__}")
+print(f"flopy version: {flopy.__version__}")
 # -
 
 # ### Model Inputs

diff --git a/.docs/Notebooks/get_transmissivities_example.py b/.docs/Notebooks/get_transmissivities_example.py
@@ -39,9 +39,9 @@
 import flopy
 
 print(sys.version)
-print("numpy version: {}".format(np.__version__))
-print("matplotlib version: {}".format(mpl.__version__))
-print("flopy version: {}".format(flopy.__version__))
+print(f"numpy version: {np.__version__}")
+print(f"matplotlib version: {mpl.__version__}")
+print(f"flopy version: {flopy.__version__}")
 # -
 
 # ### Make up some open interval tops and bottoms and some heads
@@ -104,7 +104,7 @@
 fig, ax = plt.subplots()
 plt.plot(m.dis.top.array[r, c], label="model top")
 for i, l in enumerate(m.dis.botm.array[:, r, c]):
-    label = "layer {} bot".format(i + 1)
+    label = f"layer {i + 1} bot"
     if i == m.nlay - 1:
         label = "model bot"
     plt.plot(l, label=label)

diff --git a/.docs/Notebooks/grid_intersection_example.py b/.docs/Notebooks/grid_intersection_example.py
@@ -60,10 +60,10 @@
 from flopy.utils import GridIntersect
 
 print(sys.version)
-print("numpy version: {}".format(np.__version__))
-print("matplotlib version: {}".format(mpl.__version__))
-print("flopy version: {}".format(flopy.__version__))
-print("shapely version: {}".format(shapely.__version__))
+print(f"numpy version: {np.__version__}")
+print(f"matplotlib version: {mpl.__version__}")
+print(f"flopy version: {flopy.__version__}")
+print(f"shapely version: {shapely.__version__}")
 # -
 
 # ## <a id="gridclass"></a>[GridIntersect Class](#top)

diff --git a/.docs/Notebooks/gridgen_example.py b/.docs/Notebooks/gridgen_example.py
@@ -45,9 +45,9 @@
 from flopy.utils.gridgen import Gridgen
 
 print(sys.version)
-print("numpy version: {}".format(np.__version__))
-print("matplotlib version: {}".format(mpl.__version__))
-print("flopy version: {}".format(flopy.__version__))
+print(f"numpy version: {np.__version__}")
+print(f"matplotlib version: {mpl.__version__}")
+print(f"flopy version: {flopy.__version__}")
 # -
 
 # The Flopy GRIDGEN module requires that the gridgen executable can be called using subprocess **(i.e., gridgen is in your path)**.
@@ -62,9 +62,7 @@
     print(msg)
 else:
     print(
-        "gridgen executable was found at: {}".format(
-            flopy_io.relpath_safe(gridgen_exe)
-        )
+        f"gridgen executable was found at: {flopy_io.relpath_safe(gridgen_exe)}"
     )
 
 # +
@@ -75,8 +73,8 @@
 gridgen_ws = os.path.join(model_ws, "gridgen")
 if not os.path.exists(gridgen_ws):
     os.makedirs(gridgen_ws, exist_ok=True)
-print("Model workspace is : {}".format(flopy_io.scrub_login(model_ws)))
-print("Gridgen workspace is : {}".format(flopy_io.scrub_login(gridgen_ws)))
+print(f"Model workspace is : {flopy_io.scrub_login(model_ws)}")
+print(f"Gridgen workspace is : {flopy_io.scrub_login(gridgen_ws)}")
 # -
 
 # ## Basic Gridgen Operations
@@ -276,8 +274,8 @@
     gwf, xt3doptions=True, save_specific_discharge=True
 )
 chd = flopy.mf6.ModflowGwfchd(gwf, stress_period_data=chdspd)
-budget_file = name + ".bud"
-head_file = name + ".hds"
+budget_file = f"{name}.bud"
+head_file = f"{name}.hds"
 oc = flopy.mf6.ModflowGwfoc(
     gwf,
     budget_filerecord=budget_file,
@@ -378,8 +376,8 @@
     gwf, xt3doptions=True, save_specific_discharge=True
 )
 chd = flopy.mf6.ModflowGwfchd(gwf, stress_period_data=chdspd)
-budget_file = name + ".bud"
-head_file = name + ".hds"
+budget_file = f"{name}.bud"
+head_file = f"{name}.hds"
 oc = flopy.mf6.ModflowGwfoc(
     gwf,
     budget_filerecord=budget_file,
@@ -406,7 +404,7 @@
     pmv.contour_array(
         head, levels=[0.2, 0.4, 0.6, 0.8], linewidths=3.0, vmin=vmin, vmax=vmax
     )
-    ax.set_title("Layer {}".format(ilay + 1))
+    ax.set_title(f"Layer {ilay + 1}")
     pmv.plot_vector(spdis["qx"], spdis["qy"], color="white")
 # -
 
@@ -452,7 +450,7 @@
     raise ValueError("Failed to run.")
 
 # head is returned as a list of head arrays for each layer
-head_file = os.path.join(ws, name + ".hds")
+head_file = os.path.join(ws, f"{name}.hds")
 head = flopy.utils.HeadUFile(head_file).get_data()
 
 # MODFLOW-USG does not have vertices, so we need to create
@@ -472,7 +470,7 @@
     pmv.plot_array(head[ilay], cmap="jet", vmin=vmin, vmax=vmax)
     pmv.plot_grid(colors="k", alpha=0.1)
     pmv.contour_array(head[ilay], levels=[0.2, 0.4, 0.6, 0.8], linewidths=3.0)
-    ax.set_title("Layer {}".format(ilay + 1))
+    ax.set_title(f"Layer {ilay + 1}")
 # -
 
 try:

diff --git a/.docs/Notebooks/groundwater2023_watershed_example.py b/.docs/Notebooks/groundwater2023_watershed_example.py
@@ -39,9 +39,9 @@
 from flopy.utils.voronoi import VoronoiGrid
 
 print(sys.version)
-print("numpy version: {}".format(np.__version__))
-print("matplotlib version: {}".format(mpl.__version__))
-print("flopy version: {}".format(flopy.__version__))
+print(f"numpy version: {np.__version__}")
+print(f"matplotlib version: {mpl.__version__}")
+print(f"flopy version: {flopy.__version__}")
 
 # import all plot style information from defaults.py
 sys.path.append("../common")