update notebooks, docstrings

chrishavlin · chrishavlin · commit fbaec5e06adc · 2024-05-20T14:47:42.000-05:00
diff --git a/.gitignore b/.gitignore
@@ -107,3 +107,6 @@ ENV/
 
 # temp files
 *.swp
+
+# other configs
+imgui.ini
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -12,7 +12,7 @@ Example Notebooks
     examples/example_006_yt_method_access
     examples/example_007_interpolation
     examples/example_008_interpolation_with_refinement
-    examples/example_010_custom_transformations
+    examples/example_009_custom_transformations
 
 These notebooks demonstrate `yt_xarray` usage:
 
@@ -24,4 +24,4 @@ These notebooks demonstrate `yt_xarray` usage:
 - Example 006: :doc:`examples/example_006_yt_method_access`
 - Example 007: :doc:`examples/example_007_interpolation`
 - Example 008: :doc:`examples/example_008_interpolation_with_refinement`
-- Example 010: :doc:`examples/example_010_custom_transformations`
+- Example 010: :doc:`examples/example_009_custom_transformations`
diff --git a/docs/examples/example_008_interpolation_with_refinement.ipynb b/docs/examples/example_008_interpolation_with_refinement.ipynb
diff --git a/docs/examples/example_009_custom_transformations.ipynb b/docs/examples/example_009_custom_transformations.ipynb
@@ -214,23 +214,6 @@
    "source": [
     "Additionally, as long as your custom transformer transforms to and from 3D cartesian coordinates and if the \"native\" coordinates match an xarray dataset field's dimensions, **you can hand off your custom transformer to `build_interpolated_cartesian_ds`** and build a yt cartesian dataset that reads and interpolates from an arbitrary coordinate system! "
    ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "fb1249fa-fcca-4fff-b0e5-5757cd6a3c81",
-   "metadata": {},
-   "source": [
-    "### Custom interpolations\n",
-    "\n"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "45203947-4152-4e68-a12f-274f8ee1a978",
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
diff --git a/docs/examples/example_009_interpolated_in_yt_idv.py b/docs/examples/example_009_interpolated_in_yt_idv.py
diff --git a/yt_xarray/transformations.py b/yt_xarray/transformations.py
@@ -492,6 +492,11 @@ def build_interpolated_cartesian_ds(
         if refine_grid is True, max iterations for grid refinement (default 200)
     refine_min_grid_size:
         if refine_grid is True, minimum number of elements in refined grid (default 10)
+    refinement_method:
+        One of 'division' (the default) or 'signature_filter'. If 'division', refinement
+        will proceed by iterative bisection in each dimension. If 'signature_filter',
+        will use the image mask signature decomposition of Berger and Rigoutsos 1991
+        (https://doi.org/10.1109/21.120081).
     interp_method: str
         interpolation method: 'nearest' or 'interpolate'. Defaults to 'nearest'.
         If 'interpolate', will use linear nd interpolation.
