Viewer mode from Docker

I’m attempting to run the bwalter42/jupyter_cadquery:2.2.0 docker image, and connect to it in viewer mode from VS Code. I’ve been attempting to follow along with what’s described in #40 and #42, but I’m having trouble determining what is still necessary now that it seems the docker image has been updated to a version which has the viewer mode built in.

When I exec into the container and run python I get the following error.

~$ pythonPython 3.8.5 (default, Sep  4 2020, 07:30:14) 
[GCC 7.3.0] :: Anaconda, Inc. on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from jupyter_cadquery.viewer.client import show
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ModuleNotFoundError: No module named 'jupyter_cadquery'

Please let me know if there are instructions I missed for starting in viewer mode, and then connecting from my IDE. Thank you!

[bernhard-42]

When working with the docker container, we need to simulate the jcv command since it is not ootb supported:

1. When you start the docker container also expose the zmq port 5555:

   
   run -it --rm -v $WORKDIR:/home/cq -p 5555:5555 -p 8888:8888 bwalter42/jupyter_cadquery:2.2.0
   

2. Open http://127.0.0.1:8888/lab in your browser

3. Create/open a notebook in Jupyter in the browser and run the following code in the first cell:

   from jupyter_cadquery.viewer.server import start_viewer
   start_viewer()
   

   Now you should see the cad viewer with the logo

4. In your IDE use the show or show_object command. It’ll send the objects to port 5555 of the docker container and show the object in the jupyter cell. Note: There is no need to work in Jupyter, it is only the container for the viewer!

If you have a workdir for the docker command you can reuse this notebook in the next sessions.

The jcv command uses voila (a Jupyter viewer) to automate this for local installations.

[tgrosinger]

Fantastic, I love that I can skip the notebook now and jump right into the model. Thank you.