sdf-xarray 0.3.0__cp313-cp313-macosx_11_0_arm64.whl → 0.3.1__cp313-cp313-macosx_11_0_arm64.whl

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/_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/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.0.dist-info → sdf_xarray-0.3.1.dist-info}/METADATA

@@ -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.0.dist-info → sdf_xarray-0.3.1.dist-info}/RECORD

@@ -1,8 +1,3 @@
-sdf_xarray-0.3.0.dist-info/RECORD,,
-sdf_xarray-0.3.0.dist-info/WHEEL,sha256=RKB2kgklE3rgz0xlIuKYm-O5gcSzEoMvCOiEOfbYfDs,141
-sdf_xarray-0.3.0.dist-info/entry_points.txt,sha256=gP7BIQpXNg6vIf7S7p-Rw_EJZTC1X50BsVTkK7dA7g0,57
-sdf_xarray-0.3.0.dist-info/METADATA,sha256=q9WJBhz2Su52p14Q6b1ZBJRjCeepN7yfao9PdVnVbtU,7582
-sdf_xarray-0.3.0.dist-info/licenses/LICENCE,sha256=0FfLVWQRQERtj0vUKjJk7-UrDp-t70Et9izWejGe4Os,1487
 include/SDFC_14.4.7/sdf_derived.h,sha256=VqRsCmjmSRIOGqZSiPMsvmNaFBoNzXhrlKeyWGYIzm8,636
 include/SDFC_14.4.7/sdf_helper.h,sha256=UD291Xf8ZUeh34iv-qLN-u8f5vPQz0joTFxIQWUIVYA,1020
 include/SDFC_14.4.7/sdf_vector_type.h,sha256=5tcQcF7zDm7kTkLCzm12G5Z3ARVXvw7-XpKQ6WWej6U,1527
@@ -11,14 +6,20 @@ include/SDFC_14.4.7/sdf_extension.h,sha256=my_ze10hSGfWEQEaUWh8TxFuVsiAl-g6aDn6q
 include/SDFC_14.4.7/uthash.h,sha256=BN_4JfPHloW0kI3VRhvCqP8D2VcvD0HpSLgo4MBz6Sk,62067
 include/SDFC_14.4.7/sdf.h,sha256=8RWP2yH8xn_sCcbqZPT443LBaPy_3SHjOxA6IL4xLzE,24996
 include/SDFC_14.4.7/sdf_list_type.h,sha256=WEq5Qmtv00-A7lmLadxC7RbFy46yLYRgg0LynCGk4PE,1350
-lib/SDFC_14.4.7/libsdfc.a,sha256=fIHG7DX-uLb2B-FycaAN8aI1H5fp_-fqoweEUJlVqMY,601592
+sdf_xarray-0.3.1.dist-info/RECORD,,
+sdf_xarray-0.3.1.dist-info/WHEEL,sha256=RKB2kgklE3rgz0xlIuKYm-O5gcSzEoMvCOiEOfbYfDs,141
+sdf_xarray-0.3.1.dist-info/entry_points.txt,sha256=gP7BIQpXNg6vIf7S7p-Rw_EJZTC1X50BsVTkK7dA7g0,57
+sdf_xarray-0.3.1.dist-info/METADATA,sha256=mrPI14CcIsMK4vux_WZ66CKaLWuuZKkk5nGb-ZBUpi0,7582
+sdf_xarray-0.3.1.dist-info/licenses/LICENCE,sha256=0FfLVWQRQERtj0vUKjJk7-UrDp-t70Et9izWejGe4Os,1487
+lib/SDFC_14.4.7/libsdfc.a,sha256=w0ir47TKx6Aow2oG81FIFJNukdUv0q-PpuciBOpm8mo,601592
 lib/SDFC_14.4.7/SDFCTargets-release.cmake,sha256=Xq-QJnH563tMRWlM5o2wdMSm9EiSKXru4U4hlR-eXlo,811
 lib/SDFC_14.4.7/SDFCTargets.cmake,sha256=dCkmSqqjFrXSW2HJxHZ4sDmPQa7uU-mBhhtdfE9SC9w,4047
 lib/SDFC_14.4.7/SDFCConfig.cmake,sha256=QQOXXHTYSEzXXckN8CCi9vuhMmirf2MrOA8b3tY4m2A,784
 lib/SDFC_14.4.7/SDFCConfigVersion.cmake,sha256=2dR0eWIHiMKSdOwWBD9kI6EA-1mvVZsn61d50hSazkE,2765
-sdf_xarray/_version.py,sha256=tVAyi08Mj_h5a-I-GlfgSkJxb9j3A_JL5E2Nkv6jFMk,712
+sdf_xarray/_version.py,sha256=jl4nbj6ZrLINb7SYW2_PbCiEV62Yzz6EVjeJD_oEnzQ,712
 sdf_xarray/plotting.py,sha256=FJWmBas1wkwlGeP-nRILIiFPDjBXKGZ4OE4NAauKWMw,6836
+sdf_xarray/dataset_accessor.py,sha256=Ihq0mFTNe_guDrHFlCkt0BhGtyRJQEWChUFGFerTKl0,2411
 sdf_xarray/sdf_interface.pyx,sha256=tYvVkp7PVrzhF4iFxUvDy4EoTSZzJmXOJ0OM_DDXG98,11635
-sdf_xarray/__init__.py,sha256=fSQFs6ygI7xGGkUnezPb3UhGvYn5kFqYB5pzMueEsYY,20002
-sdf_xarray/sdf_interface.cpython-313-darwin.so,sha256=w2s-U7wGHX62T6meIvGCylgkIbM9Ue7bcgb5ILvmIOU,401664
+sdf_xarray/__init__.py,sha256=Uy4eAMuVYOKK6fFDnAK2B8u52DFCMWgfD_tvUH5aBJU,20258
+sdf_xarray/sdf_interface.cpython-313-darwin.so,sha256=XKKRpks9fD20zNJ_lxPhIHd8fk3uiMwsvWzIgKqKmC0,401664
 sdf_xarray/csdf.pxd,sha256=6VCmPTbvKOQt3O-r1R1Gj-GvQJ2pOUeSRnkxgMLBvy0,4078