sdf-xarray 0.7.1__tar.gz → 0.7.2__tar.gz

{sdf_xarray-0.7.1 → sdf_xarray-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sdf-xarray
-Version: 0.7.1
+Version: 0.7.2
 Summary: Provides a backend for xarray to read SDF files as created by the EPOCH plasma PIC code.
 Author-Email: Peter Hill <peter.hill@york.ac.uk>, Joel Adams <joel.adams@york.ac.uk>, Shaun Doherty <shaun.doherty@york.ac.uk>, Chris Herdman <chris.herdman@york.ac.uk>, Liam Pattinson <liam.pattinson@york.ac.uk>, Sviatoslav Shekhanov <sviatoslav.shekhanov@york.ac.uk>
 License-Expression: BSD-3-Clause

{sdf_xarray-0.7.1 → sdf_xarray-0.7.2}/docs/animation.md

@@ -16,6 +16,11 @@ import xarray as xr
 import matplotlib.pyplot as plt
 from matplotlib.animation import FuncAnimation
 from IPython.display import HTML
+
+# Matplotlib will attempt to display the first frame of the video
+# and since we don't want that on the documentation we run in 
+# notebook mode
+%matplotlib notebook
 ```
 
 ## Basic usage
@@ -107,7 +112,7 @@ same way a 2D simulation can be plotted along a line.
 ds = sdfxr.open_mfdataset("tutorial_dataset_3d/*.sdf")
 
 da = ds["Derived_Number_Density"]
-da_lineout = da.sel(Y_Grid_mid = 0, method="nearest")
+da_lineout = da.sel(Y_Grid_mid = 0, method = "nearest")
 anim = da_lineout.epoch.animate(title = "Y = 0 [m]", fps = 2)
 anim.show()
 ```
@@ -144,7 +149,7 @@ ds = xr.open_mfdataset(
    )
 
 da = ds["Derived_Number_Density_Beam_Electrons"]
-anim = da.epoch.animate(move_window=True, fps = 5)
+anim = da.epoch.animate(move_window = True, fps = 5)
 anim.show()
 ```
 
@@ -180,7 +185,7 @@ anim = da.epoch.animate(
    max_percentile = 95,
    title = "Target A",
    cmap = "plasma",
-   )
+)
 anim.show()
 ```
 
@@ -200,9 +205,9 @@ ds = sdfxr.open_mfdataset("tutorial_dataset_1d/*.sdf")
 anim = ds.epoch.animate_multiple(
    ds["Derived_Number_Density_Electron"],
    ds["Derived_Number_Density_Ion"],
-   datasets_kwargs=[{"label": "Electron"}, {"label": "Ion"}],
-   ylim=(0e27,4e27),
-   ylabel="Derived Number Density [1/m$^3$]"
+   datasets_kwargs = [{"label": "Electron"}, {"label": "Ion"}],
+   ylim = (0e27,4e27),
+   ylabel = "Derived Number Density [1/m$^3$]"
 )
 
 anim.show()
@@ -242,7 +247,7 @@ flux_norm = LogNorm(
 anim = ds.epoch.animate_multiple(
    ds["Derived_Number_Density_Electron"],
    flux_masked,
-   datasets_kwargs=[
+   datasets_kwargs = [
       {"alpha": 1.0},
       {"cmap": "hot", "norm": flux_norm, "alpha": 0.9},
    ],

{sdf_xarray-0.7.1 → sdf_xarray-0.7.2}/src/sdf_xarray/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.7.1'
-__version_tuple__ = version_tuple = (0, 7, 1)
+__version__ = version = '0.7.2'
+__version_tuple__ = version_tuple = (0, 7, 2)
 
-__commit_id__ = commit_id = 'ge960ff001'
+__commit_id__ = commit_id = 'g80091946f'

{sdf_xarray-0.7.1 → sdf_xarray-0.7.2}/src/sdf_xarray/plotting.py

@@ -365,9 +365,7 @@ def animate(
 
     # Create plot if no ax is provided
     if ax is None:
-        fig, ax = plt.subplots()
-        # Prevents figure from prematurely displaying in Jupyter notebook
-        plt.close(fig)
+        _, ax = plt.subplots()
 
     animation = _generate_animation(
         data,
@@ -457,9 +455,7 @@ def animate_multiple(
 
     # Create plot if no ax is provided
     if ax is None:
-        fig, ax = plt.subplots()
-        # Prevents figure from prematurely displaying in Jupyter notebook
-        plt.close(fig)
+        _, ax = plt.subplots()
 
     n_datasets = len(datasets)
     if datasets_kwargs is None: