flekspy 0.2.1__tar.gz → 0.2.2__tar.gz

{flekspy-0.2.1 → flekspy-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flekspy
-Version: 0.2.1
+Version: 0.2.2
 Summary: Python utilities for processing FLEKS data
 Author: Yuxi Chen
 Author-email: yuxichen@umich.edu>, Hongyang Zhou <hyzhou@umich.edu

{flekspy-0.2.1 → flekspy-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "flekspy"
-version = "0.2.1"
+version = "0.2.2"
 description = "Python utilities for processing FLEKS data"
 authors = ["Yuxi Chen <yuxichen@umich.edu>, Hongyang Zhou <hyzhou@umich.edu>"]
 readme = "README.md"

{flekspy-0.2.1 → flekspy-0.2.2}/src/flekspy/idl/idl.py

@@ -5,7 +5,12 @@ import struct
 import yt
 
 from flekspy.util import get_unit
-from flekspy.util import DataContainer1D, DataContainer2D, DataContainer3D
+from flekspy.util import (
+    DataContainer,
+    DataContainer1D,
+    DataContainer2D,
+    DataContainer3D,
+)
 
 x_ = 0
 y_ = 1
@@ -63,7 +68,6 @@ class IDLData(object):
     Example:
     >>> ds = IDLData("3d.out")
     >>> dc2d = ds.get_slice("y", 1)
-    >>> dc3d = ds.get_domain()
     """
 
     def __init__(self, filename="none"):
@@ -123,10 +127,8 @@ class IDLData(object):
         )
         return str
 
-    def get_domain(self) -> DataContainer3D:
-        r"""
-        Returns all the 3D data.
-        """
+    def get_domain(self) -> DataContainer:
+        """Return data as data container."""
         dataSets = {}
         for varname in self.data.name:
             idx = self.data.name.index(varname)
@@ -148,7 +150,7 @@ class IDLData(object):
                     self.data.array[idx, :, :, :], unit, registry=self.registry
                 )
 
-        if self.gencoord:
+        if self.gencoord and self.ndim == 2:
             dc = DataContainer2D(
                 dataSets,
                 np.squeeze(axes[0]),
@@ -193,6 +195,23 @@ class IDLData(object):
 
         return dc
 
+    def get_slice(self, norm, cut_loc) -> DataContainer2D:
+        """Get a 2D slice from the 3D IDL data.
+
+        Args:
+            norm: str
+                The normal direction of the slice from "x", "y" or "z"
+
+            cur_loc: float
+                The position of slicing.
+
+        Return: DataContainer2D
+        """
+        domain = self.get_domain()
+        ds = domain.get_slice(norm, cut_loc)
+
+        return ds
+
     def save_data(self, saveName, saveFormat="ascii"):
         # Currently only support ascii output.
         self.save_ascii_instance(saveName)

{flekspy-0.2.1 → flekspy-0.2.2}/src/flekspy/util/data_container.py

@@ -227,8 +227,7 @@ class DataContainer3D(DataContainer):
         )
 
     def get_slice(self, norm, cut_loc) -> "DataContainer2D":
-        r"""
-        Get a 2D slice from the 3D box data.
+        """Get a 2D slice from the 3D box data.
 
         Args:
             norm: str
@@ -476,7 +475,7 @@ class DataContainer2D(DataContainer):
             var: string
 
         Examples:
-        >>> f, axes = dc.contour("Bx<(50)>(-50) By (np.log(2*{rhos0}))>(-5)", xlim=[-40,-5])
+        >>> f, axes = dc.plot("Bx<(50)>(-50) By (np.log(2*{rhos0}))>(-5)", xlim=[-40,-5])
         >>> dc.add_contour(axes[0,0], "rhos1>1")
         """
 
@@ -532,7 +531,7 @@ class DataContainer2D(DataContainer):
                 It controls the number of streamlines.
 
         Examples:
-        >>> f, axes = dc.contour("Bx<(50)>(-50) By (np.log(2*{rhos0}))>(-5)", xlim=[-40,-5])
+        >>> f, axes = dc.plot("Bx<(50)>(-50) By (np.log(2*{rhos0}))>(-5)", xlim=[-40,-5])
         >>> dc.add_stream(axes[1,0], "Bx", "Bz", density=2)
         """