Document basis for input data (#1124)

desc/compute/utils.py

@@ -53,7 +53,10 @@ def compute(parameterization, names, params, transforms, profiles, data=None, **
         Profile objects for pressure, iota, current, etc. Defaults to attributes
         of self
     data : dict of ndarray
-        Data computed so far, generally output from other compute functions
+        Data computed so far, generally output from other compute functions.
+        Any vector v = v¹ R̂ + v² ϕ̂ + v³ Ẑ should be given in components
+        v = [v¹, v², v³] where R̂, ϕ̂, Ẑ are the normalized basis vectors
+        of the cylindrical coordinates R, ϕ, Z.
 
     Returns
     -------
@@ -121,6 +124,10 @@ def _compute(
 ):
     """Same as above but without checking inputs for faster recursion.
 
+    Any vector v = v¹ R̂ + v² ϕ̂ + v³ Ẑ should be given in components
+    v = [v¹, v², v³] where R̂, ϕ̂, Ẑ are the normalized basis vectors
+    of the cylindrical coordinates R, ϕ, Z.
+
     We need to directly call this function in objectives, since the checks in above
     function are not compatible with JIT. This function computes given names while
     using recursion to compute dependencies. If you want to call this function, you

desc/equilibrium/equilibrium.py

@@ -811,7 +811,10 @@ def compute(
             Profile objects for pressure, iota, current, etc. Defaults to attributes
             of self
         data : dict of ndarray
-            Data computed so far, generally output from other compute functions
+            Data computed so far, generally output from other compute functions.
+            Any vector v = v¹ R̂ + v² ϕ̂ + v³ Ẑ should be given in components
+            v = [v¹, v², v³] where R̂, ϕ̂, Ẑ are the normalized basis vectors
+            of the cylindrical coordinates R, ϕ, Z.
         override_grid : bool
             If True, override the user supplied grid if necessary and use a full
             resolution grid to compute quantities and then downsample to user requested

desc/geometry/core.py

@@ -98,7 +98,10 @@ def compute(
         transforms : dict of Transform
             Transforms for R, Z, lambda, etc. Default is to build from grid
         data : dict of ndarray
-            Data computed so far, generally output from other compute functions
+            Data computed so far, generally output from other compute functions.
+            Any vector v = v¹ R̂ + v² ϕ̂ + v³ Ẑ should be given in components
+            v = [v¹, v², v³] where R̂, ϕ̂, Ẑ are the normalized basis vectors
+            of the cylindrical coordinates R, ϕ, Z.
         override_grid : bool
             If True, override the user supplied grid if necessary and use a full
             resolution grid to compute quantities and then downsample to user requested

desc/geometry/curve.py

@@ -717,7 +717,10 @@ def compute(
         transforms : dict of Transform
             Transforms for R, Z, lambda, etc. Default is to build from grid
         data : dict of ndarray
-            Data computed so far, generally output from other compute functions
+            Data computed so far, generally output from other compute functions.
+            Any vector v = v¹ R̂ + v² ϕ̂ + v³ Ẑ should be given in components
+            v = [v¹, v², v³] where R̂, ϕ̂, Ẑ are the normalized basis vectors
+            of the cylindrical coordinates R, ϕ, Z.
         override_grid : bool
             If True, override the user supplied grid if necessary and use a full
             resolution grid to compute quantities and then downsample to user requested