Skip to content

Commit beafcb1

Browse files
committed
Minor documentation improvements
1 parent 0afc417 commit beafcb1

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

JupyterNotebooks/JupyterNotebooksLib/widgets.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,10 @@ def _handle_upload(self, change=None, a=None, b=None):
130130
print('Uploaded {0} ({1} bytes)'.format(self.filename, metadata['size']))
131131

132132
class AppWindow(IFrame):
133+
"""Shows interactive screen of a remote desktop session. Requires remte desktop view configured to be displayed at ../desktop URL.
134+
If multiple kernels are used then the sceen space is shared between them. Make application window full-screen and call `show()`
135+
to ensure that current window is on top.
136+
"""
133137
def __init__(self, contents=None, windowScale=None, windowWidth=None, windowHeight=None, **kwargs):
134138
# Set default size to fill in notebook cell
135139
if kwargs.get('width', None) is None:

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Extension for 3D Slicer that allows the application to be used from Jupyter note
99

1010
You can use this option for a quick start. No installation or setup is needed, just click the link below and start using Slicer via Jupyter notebook in your web browser.
1111

12-
[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/slicer/SlicerNotebooks/master)
12+
[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/lassoan/SlicerNotebooks/Slicer-4.11-20200515)
1313

1414
When you click on the link, Binder launches 3D Slicer with SlicerJupyter extension on their cloud servers. Binder is a free service and server resources are quite limited. Also, there is no interactive access to the graphical user interface. Therefore, this option is only recommended for testing, demos, or simple computations or visualizations.
1515

@@ -22,10 +22,22 @@ When you click on the link, Binder launches 3D Slicer with SlicerJupyter extensi
2222
* You can choose any Python version and any bitness (Python 3, 64-bit is recommended)
2323
* Adding Python to your PATH environment variable or registering as default Python is not required
2424
* Install [3D Slicer](https://download.slicer.org/), start it, and install SlicerJupyter extension in its Extension Manager, restart 3D Slicer
25+
* Install Python packages in 3D Slicer's Python console by copy-pasting these lines:
26+
```
27+
import os
28+
if os.name=='nt':
29+
# There are no official pyzmq wheels for Python-3.6 for Windows, so we have to install manually
30+
pip_install("https://files.pythonhosted.org/packages/94/e1/13059383d21444caa16306b48c8bf7a62331ca361d553d2119696ea67119/pyzmq-19.0.0-cp36-cp36m-win_amd64.whl")
31+
else:
32+
# PIL may be corrupted on linux, reinstall from pillow
33+
pip_install('--upgrade pillow --force-reinstall')
34+
pip_install("ipywidgets pandas ipyevents ipycanvas")
35+
```
2536
* Install Slicer jupyter kernel
2637
* Switch to JupyterKernel module in 3D Slicer
2738
* Click "Copy command to clipboard" to copy the kernel installation command to the clipboard
2839
* Start a command prompt in the Python environment where Jupyter is installed, and paste and run the kernel installation command
40+
* Install Python packages for dynamic Slicer views display by running these commands in the installed Python environment: `python -m pip install jupyter ipywidgets pandas ipycanvas ipyevents`
2941
* Start Jupyter notebook. For example, by runnning _jupyter-notebook_ executable.
3042

3143
See video of installation steps using Anaconda here:

0 commit comments

Comments
 (0)