Merge pull request #108 from computational-psychology/dev

New features, refactoring, and fixes

.github/workflows/version.yml

@@ -10,6 +10,10 @@ jobs:
   bump-version:
     if: (github.event.pull_request.merged == true) || (github.event_name == 'workflow_dispatch')
     runs-on: ubuntu-latest
+    concurrency: bump-version
+    permissions:
+      id-token: write
+      contents: write
 
     steps:
       - name: Checkout repository 
@@ -18,20 +22,14 @@ jobs:
           fetch-depth: 0 # checkout full commit history
           token: ${{ secrets.GHA_Token }}
 
-      - name: Setup Python
-        uses: actions/setup-python@v4
+      - name: Python Semantic Release
+        id: versioning
+        uses: python-semantic-release/python-semantic-release@master
         with:
-          python-version: 3.11
+          github_token: $${{ secrets.GHA_TOKEN }}
 
-      - name: Configure git to be able to push to repo
-        env:
-          GH_TOKEN: ${{ secrets.GHA_Token }}
-        run: |
-          git config user.name token
-          git config user.email token@github.com
-
-      - name: Bump version, build & upload release assets using Semantic Release
-        env:
-          GH_TOKEN: ${{ secrets.GHA_Token }}
-        run: |
-          pipx run python-semantic-release publish -v DEBUG
+      - name: Publish package distributions to GitHub Releases
+        uses: python-semantic-release/upload-to-gh-release@main
+        if: steps.versioning.outputs.released == 'true'
+        with:
+          github_token: ${{ secrets.GHA_TOKEN }}

.pre-commit-config.yaml

@@ -1,19 +1,19 @@
 repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.3.1
+    rev: v3.10.1
     hooks:
     -   id: pyupgrade
 
   - repo: https://github.com/psf/black
-    rev: stable
+    rev: 23.7.0
     hooks:
     - id: black
       additional_dependencies: [".[jupyter]"]
       language_version: python3
 
   - repo: https://github.com/PyCQA/flake8
-    rev: "6.0.0"
+    rev: "6.1.0"
     hooks:
       - id: flake8
         # Ignore all format-related checks as Black takes care of those.
-        args: ["--ignore", "E2,W5,E501,F403", "--select", "E,W,F", '--per-file-ignores=__init__.py:F401,F405,E402', '--exclude','tests/*']
+        args: ["--ignore", "E203,E501,W503,F403", "--select", "E,W,F", '--per-file-ignores=__init__.py:F401,F405,E402', '--exclude','tests/*']

docs/reference/demos/components/texts.md

@@ -0,0 +1,106 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+    format_version: 0.13
+    jupytext_version: 1.14.5
+kernelspec:
+  display_name: Python 3 (ipykernel)
+  language: python
+  name: python3
+---
+
+```{tip}
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/computational-psychology/stimupy/HEAD?urlpath=lab/tree/docs/reference/demos/components/texts.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 - Texts
+{py:mod}`stimupy.components.texts`
+
+
+## Text
+{py:func}`stimupy.components.texts.text`
+
+```{code-cell} ipython3
+import ipywidgets as iw
+from stimupy.utils import plot_stim
+from stimupy.components.texts import text
+
+# Define widgets
+w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")
+w_width = iw.IntSlider(value=10, min=1, max=20, description="width [deg]")
+w_ppd = iw.IntSlider(value=20, min=1, max=40, description="ppd")
+
+w_int = iw.FloatSlider(value=1., min=0, max=1, description="intensity line")
+w_int_back = iw.FloatSlider(value=0., min=0, max=1, description="intensity background")
+
+w_text = iw.Textarea(value='Hello World', placeholder='Type something', description='text')
+w_fontsize = iw.IntSlider(value=30, min=1, max=60, description="fontsize")
+w_align = iw.Dropdown(value="center", options=['left', 'center', 'right'], description="align")
+w_direction = iw.Dropdown(value="ltr", options=['ltr', 'rtl'], description="direction")
+
+w_mask = iw.ToggleButton(value=False, disabled=False, description="add mask")
+
+# Layout
+b_im_size = iw.HBox([w_height, w_width, w_ppd])
+b_text = iw.HBox([w_text, w_fontsize, w_align, w_direction])
+b_intensities = iw.HBox([w_int, w_int_back])
+b_add = iw.HBox([w_mask])
+ui = iw.VBox([b_im_size, b_text, b_intensities, b_add])
+
+# Function for showing stim
+def show_text(
+    height=None,
+    width=None,
+    ppd=None,
+    str_text=None,
+    intensity_text=None,
+    intensity_background=None,
+    fontsize=None,
+    align=None,
+    direction=None,
+    add_mask=False,
+):
+    try:
+        stim = text(
+            text=str_text,
+            visual_size=(height, width),
+            ppd=ppd,
+            intensity_text=intensity_text,
+            intensity_background=intensity_background,
+            fontsize=fontsize,
+            align=align,
+            direction=direction,
+        )
+        plot_stim(stim, mask=add_mask)
+    except Exception as e:
+        raise ValueError(f"Invalid parameter combination: {e}") from None    
+
+# Set interactivity
+out = iw.interactive_output(
+    show_text,
+    {
+        "height": w_height,
+        "width": w_width,
+        "ppd": w_ppd,
+        "str_text": w_text,
+        "intensity_text": w_int,
+        "intensity_background": w_int_back,
+        "fontsize": w_fontsize,
+        "align": w_align,
+        "direction": w_direction,
+        "add_mask": w_mask,
+    },
+)
+
+# Show
+display(ui, out)
+```

docs/reference/demos/stimuli/bullseyes.md

@@ -115,6 +115,99 @@ out = iw.interactive_output(
 display(ui, out)
 ```
 
+## Circular bullseye, generalized
+{py:func}`stimupy.stimuli.bullseyes.circular_generalized`
+
+```{code-cell} ipython3
+import ipywidgets as iw
+from stimupy.utils import plot_stim
+from stimupy.stimuli.bullseyes import circular_generalized
+
+# Define widgets
+w_height = iw.IntSlider(value=10, min=1, max=20, description="height [deg]")
+w_width = iw.IntSlider(value=10, min=1, max=20, description="width [deg]")
+w_ppd = iw.IntSlider(value=20, min=1, max=40, description="ppd")
+
+w_radius1 = iw.FloatSlider(value=1, min=0, max=2, description="radius1 [deg]")
+w_radius2 = iw.FloatSlider(value=2, min=1, max=3, description="radius2 [deg]")
+w_radius3 = iw.FloatSlider(value=3, min=2, max=4, description="radius2 [deg]")
+
+w_int1 = iw.FloatSlider(value=1, min=0, max=1, description="int-ring1")
+w_int2 = iw.FloatSlider(value=0.3, min=0, max=1, description="int-ring2")
+w_int3 = iw.FloatSlider(value=0.8, min=0, max=1, description="int-ring3")
+w_int_back = iw.FloatSlider(value=0., min=0, max=1, description="intensity background")
+
+w_ori = iw.Dropdown(value="center", options=['mean', 'corner', 'center'], description="origin")
+w_rot = iw.FloatSlider(value=0, min=0, max=360, description="rotation [deg]")
+w_mask = iw.Dropdown(value=None, options=[None, 'target_mask', 'ring_mask'], description="add mask")
+
+w_tint = iw.FloatSlider(value=0.5, min=0, max=1, description="target int")
+
+# Layout
+b_im_size = iw.HBox([w_height, w_width, w_ppd])
+b_geometry = iw.HBox([w_radius1, w_radius2, w_radius3])
+b_intensities = iw.HBox([w_int1, w_int2, w_int3, w_int_back])
+b_target = iw.HBox([w_tint])
+b_add = iw.HBox([w_ori, w_rot, w_mask])
+ui = iw.VBox([b_im_size, b_geometry, b_intensities, b_target, b_add])
+
+# Function for showing stim
+def show_circular_generalized(
+    height=None,
+    width=None,
+    ppd=None,
+    radius1=None,
+    radius2=None,
+    radius3=None,
+    int1=None,
+    int2=None,
+    int3=None,
+    intensity_background=None,
+    origin=None,
+    add_mask=False,
+    intensity_target=None,
+    rotation=0.0,
+):
+    try:
+        stim = circular_generalized(
+            visual_size=(height, width),
+            ppd=ppd,
+            radii=(radius1, radius2, radius3),
+            intensity_rings=(int1, int2, int3),
+            intensity_background=intensity_background,
+            origin=origin,
+            intensity_target=intensity_target,
+        )
+        plot_stim(stim, mask=add_mask)
+    except Exception as e:
+        raise ValueError(f"Invalid parameter combination: {e}") from None
+
+# Set interactivity
+out = iw.interactive_output(
+    show_circular_generalized,
+    {
+        "height": w_height,
+        "width": w_width,
+        "ppd": w_ppd,
+        "radius1": w_radius1,
+        "radius2": w_radius2,
+        "radius3": w_radius3,
+        "int1": w_int1,
+        "int2": w_int2,
+        "int3": w_int3,
+        "intensity_background": w_int_back,
+        "origin": w_ori,
+        "add_mask": w_mask,
+        "intensity_target": w_tint,
+        "rotation": w_rot,
+    },
+)
+
+# Show
+display(ui, out)
+```
+
+
 
 ## Circular, Two-sided
 {py:func}`stimupy.stimuli.bullseyes.circular_two_sided`
@@ -139,14 +232,15 @@ w_int_back = iw.FloatSlider(value=0.5, min=0, max=1, description="int background
 w_ori = iw.Dropdown(value="mean", options=['mean', 'corner', 'center'], description="origin")
 w_mask = iw.Dropdown(value=None, options=[None, 'target_mask', 'ring_mask'], description="add mask")
 
-w_tint = iw.FloatSlider(value=0.5, min=0, max=1, description="target int")
+w_tint_l = iw.FloatSlider(value=0.5, min=0, max=1, description="left target int")
+w_tint_r = iw.FloatSlider(value=0.5, min=0, max=1, description="right target int")
 
 # Layout
 b_im_size = iw.HBox([w_height, w_width, w_ppd])
 b_geometry = iw.HBox([w_freq, w_phase])
 b_intensities = iw.HBox([w_int1, w_int2, w_int_back])
 b_add = iw.HBox([w_ori, w_mask])
-b_target = iw.HBox([w_tint])
+b_target = iw.HBox([w_tint_l, w_tint_r])
 ui = iw.VBox([b_im_size, b_geometry, b_intensities, b_target, b_add])
 
 # Function for showing stim
@@ -161,18 +255,19 @@ def show_two_sided_bullseye(
     intensity_background=None,
     origin=None,
     add_mask=False,
-    intensity_target=None,
+    intensity_target_l=None,
+    intensity_target_r=None,
 ):
     try:
         stim = circular_two_sided(
             visual_size=(height, width),
             ppd=ppd,
             frequency=frequency,
             phase_shift=phase_shift,
-            intensity_rings=(int1, int2),
+            intensity_rings=((int1, int2),(int2, int1)),
             intensity_background=intensity_background,
             origin=origin,
-            intensity_target=intensity_target,
+            intensity_target=(intensity_target_l, intensity_target_r),
         )
         plot_stim(stim, mask=add_mask)
     except Exception as e:
@@ -192,7 +287,8 @@ out = iw.interactive_output(
         "intensity_background": w_int_back,
         "origin": w_ori,
         "add_mask": w_mask,
-        "intensity_target": w_tint,
+        "intensity_target_l": w_tint_l,
+        "intensity_target_r": w_tint_r,
     },
 )
 
@@ -409,13 +505,14 @@ w_rot = iw.FloatSlider(value=0, min=0, max=360, description="rotation [deg]")
 
 w_mask = iw.Dropdown(value=None, options=[None, 'target_mask', 'frame_mask'], description="add mask")
 
-w_tint = iw.FloatSlider(value=0.5, min=0, max=1, description="target int")
+w_tint_l = iw.FloatSlider(value=0.5, min=0, max=1, description="left target int")
+w_tint_r = iw.FloatSlider(value=0.5, min=0, max=1, description="right target int")
 
 # Layout
 b_im_size = iw.HBox([w_height, w_width, w_ppd])
 b_geometry = iw.HBox([w_freq, w_phase])
 b_intensities = iw.HBox([w_int1, w_int2, w_int_back])
-b_target = iw.HBox([w_tint])
+b_target = iw.HBox([w_tint_l, w_tint_r])
 b_add = iw.HBox([w_rot, w_mask])
 ui = iw.VBox([b_im_size, b_geometry, b_intensities, b_target, b_add])
 
@@ -430,7 +527,8 @@ def show_rectangular_two_sided(
     int2=None,
     intensity_background=None,
     add_mask=False,
-    intensity_target=None,
+    intensity_target_l=None,
+    intensity_target_r=None,
     rotation=0.0,
 ):
     try:
@@ -439,9 +537,9 @@ def show_rectangular_two_sided(
             ppd=ppd,
             frequency=frequency,
             phase_shift=phase_shift,
-            intensity_frames=(int1, int2),
+            intensity_frames=((int1, int2),(int2, int1)),
             intensity_background=intensity_background,
-            intensity_target=intensity_target,
+            intensity_target=(intensity_target_l, intensity_target_r),
             rotation=rotation,
         )
         plot_stim(stim, mask=add_mask)
@@ -461,7 +559,8 @@ out = iw.interactive_output(
         "int2": w_int2,
         "intensity_background": w_int_back,
         "add_mask": w_mask,
-        "intensity_target": w_tint,
+        "intensity_target_l": w_tint_l,
+        "intensity_target_r": w_tint_r,
         "rotation": w_rot,
     },
 )