Skip to content

Commit

Permalink
add link to the new slicing nb
Browse files Browse the repository at this point in the history
  • Loading branch information
chrishavlin committed Aug 4, 2023
1 parent 6adfe36 commit b641f9b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
14 changes: 10 additions & 4 deletions docs/examples/ytnapari_scene_03_slices.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -430,7 +436,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.16"
"version": "3.9.0"
}
},
"nbformat": 4,
Expand Down
2 changes: 2 additions & 0 deletions docs/notebooks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`

0 comments on commit b641f9b

Please sign in to comment.