Merge pull request #70 from chrishavlin/slice_docs

add the new sclicing notebook to the docs

HISTORY.md

@@ -1,17 +1,15 @@
 ## v0.1.0
 
 This release includes some non-backwards compatible changes to the schema. Old
-json files will need to be updated.
+json files will need to be updated. The main change is that with the addition of
+adding 2D slices, the region selection from v0.0.1 has been nested within a
+`SelectionObject` level.
 
 ### New Features
 
-* load 2D slices and 3D regions
+* can now load 2D slices
 * widget reader redesign: add multiple selections!
 * yt dataset cacheing to speed up subsequent loads
 * improved logging
 * test infrastructure updates
 * improved development maintenance scripts
-
-## v0.1.0
-
-Changes

docs/examples/ytnapari_scene_03_slices.ipynb

@@ -408,10 +408,16 @@
    "source": [
     "## Limitations\n",
     "\n",
-    "At present, `yt_napari` will not attempt to align slices along different axes, so if you add a second slice along a different axis, it will simply overlay as a new 2D image layer. You'll be able to work with the layers in napari, but compositing or 3D views is not recommended.\n",
-    "\n",
-    "Further, 2d and 3d `yt_napari` image layers cannot presently mixed, so if you try to add a slice to an existing scene with a 3D region, `yt_napari` will error."
+    "At present, `yt_napari` will not attempt to align slices along different axes, so if you add a second slice along a different axis or add a 3D region, it will simply overlay as a new 2D image layer. You'll be able to work with the layers in napari, but compositing or 3D views may be difficult or incorrectly aligned."
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "917693c1-ebd5-483d-9bc9-2c1574777149",
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
@@ -430,7 +436,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.16"
+   "version": "3.9.0"
   }
  },
  "nbformat": 4,

docs/notebooks.rst

@@ -6,8 +6,10 @@ Example Notebooks
 
     examples/ytnapari_scene_01_intro
     examples/ytnapari_scene_02_linking_layers
+    examples/ytnapari_scene_03_slices
 
 These notebooks demonstrate some of the helper methods available in :code:`yt-napari` for adding new :code:`yt` image layers to a :code:`napari` GUI:
 
 - :doc:`examples/ytnapari_scene_01_intro`
 - :doc:`examples/ytnapari_scene_02_linking_layers`
+- :doc:`examples/ytnapari_scene_03_slices`