sdf-xarray 0.3.0__tar.gz → 0.3.1__tar.gz

{sdf_xarray-0.3.0 → sdf_xarray-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sdf-xarray
-Version: 0.3.0
+Version: 0.3.1
 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>
 License-Expression: BSD-3-Clause

sdf_xarray-0.3.1/docs/tutorial_dataset_2d/input.deck

@@ -0,0 +1,65 @@
+begin:control
+  nx = 64
+  ny = 64
+
+  # Final time of simulation
+  t_end = 5 * femto
+
+  # Size of domain
+  x_min = 0
+  x_max = 6 * micron
+
+  y_min = 0
+  y_max = 6 * micron
+
+  stdout_frequency = 1
+  nparticles = nx * ny * 50
+end:control
+
+begin:constant
+    n_elec = 1000
+    L_target_x = 2 * micron
+    L_target_y = 4 * micron
+
+    x_center = (x_min + x_max) / 2
+    y_center = (y_min + y_max) / 2
+
+    density_profile = if( (abs(x - x_center) lt L_target_x/2), if( (abs(y - y_center) lt L_target_y/2), 1, 0), 0)
+end:constant
+
+begin:boundaries
+  bc_x_min = periodic
+  bc_x_max = periodic
+  bc_y_min = periodic
+  bc_y_max = periodic
+end:boundaries
+
+
+begin:species
+  name = Electron
+  frac = 0.5
+  number_density = n_elec * density_profile
+  identify:electron
+end:species
+
+begin:species
+  name = Ion
+  frac = 0.5
+  number_density = n_elec * density_profile
+  identify:proton
+end:species
+
+begin:output_global
+    force_last_to_be_restartable = F
+end:output_global
+
+begin:output
+  name = normal
+
+  dt_snapshot = 1 * femto
+
+  grid = always
+  number_density = always + species
+
+end:output
+

sdf_xarray-0.3.1/docs/unit_conversion.rst

@@ -0,0 +1,228 @@
+.. _sec-unit-conversion:
+
+===============
+Unit Conversion
+===============
+
+The ``sdf-xarray`` package automatically extracts the units for each
+coordinate/variable/constant from an SDF file and stores them as an :class:`xarray.Dataset`
+attribute called ``"units"``. Sometimes we want to convert our data from one format to
+another, e.g. converting the grid coordinates from meters to microns, time from seconds 
+to femto-seconds or particle energy from Joules to electron-volts.
+
+.. ipython:: python
+
+    from sdf_xarray import open_mfdataset
+    import matplotlib.pyplot as plt
+    plt.rcParams.update({
+        "axes.labelsize": 16,
+        "xtick.labelsize": 14,
+        "ytick.labelsize": 14,
+        "axes.titlesize": 16
+    })
+
+
+=====================
+Rescaling Coordinates
+=====================
+
+For simple scaling and unit relabeling of coordinates (e.g., converting meters to microns),
+the most straightforward approach is to use the ``rescale_coords()`` method  
+via the custom ``xarray.Dataset.epoch`` dataset accessor.  
+
+This method scales the coordinate values by a given multiplier and updates the ``"units"``
+attribute in one step.
+
+Rescaling Grid Coordinates
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+We can use the ``xarray.Dataset.epoch.rescale_coords()`` method to convert X, Y, and Z
+coordinates from meters (m) to microns (µm) by applying a multiplier of ``1e6``.
+
+.. ipython:: python
+
+    fig, (ax1, ax2) = plt.subplots(1, 2, figsize=(16, 6))
+
+    with open_mfdataset("tutorial_dataset_2d/*.sdf") as ds:
+        ds_in_microns = ds.epoch.rescale_coords(
+            multiplier=1e6, 
+            unit_label="µm", 
+            coord_names=["X_Grid_mid", "Y_Grid_mid"]
+        )
+        derived_number_density = ds["Derived_Number_Density_Electron"].isel(time=0).compute()
+        derived_number_density_microns = ds_in_microns["Derived_Number_Density_Electron"].isel(time=0).compute()
+
+    derived_number_density.plot(ax=ax1, x="X_Grid_mid", y="Y_Grid_mid")
+    ax1.set_title("Original X Coordinate (m)")
+
+    derived_number_density_microns.plot(ax=ax2, x="X_Grid_mid", y="Y_Grid_mid")
+    ax2.set_title("Rescaled X Coordinate (µm)")
+
+    @savefig coordinate_conversion.png width=9in
+    fig.tight_layout()
+
+
+Rescaling Time Coordinate
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+We can also use the ``xarray.Dataset.epoch.rescale_coords()`` method to convert the time
+coordinate from seconds (s) to femto-seconds (fs) by applying a multiplier of ``1e15``.
+
+.. ipython:: python
+    
+    with open_mfdataset("tutorial_dataset_2d/*.sdf") as ds:
+        ds_time_in_femto = ds.epoch.rescale_coords(
+            multiplier=1e15, 
+            unit_label="fs", 
+            coord_names="time"
+        )
+
+        print(f"[Original] units: {ds['time'].attrs['units']}, values: {ds['time'].values}")
+        print(f"[Rescaled] units: {ds_time_in_femto['time'].attrs['units']}, values: {ds_time_in_femto['time'].values}")
+
+
+================================
+Unit Conversion with pint-xarray
+================================
+
+While this is sufficient for most use cases, we can enhance this functionality
+using the `pint <https://pint.readthedocs.io/en/stable/getting/index.html>`_ library.
+Pint allows us to specify the units of a given array and convert them
+to another, which is incredibly handy. We can take this a step further,
+however, and utilize the `pint-xarray
+<https://pint-xarray.readthedocs.io/en/latest/>`_ library. This library
+allows us to infer units directly from an `xarray.Dataset.attrs` while
+retaining all the information about the `xarray.Dataset`. This works
+very similarly to taking a NumPy array and multiplying it by a constant or
+another array, which returns a new array; however, this library will also
+retain the unit logic (specifically the ``"units"`` information).
+
+.. note::
+    Unit conversion is not supported on coordinates in ``pint-xarray`` which is due to an
+    underlying issue with how ``xarray`` implements indexes.
+
+Installation
+~~~~~~~~~~~~
+
+To install the pint libraries you can simply run the following optional
+dependency pip command which will install both the ``pint`` and ``pint-xarray``
+libraries. You can install these optional dependencies via pip:
+
+.. code:: console
+
+    $ pip install "sdf_xarray[pint]"
+
+.. note::
+    Once you install ``pint-xarray`` it is automatically picked up and loaded
+    by the code so you should have access to the ``xarray.Dataset.pint`` accessor.
+
+Quantifying Arrays
+~~~~~~~~~~~~~~~~~~
+
+When using ``pint-xarray``, the library attempts to infer units from the
+``"units"`` attribute on each `xarray.DataArray`. Alternatively, you can
+also specify the units yourself by passing a string into the 
+``xarray.Dataset.DataArray.pint.quantify()`` function call. Once the type is inferred
+the original `xarray.DataArray` will be converted to a `pint.Quantity`
+and the ``"units"`` attribute will
+be removed.
+
+In the following example we will extract the time-resolved total particle
+energy of electrons which is measured in Joules and convert it to electron
+volts.
+
+.. ipython:: python
+
+    with open_mfdataset("tutorial_dataset_1d/*.sdf") as ds:
+        total_particle_energy = ds["Total_Particle_Energy_Electron"]
+
+    total_particle_energy
+
+    total_particle_energy = ds["Total_Particle_Energy_Electron"].pint.quantify()
+
+    total_particle_energy
+
+
+Now that this dataset has been converted a `pint.Quantity`, we can check
+it's units and dimensionality
+
+.. ipython:: python
+
+    total_particle_energy.pint.units
+    total_particle_energy.pint.dimensionality
+
+
+Converting Units
+~~~~~~~~~~~~~~~~
+
+We can now convert it to electron volts utilising the `pint.Quantity.to`
+function
+
+.. ipython:: python
+
+    total_particle_energy_ev = total_particle_energy.pint.to("eV")
+
+Unit Propagation
+~~~~~~~~~~~~~~~~
+
+Suppose instead of converting to ``"eV"``, we want to convert to ``"W"``
+(watts). To do this, we divide the total particle energy by time. However,
+since coordinates in `xarray.Dataset` cannot be directly converted to
+`pint.Quantity`, we must first extract the coordinate values manually
+and create a new Pint quantity for time.
+
+Once both arrays are quantified, Pint will automatically handle the unit
+propagation when we perform arithmetic operations like division.
+
+.. note::
+    Pint does not automatically simplify ``"J/s"`` to ``"W"``, so we use
+    `pint.Quantity.to` to convert the unit string. Since these units are
+    the same it will not change the underlying data, only the units. This is
+    only a small formatting choice and is not required.
+
+.. ipython:: python
+
+    import pint
+    time_values = total_particle_energy.coords["time"].data
+    time = pint.Quantity(time_values, "s")
+    total_particle_energy_w = total_particle_energy / time
+    total_particle_energy_w.pint.units
+    total_particle_energy_w = total_particle_energy_w.pint.to("W")
+    total_particle_energy_w.pint.units
+
+Dequantifying and Restoring Units
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. note::
+    If this function is not called prior to plotting then the ``units`` will be
+    inferred from the `pint.Quantity` array which will return the long
+    name of the units. i.e. instead of returning ``"eV"`` it will return
+    ``"electron_volt"``.
+
+The ``xarray.Dataset.DataArray.pint.dequantify`` function converts the data from
+`pint.Quantity` back to the original `xarray.DataArray` and adds
+the ``"units"`` attribute back in. It also has an optional ``format`` parameter
+that allows you to specify the formatting type of ``"units"`` attribute. We
+have used the ``format="~P"`` option as it shortens the unit to its
+"short pretty" format (``"eV"``). For more options, see the `Pint formatting
+documentation <https://pint.readthedocs.io/en/stable/user/formatting.html>`_.
+
+.. ipython:: python
+
+    total_particle_energy_ev = total_particle_energy_ev.pint.dequantify(format="~P")
+    total_particle_energy_w = total_particle_energy_w.pint.dequantify(format="~P")
+    total_particle_energy_ev
+
+To confirm the conversion has worked correctly, we can plot the original and
+converted `xarray.Dataset` side by side:
+
+.. ipython:: python
+    
+    fig, ((ax1, ax2), (ax3, ax4)) = plt.subplots(2, 2, figsize=(16,8))
+    ds["Total_Particle_Energy_Electron"].plot(ax=ax1)
+    total_particle_energy_ev.plot(ax=ax2)
+    total_particle_energy_w.plot(ax=ax3)
+    ax4.set_visible(False)
+    fig.suptitle("Comparison of conversion from Joules to electron volts and watts", fontsize="18")
+    @savefig unit_conversion.png width=9in
+    fig.tight_layout()

{sdf_xarray-0.3.0 → sdf_xarray-0.3.1}/src/sdf_xarray/__init__.py

@@ -1,3 +1,4 @@
+import contextlib
 import os
 import re
 from collections import Counter, defaultdict
@@ -18,10 +19,16 @@ from xarray.core import indexing
 from xarray.core.utils import close_on_error, try_read_magic_number_from_path
 from xarray.core.variable import Variable
 
-# NOTE: Do not delete this line, otherwise the "epoch" accessor will not be
-# imported when the user imports sdf_xarray
+# NOTE: Do not delete these lines, otherwise the "epoch" dataset and dataarray
+# accessors will not be imported when the user imports sdf_xarray
+import sdf_xarray.dataset_accessor
 import sdf_xarray.plotting  # noqa: F401
 
+# NOTE: This attempts to initialise with the "pint" accessor if the user
+# has installed the package
+with contextlib.suppress(ImportError):
+    import pint_xarray  # noqa: F401
+
 from .sdf_interface import Constant, SDFFile  # type: ignore  # noqa: PGH003
 
 # TODO Remove this once the new kwarg options are fully implemented

{sdf_xarray-0.3.0 → sdf_xarray-0.3.1}/src/sdf_xarray/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.3.0'
-__version_tuple__ = version_tuple = (0, 3, 0)
+__version__ = version = '0.3.1'
+__version_tuple__ = version_tuple = (0, 3, 1)
 
-__commit_id__ = commit_id = 'gcca942b3f'
+__commit_id__ = commit_id = 'gce5426d4a'

sdf_xarray-0.3.1/src/sdf_xarray/dataset_accessor.py

@@ -0,0 +1,73 @@
+from typing import Union
+
+import xarray as xr
+
+
+@xr.register_dataset_accessor("epoch")
+class EpochAccessor:
+    def __init__(self, xarray_obj: xr.Dataset):
+        # The xarray object is the Dataset, which we store as self._ds
+        self._ds = xarray_obj
+
+    def rescale_coords(
+        self,
+        multiplier: float,
+        unit_label: str,
+        coord_names: Union[str, list[str]],
+    ) -> xr.Dataset:
+        """
+        Rescales specified X and Y coordinates in the Dataset by a given multiplier
+        and updates the unit label attribute.
+
+        Parameters
+        ----------
+        multiplier : float
+            The factor by which to multiply the coordinate values (e.g., 1e6 for meters to microns).
+        unit_label : str
+            The new unit label for the coordinates (e.g., "µm").
+        coord_names : str or list of str
+            The name(s) of the coordinate variable(s) to rescale.
+            If a string, only that coordinate is rescaled.
+            If a list, all listed coordinates are rescaled.
+
+        Returns
+        -------
+        xr.Dataset
+            A new Dataset with the updated and rescaled coordinates.
+
+        Examples
+        --------
+        # Convert X, Y, and Z from meters to microns
+        >>> ds_in_microns = ds.epoch.rescale_coords(1e6, "µm", coord_names=["X_Grid", "Y_Grid", "Z_Grid"])
+
+        # Convert only X to millimeters
+        >>> ds_in_mm = ds.epoch.rescale_coords(1000, "mm", coord_names="X_Grid")
+        """
+
+        ds = self._ds
+        new_coords = {}
+
+        if isinstance(coord_names, str):
+            # Convert single string to a list
+            coords_to_process = [coord_names]
+        elif isinstance(coord_names, list):
+            # Use the provided list
+            coords_to_process = coord_names
+        else:
+            coords_to_process = list(coord_names)
+
+        for coord_name in coords_to_process:
+            if coord_name not in ds.coords:
+                raise ValueError(
+                    f"Coordinate '{coord_name}' not found in the Dataset. Cannot rescale."
+                )
+
+            coord_original = ds[coord_name]
+
+            coord_rescaled = coord_original * multiplier
+            coord_rescaled.attrs = coord_original.attrs.copy()
+            coord_rescaled.attrs["units"] = unit_label
+
+            new_coords[coord_name] = coord_rescaled
+
+        return ds.assign_coords(new_coords)

sdf_xarray-0.3.1/tests/example_files_3D/input.deck

@@ -0,0 +1,54 @@
+begin:control
+  nx = 64
+  ny = 64
+  nz = 64
+
+  # Final time of simulation
+  t_end = 5 * femto
+
+  # Size of domain
+  x_min = 0
+  x_max = 5.0e5
+
+  y_min = 0
+  y_max = 5.0e5
+
+  z_min = 0
+  z_max = 5.0e5
+
+  stdout_frequency = 1
+end:control
+
+
+begin:boundaries
+  bc_x_min = periodic
+  bc_x_max = periodic
+  bc_y_min = periodic
+  bc_y_max = periodic
+  bc_z_min = periodic
+  bc_z_max = periodic
+end:boundaries
+
+
+begin:species
+  name = electron
+  charge = -1
+  mass = 1.0
+  temperature_x = 273
+  number_density = 10
+  nparticles = nx * ny * nz * 2
+end:species
+
+begin:output_global
+    force_last_to_be_restartable = F
+end:output_global
+
+begin:output
+  name = normal
+
+  dt_snapshot = 1 * femto
+
+  grid = always
+
+end:output
+

sdf_xarray-0.3.1/tests/test_epoch_dataset_accessor.py

@@ -0,0 +1,146 @@
+import pathlib
+
+import numpy as np
+import pytest
+import xarray as xr
+
+from sdf_xarray import open_mfdataset
+
+EXAMPLE_FILES_DIR = pathlib.Path(__file__).parent / "example_files_3D"
+
+
+def test_rescale_coords_X():
+    multiplier = 1e3
+    unit_label = "mm"
+
+    with xr.open_dataset(EXAMPLE_FILES_DIR / "0000.sdf") as ds:
+        ds_rescaled = ds.epoch.rescale_coords(
+            multiplier=multiplier,
+            unit_label=unit_label,
+            coord_names="X_Grid_mid",
+        )
+
+        expected_x = ds["X_Grid_mid"].values * multiplier
+        assert np.allclose(ds_rescaled["X_Grid_mid"].values, expected_x)
+        assert ds_rescaled["X_Grid_mid"].attrs["units"] == unit_label
+        assert ds_rescaled["X_Grid_mid"].attrs["long_name"] == "X"
+        assert ds_rescaled["X_Grid_mid"].attrs["full_name"] == "Grid/Grid_mid"
+
+        assert np.allclose(ds_rescaled["Y_Grid_mid"].values, ds["Y_Grid_mid"].values)
+        assert ds_rescaled["Y_Grid_mid"].attrs["units"] == "m"
+        assert ds_rescaled["Y_Grid_mid"].attrs["long_name"] == "Y"
+        assert ds_rescaled["Y_Grid_mid"].attrs["full_name"] == "Grid/Grid_mid"
+
+        assert np.allclose(ds_rescaled["Z_Grid_mid"].values, ds["Z_Grid_mid"].values)
+        assert ds_rescaled["Z_Grid_mid"].attrs["units"] == "m"
+        assert ds_rescaled["Z_Grid_mid"].attrs["long_name"] == "Z"
+        assert ds_rescaled["Z_Grid_mid"].attrs["full_name"] == "Grid/Grid_mid"
+
+
+def test_rescale_coords_X_Y():
+    multiplier = 1e2
+    unit_label = "cm"
+
+    with xr.open_dataset(EXAMPLE_FILES_DIR / "0000.sdf") as ds:
+        ds_rescaled = ds.epoch.rescale_coords(
+            multiplier=multiplier,
+            unit_label=unit_label,
+            coord_names=["X_Grid_mid", "Y_Grid_mid"],
+        )
+
+        expected_x = ds["X_Grid_mid"].values * multiplier
+        assert np.allclose(ds_rescaled["X_Grid_mid"].values, expected_x)
+        assert ds_rescaled["X_Grid_mid"].attrs["units"] == unit_label
+        assert ds_rescaled["X_Grid_mid"].attrs["long_name"] == "X"
+        assert ds_rescaled["X_Grid_mid"].attrs["full_name"] == "Grid/Grid_mid"
+
+        expected_y = ds["Y_Grid_mid"].values * multiplier
+        assert np.allclose(ds_rescaled["Y_Grid_mid"].values, expected_y)
+        assert ds_rescaled["Y_Grid_mid"].attrs["units"] == unit_label
+        assert ds_rescaled["Y_Grid_mid"].attrs["long_name"] == "Y"
+        assert ds_rescaled["Y_Grid_mid"].attrs["full_name"] == "Grid/Grid_mid"
+
+        assert np.allclose(ds_rescaled["Z_Grid_mid"].values, ds["Z_Grid_mid"].values)
+        assert ds_rescaled["Z_Grid_mid"].attrs["units"] == "m"
+        assert ds_rescaled["Z_Grid_mid"].attrs["long_name"] == "Z"
+        assert ds_rescaled["Z_Grid_mid"].attrs["full_name"] == "Grid/Grid_mid"
+
+
+def test_rescale_coords_X_Y_tuple():
+    multiplier = 1e2
+    unit_label = "cm"
+
+    with xr.open_dataset(EXAMPLE_FILES_DIR / "0000.sdf") as ds:
+        ds_rescaled = ds.epoch.rescale_coords(
+            multiplier=multiplier,
+            unit_label=unit_label,
+            coord_names=("X_Grid_mid", "Y_Grid_mid"),
+        )
+
+        expected_x = ds["X_Grid_mid"].values * multiplier
+        assert np.allclose(ds_rescaled["X_Grid_mid"].values, expected_x)
+        assert ds_rescaled["X_Grid_mid"].attrs["units"] == unit_label
+        assert ds_rescaled["X_Grid_mid"].attrs["long_name"] == "X"
+        assert ds_rescaled["X_Grid_mid"].attrs["full_name"] == "Grid/Grid_mid"
+
+        expected_y = ds["Y_Grid_mid"].values * multiplier
+        assert np.allclose(ds_rescaled["Y_Grid_mid"].values, expected_y)
+        assert ds_rescaled["Y_Grid_mid"].attrs["units"] == unit_label
+        assert ds_rescaled["Y_Grid_mid"].attrs["long_name"] == "Y"
+        assert ds_rescaled["Y_Grid_mid"].attrs["full_name"] == "Grid/Grid_mid"
+
+        assert np.allclose(ds_rescaled["Z_Grid_mid"].values, ds["Z_Grid_mid"].values)
+        assert ds_rescaled["Z_Grid_mid"].attrs["units"] == "m"
+        assert ds_rescaled["Z_Grid_mid"].attrs["long_name"] == "Z"
+        assert ds_rescaled["Z_Grid_mid"].attrs["full_name"] == "Grid/Grid_mid"
+
+
+def test_rescale_coords_attributes_copied():
+    multiplier = 1e6
+    unit_label = "µm"
+
+    with xr.open_dataset(EXAMPLE_FILES_DIR / "0000.sdf") as ds:
+        ds_rescaled = ds.epoch.rescale_coords(
+            multiplier=multiplier,
+            unit_label=unit_label,
+            coord_names=["X_Grid_mid"],
+        )
+
+        assert ds_rescaled["X_Grid_mid"].attrs["units"] == unit_label
+        assert ds_rescaled["X_Grid_mid"].attrs["long_name"] == "X"
+        assert ds_rescaled["X_Grid_mid"].attrs["full_name"] == "Grid/Grid_mid"
+
+
+def test_rescale_coords_non_existent_coord():
+    with xr.open_dataset(EXAMPLE_FILES_DIR / "0000.sdf") as ds:
+        with pytest.raises(ValueError, match="Coordinate 'Time' not found"):
+            ds.epoch.rescale_coords(
+                multiplier=1.0,
+                unit_label="s",
+                coord_names="Time",
+            )
+
+        with pytest.raises(ValueError, match="Coordinate 'Bad_Coord' not found"):
+            ds.epoch.rescale_coords(
+                multiplier=1e6,
+                unit_label="µm",
+                coord_names=["X_Grid_mid", "Bad_Coord"],
+            )
+
+
+def test_rescale_coords_time():
+    multiplier = 1e-15
+    unit_label = "fs"
+
+    with open_mfdataset(EXAMPLE_FILES_DIR.glob("*.sdf")) as ds:
+        ds_rescaled = ds.epoch.rescale_coords(
+            multiplier=multiplier,
+            unit_label=unit_label,
+            coord_names="time",
+        )
+
+        expected_time = ds["time"].values * multiplier
+        assert np.allclose(ds_rescaled["time"].values, expected_time)
+        assert ds_rescaled["time"].attrs["units"] == unit_label
+        assert ds_rescaled["time"].attrs["long_name"] == "Time"
+        assert ds_rescaled["time"].attrs["full_name"] == "time"