sal-xarray 0.1.0__tar.gz → 0.2.0__tar.gz

{sal_xarray-0.1.0/sal_xarray.egg-info → sal_xarray-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sal-xarray
-Version: 0.1.0
+Version: 0.2.0
 Summary: SAL backend for xarray
 Author-email: Samuel Jackson <samuel.jackson@ukaea.uk>
 Maintainer-email: Samuel Jackson <samuel.jackson@ukaea.uk>
@@ -44,6 +44,14 @@ Or using `uv`:
 uv pip install sal-xarray
 ```
 
+JET data access requires a VPN connection to the JDC. You will also require a config file at `~/.sal/credentials` with the following content:
+
+```toml
+[https://sal.jetdata.eu]
+user=<user-name>
+password=<password>
+```
+
 ## Usage
 
 Open a SAL dataset using xarray:

{sal_xarray-0.1.0 → sal_xarray-0.2.0}/README.md

@@ -24,6 +24,14 @@ Or using `uv`:
 uv pip install sal-xarray
 ```
 
+JET data access requires a VPN connection to the JDC. You will also require a config file at `~/.sal/credentials` with the following content:
+
+```toml
+[https://sal.jetdata.eu]
+user=<user-name>
+password=<password>
+```
+
 ## Usage
 
 Open a SAL dataset using xarray:

{sal_xarray-0.1.0 → sal_xarray-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sal-xarray"
-version = "0.1.0"
+version = "0.2.0"
 description = "SAL backend for xarray"
 readme = "README.md"
 requires-python = ">=3.11, <3.13"
@@ -48,7 +48,7 @@ dev = [
 sal = "sal_xarray.main:SALBackendEntrypoint"
 
 [tool.bumpversion]
-current_version = "0.1.0"
+current_version = "0.2.0"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{sal_xarray-0.1.0 → sal_xarray-0.2.0}/sal_xarray/main.py

@@ -100,7 +100,8 @@ class SALBackendEntrypoint(BackendEntrypoint):
         return data
 
     def open_datatree(self, filename_or_obj, *, drop_variables=None):
-        self.open_dataset(filename_or_obj, drop_variables=drop_variables)
+        dataset = self.open_dataset(filename_or_obj, drop_variables=drop_variables)
+        return xr.DataTree(dataset)
 
     def open_groups_as_dict(self, filename_or_obj, **kwargs):
         """Open groups as a dictionary (not supported for SAL backend)."""

{sal_xarray-0.1.0 → sal_xarray-0.2.0/sal_xarray.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sal-xarray
-Version: 0.1.0
+Version: 0.2.0
 Summary: SAL backend for xarray
 Author-email: Samuel Jackson <samuel.jackson@ukaea.uk>
 Maintainer-email: Samuel Jackson <samuel.jackson@ukaea.uk>
@@ -44,6 +44,14 @@ Or using `uv`:
 uv pip install sal-xarray
 ```
 
+JET data access requires a VPN connection to the JDC. You will also require a config file at `~/.sal/credentials` with the following content:
+
+```toml
+[https://sal.jetdata.eu]
+user=<user-name>
+password=<password>
+```
+
 ## Usage
 
 Open a SAL dataset using xarray:

{sal_xarray-0.1.0 → sal_xarray-0.2.0}/tests/test_backend.py

@@ -181,6 +181,45 @@ class TestSALBackendEntrypoint:
             ds = backend.open_dataset(f"sal://pulse/{shot_num}/signal_name")
             assert ds["data"].attrs["shot_id"] == shot_num
 
+    def test_open_datatree(self, mock_sal_client, mock_signal):
+        """Test opening a datatree with the SAL backend."""
+        backend = SALBackendEntrypoint()
+        dt = backend.open_datatree("sal://pulse/12345/signal_name")
+
+        # Check that a DataTree was created
+        assert isinstance(dt, xr.DataTree)
+
+        # Check that dataset is at root
+        assert "/" in dt.groups
+        ds = dt["/"].ds
+
+        # Check dataset contents
+        assert isinstance(ds, xr.Dataset)
+        assert "data" in ds.data_vars
+        assert "status" in ds.data_vars
+
+        # Check dimensions
+        assert "time" in ds.dims
+        assert ds.sizes["time"] == 5
+
+        # Check data values
+        np.testing.assert_array_equal(ds["data"].values, mock_signal.data)
+
+    def test_open_datatree_with_drop_variables(self, mock_sal_client):
+        """Test opening a datatree with drop_variables parameter."""
+        backend = SALBackendEntrypoint()
+        dt = backend.open_datatree(
+            "sal://pulse/12345/signal_name", drop_variables="status"
+        )
+
+        # Check that DataTree was created
+        assert isinstance(dt, xr.DataTree)
+
+        # The drop_variables parameter is passed through but not implemented
+        # in the current backend, so this just verifies it doesn't error
+        ds = dt["/"].ds
+        assert isinstance(ds, xr.Dataset)
+
 
 class TestXarrayIntegration:
     """Test integration with xarray's open_dataset function."""
@@ -194,3 +233,16 @@ class TestXarrayIntegration:
         assert isinstance(ds, xr.Dataset)
         assert "data" in ds.data_vars
         assert "status" in ds.data_vars
+
+    def test_xr_open_datatree_with_engine(self, mock_sal_client):
+        """Test using xr.open_datatree with engine='sal'."""
+        # This test requires the backend to be registered
+        # In practice, this happens via entry_points in pyproject.toml
+        dt = xr.open_datatree("sal://pulse/12345/signal_name", engine="sal")
+
+        assert isinstance(dt, xr.DataTree)
+        assert "/" in dt.groups
+        ds = dt["/"].ds
+        assert isinstance(ds, xr.Dataset)
+        assert "data" in ds.data_vars
+        assert "status" in ds.data_vars