feat!: Rename AnyNiivue to Niivue (#65)

niivue · May 30, 2024 · 69f1a57 · 69f1a57
1 parent dfea903
commit 69f1a57
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -14,9 +14,9 @@ pip install ipyniivue
 In a Jupyter environment:
 
 ```py
-from ipyniivue import AnyNiivue
+from ipyniivue import NiiVue
 
-nv = AnyNiivue()
+nv = NiiVue()
 nv.load_volumes([{"path": "images/mni152.nii.gz"}])
 nv
 ```

diff --git a/demo/additive_voxels.ipynb b/demo/additive_voxels.ipynb
@@ -18,7 +18,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from ipyniivue import AnyNiivue, SliceType\n",
+    "from ipyniivue import NiiVue, SliceType\n",
     "# based on https://niivue.github.io/niivue/features/additive.voxels.html\n",
     "\n",
     "volumes = [\n",
@@ -36,7 +36,7 @@
     "        \"cal_max\": 4,\n",
     "    },\n",
     "]\n",
-    "nv = AnyNiivue(\n",
+    "nv = NiiVue(\n",
     "    back_color=(1, 1, 1, 1),\n",
     "    show_3D_crosshair=True,\n",
     "    is_colorbar=True,\n",
@@ -78,7 +78,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.2"
+   "version": "3.12.3"
   },
   "widgets": {
    "application/vnd.jupyter.widget-state+json": {

diff --git a/demo/basic_multiplanar.ipynb b/demo/basic_multiplanar.ipynb
@@ -17,15 +17,15 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from ipyniivue import AnyNiivue, SliceType\n",
+    "from ipyniivue import NiiVue, SliceType\n",
     "# based on https://niivue.github.io/niivue/features/basic.multiplanar.html\n",
     "\n",
     "volumes = [\n",
     "  { \"path\": \"../images/mni152.nii.gz\", \"colormap\": \"gray\", \"visible\": True, \"opacity\": 1.0 },\n",
     "  { \"path\": \"../images/hippo.nii.gz\", \"colormap\": \"red\", \"visible\": True, \"opacity\": 1 },\n",
     "\n",
     "]\n",
-    "nv = AnyNiivue(slice_type=SliceType.MULTIPLANAR)\n",
+    "nv = NiiVue(slice_type=SliceType.MULTIPLANAR)\n",
     "nv.load_volumes(volumes)\n",
     "nv"
    ]
@@ -71,7 +71,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.2"
+   "version": "3.12.3"
   },
   "widgets": {
    "application/vnd.jupyter.widget-state+json": {

diff --git a/src/ipyniivue/__init__.py b/src/ipyniivue/__init__.py
@@ -3,6 +3,6 @@
 import importlib.metadata
 
 from ._constants import DragMode, MuliplanarType, SliceType  # noqa: F401
-from ._widget import AnyNiivue  # noqa: F401
+from ._widget import NiiVue  # noqa: F401
 
 __version__ = importlib.metadata.version("ipyniivue")
diff --git a/src/ipyniivue/_widget.py b/src/ipyniivue/_widget.py
@@ -8,7 +8,7 @@
 from ._options_mixin import OptionsMixin
 from ._utils import file_serializer, serialize_options, snake_to_camel
 
-__all__ = ["AnyNiivue"]
+__all__ = ["NiiVue"]
 
 
 class Volume(ipywidgets.Widget):
@@ -22,7 +22,7 @@ class Volume(ipywidgets.Widget):
     cal_max = t.Float(None, allow_none=True).tag(sync=True)
 
 
-class AnyNiivue(OptionsMixin, anywidget.AnyWidget):
+class NiiVue(OptionsMixin, anywidget.AnyWidget):
     """Represents a Niivue instance."""
 
     _esm = pathlib.Path(__file__).parent / "static" / "widget.js"