Auto-rename illusions -> stimuli

docs/reference/api.md

@@ -5,7 +5,7 @@
    :recursive:
 
    stimupy.components
-   stimupy.illusions
+   stimupy.stimuli
    stimupy.noises
    stimupy.utils
    stimupy.papers

docs/reference/demos/stimuli/benarys.md

@@ -13,12 +13,12 @@ kernelspec:
 ---
 
 ```{important}
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/illusions/benarys.md)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/stimuli/benarys.md)
  to get interactivity
 ```
 
-# Illusions - Benarys
-{py:mod}`stimupy.illusions.benarys`
+# Stimuli - Benary's cross
+{py:mod}`stimupy.stimuli.benarys`
 
 ```{code-cell} ipython3
 :tags: [remove-cell]
@@ -28,11 +28,11 @@ import ipywidgets as iw
 from stimupy.utils import plot_stim
 ```
 
-## Cross generalized
-{py:func}`stimupy.illusions.benarys.cross_generalized`
+## Cross, generalized
+{py:func}`stimupy.stimuli.benarys.cross_generalized`
 
 ```{code-cell} ipython3
-from stimupy.illusions.benarys import cross_generalized
+from stimupy.stimuli.benarys import cross_generalized
 
 # Define widgets
 w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")
@@ -121,11 +121,11 @@ out = iw.interactive_output(
 display(ui, out)
 ```
 
-## Cross rectangles
-{py:func}`stimupy.illusions.benarys.cross_rectangles`
+## Cross, rectangles
+{py:func}`stimupy.stimuli.benarys.cross_rectangles`
 
 ```{code-cell} ipython3
-from stimupy.illusions.benarys import cross_rectangles
+from stimupy.stimuli.benarys import cross_rectangles
 
 # Define widgets
 w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")
@@ -197,10 +197,10 @@ display(ui, out)
 ```
 
 ## Cross triangles
-{py:func}`stimupy.illusions.benarys.cross_triangles`
+{py:func}`stimupy.stimuli.benarys.cross_triangles`
 
 ```{code-cell} ipython3
-from stimupy.illusions.benarys import cross_triangles
+from stimupy.stimuli.benarys import cross_triangles
 
 # Define widgets
 w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")
@@ -269,10 +269,10 @@ display(ui, out)
 ```
 
 ## Todorovic generalized
-{py:func}`stimupy.illusions.benarys.todorovic_generalized`
+{py:func}`stimupy.stimuli.benarys.todorovic_generalized`
 
 ```{code-cell} ipython3
-from stimupy.illusions.benarys import todorovic_generalized
+from stimupy.stimuli.benarys import todorovic_generalized
 
 # Define widgets
 w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")
@@ -362,10 +362,10 @@ display(ui, out)
 ```
 
 ## Todorovic rectangles
-{py:func}`stimupy.illusions.benarys.todorovic_rectangles`
+{py:func}`stimupy.stimuli.benarys.todorovic_rectangles`
 
 ```{code-cell} ipython3
-from stimupy.illusions.benarys import todorovic_rectangles
+from stimupy.stimuli.benarys import todorovic_rectangles
 
 # Define widgets
 w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")
@@ -437,10 +437,10 @@ display(ui, out)
 ```
 
 ## Todorovic triangles
-{py:func}`stimupy.illusions.benarys.todorovic_triangles`
+{py:func}`stimupy.stimuli.benarys.todorovic_triangles`
 
 ```{code-cell} ipython3
-from stimupy.illusions.benarys import todorovic_triangles
+from stimupy.stimuli.benarys import todorovic_triangles
 
 # Define widgets
 w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")

docs/reference/demos/stimuli/checkerboards.md

@@ -13,12 +13,12 @@ kernelspec:
 ---
 
 ```{important}
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/illusions/checkerboards.md)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/stimuli/checkerboards.md)
  to get interactivity
 ```
 
-# Illusions - Checkerboards
-{py:mod}`stimupy.illusions.checkerboards`
+# Stimuli - Checkerboards
+{py:mod}`stimupy.stimuli.checkerboards`
 
 ```{code-cell} ipython3
 :tags: [remove-cell]
@@ -29,10 +29,10 @@ from stimupy.utils import plot_stim
 ```
 
 ## Checkerboard
-{py:func}`stimupy.illusions.checkerboards.checkerboard`
+{py:func}`stimupy.stimuli.checkerboards.checkerboard`
 
 ```{code-cell} ipython3
-from stimupy.illusions.checkerboards import checkerboard
+from stimupy.stimuli.checkerboards import checkerboard
 
 # Define widgets
 w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")
@@ -123,10 +123,10 @@ display(ui, out)
 ```
 
 ## Contrast-contrast
-{py:func}`stimupy.illusions.checkerboards.contrast_contrast`
+{py:func}`stimupy.stimuli.checkerboards.contrast_contrast`
 
 ```{code-cell} ipython3
-from stimupy.illusions.checkerboards import contrast_contrast
+from stimupy.stimuli.checkerboards import contrast_contrast
 
 # Define widgets
 w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")

docs/reference/demos/stimuli/circulars.md

@@ -13,12 +13,12 @@ kernelspec:
 ---
 
 ```{important}
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/illusions/circulars.md)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/stimuli/circulars.md)
  to get interactivity
 ```
 
-# Illusions - Circulars
-{py:mod}`stimupy.illusions.circulars`
+# Stimuli - Circulars
+{py:mod}`stimupy.stimuli.circulars`
 
 ```{code-cell} ipython3
 :tags: [remove-cell]
@@ -29,10 +29,10 @@ from stimupy.utils import plot_stim
 ```
 
 ## Rings
-{py:func}`stimupy.illusions.circulars.rings`
+{py:func}`stimupy.stimuli.circulars.rings`
 
 ```{code-cell} ipython3
-from stimupy.illusions.circulars import rings
+from stimupy.stimuli.circulars import rings
 
 # Define widgets
 w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")
@@ -116,10 +116,10 @@ display(ui, out)
 ```
 
 ## Two-sided rings
-{py:func}`stimupy.illusions.circulars.two_sided_rings`
+{py:func}`stimupy.stimuli.circulars.two_sided_rings`
 
 ```{code-cell} ipython3
-from stimupy.illusions.circulars import two_sided_rings
+from stimupy.stimuli.circulars import two_sided_rings
 
 # Define widgets
 w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")
@@ -199,10 +199,10 @@ display(ui, out)
 ```
 
 ## Bullseye
-{py:func}`stimupy.illusions.circulars.bullseye`
+{py:func}`stimupy.stimuli.circulars.bullseye`
 
 ```{code-cell} ipython3
-from stimupy.illusions.circulars import bullseye
+from stimupy.stimuli.circulars import bullseye
 
 # Define widgets
 w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")
@@ -282,10 +282,10 @@ display(ui, out)
 ```
 
 ## Two-sided rings
-{py:func}`stimupy.illusions.circulars.two_sided_bullseye`
+{py:func}`stimupy.stimuli.circulars.two_sided_bullseye`
 
 ```{code-cell} ipython3
-from stimupy.illusions.circulars import two_sided_bullseye
+from stimupy.stimuli.circulars import two_sided_bullseye
 
 # Define widgets
 w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")

docs/reference/demos/stimuli/cornsweets.md

@@ -13,12 +13,12 @@ kernelspec:
 ---
 
 ```{important}
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/illusions/cornsweets.md)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/stimuli/cornsweets.md)
  to get interactivity
 ```
 
-# Illusions - Cornsweets
-{py:mod}`stimupy.illusions.cornsweets`
+# Stimuli - Cornsweets
+{py:mod}`stimupy.stimuli.cornsweets`
 
 ```{code-cell} ipython3
 :tags: [remove-cell]
@@ -29,10 +29,10 @@ from stimupy.utils import plot_stim
 ```
 
 ## Cornsweet
-{py:func}`stimupy.illusions.cornsweets.cornsweet`
+{py:func}`stimupy.stimuli.cornsweets.cornsweet`
 
 ```{code-cell} ipython3
-from stimupy.illusions.cornsweets import cornsweet
+from stimupy.stimuli.cornsweets import cornsweet
 
 # Define widgets
 w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")

docs/reference/demos/stimuli/cubes.md

@@ -13,12 +13,12 @@ kernelspec:
 ---
 
 ```{important}
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/illusions/cubes.md)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/stimuli/cubes.md)
  to get interactivity
 ```
 
-# Illusions - Cubes
-{py:mod}`stimupy.illusions.cubes`
+# Stimuli - Cubes
+{py:mod}`stimupy.stimuli.cubes`
 
 ```{code-cell} ipython3
 :tags: [remove-cell]
@@ -29,10 +29,10 @@ from stimupy.utils import plot_stim
 ```
 
 ## Varying cells
-{py:func}`stimupy.illusions.cubes.varying_cells`
+{py:func}`stimupy.stimuli.cubes.varying_cells`
 
 ```{code-cell} ipython3
-from stimupy.illusions.cubes import varying_cells
+from stimupy.stimuli.cubes import varying_cells
 
 # Define widgets
 w_ppd = iw.IntSlider(value=20, min=1, max=40, description="ppd")
@@ -113,10 +113,10 @@ display(ui, out)
 ```
 
 ## Cube
-{py:func}`stimupy.illusions.cubes.cube`
+{py:func}`stimupy.stimuli.cubes.cube`
 
 ```{code-cell} ipython3
-from stimupy.illusions.cubes import cube
+from stimupy.stimuli.cubes import cube
 
 # Define widgets
 w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")

docs/reference/demos/stimuli/delboeufs.md

@@ -13,12 +13,12 @@ kernelspec:
 ---
 
 ```{important}
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/illusions/delboeufs.md)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/stimuli/delboeufs.md)
  to get interactivity
 ```
 
-# Illusions - Delboeufs
-{py:mod}`stimupy.illusions.delboeufs`
+# Stimuli - Delboeufs
+{py:mod}`stimupy.stimuli.delboeufs`
 
 ```{code-cell} ipython3
 :tags: [remove-cell]
@@ -29,10 +29,10 @@ from stimupy.utils import plot_stim
 ```
 
 ## Delboeuf
-{py:func}`stimupy.illusions.delboeufs.delboeuf`
+{py:func}`stimupy.stimuli.delboeufs.delboeuf`
 
 ```{code-cell} ipython3
-from stimupy.illusions.delboeufs import delboeuf
+from stimupy.stimuli.delboeufs import delboeuf
 
 # Define widgets
 w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")
@@ -105,10 +105,10 @@ display(ui, out)
 ```
 
 ## Two-sided
-{py:func}`stimupy.illusions.delboeufs.two_sided`
+{py:func}`stimupy.stimuli.delboeufs.two_sided`
 
 ```{code-cell} ipython3
-from stimupy.illusions.delboeufs import two_sided
+from stimupy.stimuli.delboeufs import two_sided
 
 # Define widgets
 w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")

docs/reference/demos/stimuli/dungeons.md

@@ -13,12 +13,12 @@ kernelspec:
 ---
 
 ```{important}
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/illusions/dungeons.md)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/stimuli/dungeons.md)
  to get interactivity
 ```
 
-# Illusions - Dungeons
-{py:mod}`stimupy.illusions.dungeons`
+# Stimuli - Dungeons
+{py:mod}`stimupy.stimuli.dungeons`
 
 ```{code-cell} ipython3
 :tags: [remove-cell]
@@ -29,10 +29,10 @@ from stimupy.utils import plot_stim
 ```
 
 ## Dungeon
-{py:func}`stimupy.illusions.dungeons.dungeon`
+{py:func}`stimupy.stimuli.dungeons.dungeon`
 
 ```{code-cell} ipython3
-from stimupy.illusions.dungeons import dungeon
+from stimupy.stimuli.dungeons import dungeon
 
 # Define widgets
 w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")