Merge pull request #11 from haesleinhuepf/assist

Assist
haesleinhuepf · Jan 1, 2023 · 7b2a827 · 7b2a827
2 parents 9711acd + 670d656
commit 7b2a827
Show file tree

Hide file tree

Showing 22 changed files with 30,410 additions and 3,181 deletions.
diff --git a/README.md b/README.md
@@ -186,6 +186,19 @@ my_gaussian(image[60], 2)
 
 ![img.png](https://raw.githubusercontent.com/haesleinhuepf/stackview/main/docs/images/jupyter_displayable_output.png)
 
+### Assist
+
+The `stackview.assist()` function can guide you through all imported (and supported) image processing functions.
+Note: The interface may be slow or crash if you have many functions imported. Consider using it in an empty notebook 
+with only functions or library imported that might be relevant for the taks.
+
+```python
+stackview.assist(context=globals(), continuous_update=True)
+```
+
+![img.png](https://raw.githubusercontent.com/haesleinhuepf/stackview/main/docs/images/demo_assist.gif)
+
+
 ## Contributing
 
 Contributions, bug-reports and ideas for further development are very welcome.