Skip to content

Commit

Permalink
docs(demos): make dependencies explicit
Browse files Browse the repository at this point in the history 
add admonition about dependencies for local running
  • Loading branch information
@JorisVincent
JorisVincent committed May 10, 2023
1 parent 6983f90 commit c3b0a0e
Show file tree
Hide file tree
Showing 33 changed files with 419 additions and 232 deletions.
17 changes: 10 additions & 7 deletions docs/reference/demos/components/angulars.md
View file
Expand Up @@ -12,26 +12,27 @@ kernelspec:
name: python3
---

```{important}
```{tip}
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/components/angulars.md)
to get interactivity
```
```{attention}
To run locally, the code for these interactive demos requires
a [Jupyter Notebook](https://jupyter.org/) environment,
and the [Jupyter Widgets extension (`ipywidgets`)](https://ipywidgets.readthedocs.io/en/latest/index.html).
```

# Components - Angulars
{py:mod}`stimupy.components.angulars`

```{code-cell} ipython3
:tags: [remove-cell]

import IPython
import ipywidgets as iw
from stimupy.utils import plot_stim
```

## Wedge
{py:func}`stimupy.components.angulars.wedge`

```{code-cell} ipython3
import ipywidgets as iw
from stimupy.utils import plot_stim
from stimupy.components.angulars import wedge
# Define widgets
Expand Down Expand Up @@ -112,6 +113,8 @@ display(ui, out)
{py:func}`stimupy.components.angulars.segments`

```{code-cell} ipython3
import ipywidgets as iw
from stimupy.utils import plot_stim
from stimupy.components.angulars import segments
# Define widgets
Expand Down
19 changes: 12 additions & 7 deletions docs/reference/demos/components/edges.md
View file
Expand Up @@ -12,26 +12,27 @@ kernelspec:
name: python3
---

```{important}
```{tip}
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/components/edges.md)
to get interactivity
```
```{attention}
To run locally, the code for these interactive demos requires
a [Jupyter Notebook](https://jupyter.org/) environment,
and the [Jupyter Widgets extension (`ipywidgets`)](https://ipywidgets.readthedocs.io/en/latest/index.html).
```

# Components - Edges
{py:mod}`stimupy.components.edges`

```{code-cell} ipython3
:tags: [remove-cell]

import IPython
import ipywidgets as iw
from stimupy.utils import plot_stim
```

## Step edge
{py:func}`stimupy.components.edges.step`

```{code-cell} ipython3
import ipywidgets as iw
from stimupy.utils import plot_stim
from stimupy.components.edges import step
# Define widgets
Expand Down Expand Up @@ -92,6 +93,8 @@ display(ui, out)
{py:func}`stimupy.components.edges.gaussian`

```{code-cell} ipython3
import ipywidgets as iw
from stimupy.utils import plot_stim
from stimupy.components.edges import gaussian
# Define widgets
Expand Down Expand Up @@ -161,6 +164,8 @@ display(ui, out)
{py:func}`stimupy.components.edges.cornsweet`

```{code-cell} ipython3
import ipywidgets as iw
from stimupy.utils import plot_stim
from stimupy.components.edges import cornsweet
# Define widgets
Expand Down
15 changes: 8 additions & 7 deletions docs/reference/demos/components/frames.md
View file
Expand Up @@ -12,26 +12,27 @@ kernelspec:
name: python3
---

```{important}
```{tip}
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/components/frames.md)
to get interactivity
```
```{attention}
To run locally, the code for these interactive demos requires
a [Jupyter Notebook](https://jupyter.org/) environment,
and the [Jupyter Widgets extension (`ipywidgets`)](https://ipywidgets.readthedocs.io/en/latest/index.html).
```

# Components - Frames
{py:mod}`stimupy.components.frames`

```{code-cell} ipython3
:tags: [remove-cell]

import IPython
import ipywidgets as iw
from stimupy.utils import plot_stim
```

## Frames
{py:func}`stimupy.components.frames.frames`

```{code-cell} ipython3
import ipywidgets as iw
from stimupy.utils import plot_stim
from stimupy.components.frames import frames
# Define widgets
Expand Down
15 changes: 8 additions & 7 deletions docs/reference/demos/components/gaussians.md
View file
Expand Up @@ -12,26 +12,27 @@ kernelspec:
name: python3
---

```{important}
```{tip}
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/components/gaussians.md)
to get interactivity
```
```{attention}
To run locally, the code for these interactive demos requires
a [Jupyter Notebook](https://jupyter.org/) environment,
and the [Jupyter Widgets extension (`ipywidgets`)](https://ipywidgets.readthedocs.io/en/latest/index.html).
```

# Components - Gaussians
{py:mod}`stimupy.components.gaussians`

```{code-cell} ipython3
:tags: [remove-cell]

import IPython
import ipywidgets as iw
from stimupy.utils import plot_stim
```

## Gaussian
{py:func}`stimupy.components.gaussians.gaussian`

```{code-cell} ipython3
import ipywidgets as iw
from stimupy.utils import plot_stim
from stimupy.components.gaussians import gaussian
# Define widgets
Expand Down
21 changes: 14 additions & 7 deletions docs/reference/demos/components/lines.md
View file
Expand Up @@ -12,26 +12,27 @@ kernelspec:
name: python3
---

```{important}
```{tip}
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/components/lines.md)
to get interactivity
```
```{attention}
To run locally, the code for these interactive demos requires
a [Jupyter Notebook](https://jupyter.org/) environment,
and the [Jupyter Widgets extension (`ipywidgets`)](https://ipywidgets.readthedocs.io/en/latest/index.html).
```

# Components - Lines
{py:mod}`stimupy.components.lines`

```{code-cell} ipython3
:tags: [remove-cell]

import IPython
import ipywidgets as iw
from stimupy.utils import plot_stim
```

## Line
{py:func}`stimupy.components.lines.line`

```{code-cell} ipython3
import ipywidgets as iw
from stimupy.utils import plot_stim
from stimupy.components.lines import line
# Define widgets
Expand Down Expand Up @@ -116,6 +117,8 @@ display(ui, out)
{py:func}`stimupy.components.lines.dipole`

```{code-cell} ipython3
import ipywidgets as iw
from stimupy.utils import plot_stim
from stimupy.components.lines import dipole
# Define widgets
Expand Down Expand Up @@ -189,6 +192,8 @@ display(ui, out)
{py:func}`stimupy.components.lines.ellipse`

```{code-cell} ipython3
import ipywidgets as iw
from stimupy.utils import plot_stim
from stimupy.components.lines import ellipse
# Define widgets
Expand Down Expand Up @@ -258,6 +263,8 @@ display(ui, out)
{py:func}`stimupy.components.lines.circle`

```{code-cell} ipython3
import ipywidgets as iw
from stimupy.utils import plot_stim
from stimupy.components.lines import circle
# Define widgets
Expand Down
19 changes: 12 additions & 7 deletions docs/reference/demos/components/radials.md
View file
Expand Up @@ -12,26 +12,27 @@ kernelspec:
name: python3
---

```{important}
```{tip}
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/components/radials.md)
to get interactivity
```
```{attention}
To run locally, the code for these interactive demos requires
a [Jupyter Notebook](https://jupyter.org/) environment,
and the [Jupyter Widgets extension (`ipywidgets`)](https://ipywidgets.readthedocs.io/en/latest/index.html).
```

# Components - Radials
{py:mod}`stimupy.components.radials`

```{code-cell} ipython3
:tags: [remove-cell]

import IPython
import ipywidgets as iw
from stimupy.utils import plot_stim
```

## Disc
{py:func}`stimupy.components.radials.disc`

```{code-cell} ipython3
import ipywidgets as iw
from stimupy.utils import plot_stim
from stimupy.components.radials import disc
# Define widgets
Expand Down Expand Up @@ -96,6 +97,8 @@ display(ui, out)
{py:func}`stimupy.components.radials.annulus`

```{code-cell} ipython3
import ipywidgets as iw
from stimupy.utils import plot_stim
from stimupy.components.radials import annulus
# Define widgets
Expand Down Expand Up @@ -166,6 +169,8 @@ display(ui, out)
{py:func}`stimupy.components.radials.rings`

```{code-cell} ipython3
import ipywidgets as iw
from stimupy.utils import plot_stim
from stimupy.components.radials import rings
# Define widgets
Expand Down

0 comments on commit c3b0a0e

Please sign in to comment.