Merge pull request #266 from boutproject/plot3d

3d plotting

Author: johnomotani

setup.cfg

@@ -50,6 +50,10 @@ calc =
     xrft
     xhistogram
 docs = sphinx >= 1.4
+3d_plot =
+    k3d >= 2.8.0
+    mayavi >= 4.7.2
+    wand
 
 [build_sphinx]
 project = $metadata.name

xbout/boutdataarray.py

@@ -385,6 +385,9 @@ def interpolate_parallel(
 
         return da
 
+    def add_cartesian_coordinates(self):
+        return _add_cartesian_coordinates(self.data)
+
     def add_cartesian_coordinates(self):
         """
         Add Cartesian (X,Y,Z) coordinates.
@@ -1077,3 +1080,20 @@ def plot_regions(self, ax=None, **kwargs):
         tokamak topology.
         """
         return plotfuncs.plot_regions(self.data, ax=ax, **kwargs)
+
+    def plot3d(self, ax=None, **kwargs):
+        """
+        Make a 3d plot
+
+        Warnings
+        --------
+
+        3d plotting functionality is still a bit of a work in progress. Bugs are likely, and
+        help developing is welcome!
+
+        Parameters
+        ----------
+
+        See plotfuncs.plot3d()
+        """
+        return plotfuncs.plot3d(self.data, **kwargs)

xbout/boutdataset.py

@@ -266,6 +266,9 @@ def find_with_dims(first_var, dims):
 
         return ds
 
+    def add_cartesian_coordinates(self):
+        return _add_cartesian_coordinates(self.data)
+
     def integrate_midpoints(self, variable, *, dims=None, cumulative_t=False):
         """
         Integrate using the midpoint rule for spatial dimensions, and trapezium rule for