Simplify show model

blobmodel/plotting.py

@@ -5,14 +5,14 @@
 import numpy as np
 import xarray as xr
 from matplotlib import animation
+from typing import Union
 
 
 def show_model(
     dataset: xr.Dataset,
     variable: str = "n",
     interval: int = 100,
-    save: bool = False,
-    gif_name: str = "blobs.gif",
+    gif_name: Union[str, None] = None,
     fps: int = 10,
 ) -> None:
     """
@@ -26,10 +26,8 @@ def show_model(
         Variable to be animated (default: "n").
     interval : int, optional
         Time interval between frames in milliseconds (default: 100).
-    save : bool, optional
-        If True, save the animation as a GIF (default: False).
     gif_name : str, optional
-        Set the name for the saved GIF (default: "blobs.gif").
+        If not None, save the animation as a GIF and name it acoridingly.
     fps : int, optional
         Set the frames per second for the saved GIF (default: 10).
 
@@ -103,7 +101,7 @@ def animate_2d(i: int) -> None:
             fig, animate_2d, frames=dataset["t"].values.size, interval=interval
         )
 
-    if save:
+    if gif_name:
         ani.save(gif_name, writer="ffmpeg", fps=fps)
     plt.show()
 

examples/1d_animation.py

@@ -17,4 +17,4 @@
 )
 
 ds = bm.make_realization(speed_up=True, error=1e-2)
-show_model(dataset=ds, interval=100, save=True)
+show_model(dataset=ds, interval=100, gif_name="1d_animation.gif")

examples/2d_animation.py

@@ -18,4 +18,4 @@
 # create data
 ds = bm.make_realization(speed_up=True, error=1e-2)
 # show animation and save as gif
-show_model(dataset=ds, interval=100, save=True, gif_name="example.gif", fps=10)
+show_model(dataset=ds, interval=100, gif_name="2d_animation.gif", fps=10)

examples/compare_to_analytical_sol.py

@@ -21,7 +21,7 @@
     blob_factory=bf,
 )
 
-ds = tmp.make_realization(file_name="profile_comparison.nc", speed_up=True, error=1e-2)
+ds = tmp.make_realization(file_name="profile_comparison.nc", speed_up=False, error=1e-4)
 
 
 def plot_convergence_to_analytical_solution(ds):

examples/single_blob.py

@@ -66,4 +66,4 @@ def is_one_dimensional(self) -> bool:
 ds = bm.make_realization(speed_up=True, error=1e-2)
 
 # show animation and save as gif
-show_model(dataset=ds, interval=100, save=True, gif_name="example.gif", fps=10)
+show_model(dataset=ds, interval=100, gif_name="example.gif", fps=10)

tests/test_show_model.py

@@ -23,7 +23,7 @@
 @patch("matplotlib.pyplot.show")
 def test_plot_2d(mock_show):
     warnings.filterwarnings("ignore")
-    show_model(dataset=ds_2d, interval=100, save=False, fps=10)
+    show_model(dataset=ds_2d, interval=100, gif_name=None, fps=10)
 
 
 bm_1d = Model(
@@ -46,4 +46,4 @@ def test_plot_2d(mock_show):
 @patch("matplotlib.pyplot.show")
 def test_plot_1d(mock_show):
     warnings.filterwarnings("ignore")
-    show_model(dataset=ds_1d, interval=100, save=False, fps=10)
+    show_model(dataset=ds_1d, interval=100, gif_name=None, fps=10)