K3D-tools / K3D-jupyter

K3D lets you create 3D plots backed by WebGL with high-level API (surfaces, isosurfaces, voxels, mesh, cloud points, vtk objects, volume renderer, colormaps, etc). The primary aim of K3D-jupyter is to be easy for use as stand alone package like matplotlib, but also to allow interoperation with existing libraries as VTK.
MIT License
917 stars 123 forks source link

Installation instructions #373

Closed renefritze closed 1 year ago

renefritze commented 1 year ago

The README mentions enabling the extensions. The docs do not mention that. From my understanding the manual enabling should indeed no longer be necessary. Is my understanding correct?

There's also an (I guess orphaned?) https://github.com/K3D-tools/K3D-jupyter/blob/main/postBuild which has the enabling in it.

renefritze commented 1 year ago

https://github.com/K3D-tools/K3D-jupyter/blob/main/environment.yml Should also no longer be used after the binder/ subdir was added, right?

tennysontbardwell commented 1 year ago

Between #371 and this (#373) I had a difficult time debugging. In my env (Debian 11 Docker, newest python/debian/etc) the line jupyter labextension install k3d would consistently fail, citing:

$ webpack --config webpack.prod.minimize.config.js
[webpack-cli] ModuleNotFoundError: Module not found: Error: Can't resolve 'k3d/dist/labplugin' in '/home/admin/venv_/share/jupyter/lab/staging/build'

I would have been fine, except I was also trying to deal with #371, and this threw me for a loop

renefritze commented 1 year ago

Between #371 and this (#373) I had a difficult time debugging. In my env (Debian 11 Docker, newest python/debian/etc) the line jupyter labextension install k3d would consistently fail, citing:

$ webpack --config webpack.prod.minimize.config.js
[webpack-cli] ModuleNotFoundError: Module not found: Error: Can't resolve 'k3d/dist/labplugin' in '/home/admin/venv_/share/jupyter/lab/staging/build'

I also see this in my stack: full log

oursland commented 1 year ago

I have trouble with and without the labextension commands. When I perform an install, JupyterLab prompts me to perform a build, which the k3d extension always fails as above.

As of this week I also cannot seem to get the notebook extension to work anymore.

artur-trzesiok commented 1 year ago

Please try 2.15.0 (https://pypi.org/project/k3d/ for conda-forge we need to wait a little bit). @renefritze contribution should solve that

https://github.com/K3D-tools/K3D-jupyter/blob/main/environment.yml Should also no longer be used after the binder/ subdir was added, right?

It should not. I will try to remove it soon.

The README mentions enabling the extensions. The docs do not mention that. From my understanding the manual enabling should indeed no longer be necessary. Is my understanding correct?

There's also an (I guess orphaned?) https://github.com/K3D-tools/K3D-jupyter/blob/main/postBuild which has the enabling in it.

I'm not sure. Probably if you are using conda it is not. In case of pip probably enabling extension is mandatory.

renefritze commented 1 year ago

While working on #386 I found that both for jupyterlab and classic notebook extensions do not need to be manually enabled .

artur-trzesiok commented 1 year ago

Great! So We should remove instructions from readm.md then!

artur-trzesiok commented 1 year ago

@renefritze do you think that we can close that issue?

renefritze commented 1 year ago

Yeah. Thanks!