Make description for development of keplergl-jupyter more accessible to beginners #2848
Conversation
kopp
commented
Dec 20, 2024
kopp
commented
- Factor development setup into DEVELOPMENT.md
- Add a preface describing the different technologies used
✅ Deploy Preview for keplergl2 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: Michael Kopp <[email protected]>
kopp
force-pushed
the
make-keplergl-jupyter-docs-more-accessible-for-beginners
branch
from
d9c1e22 to
0f1981e
Compare
|
I do not really get it: |
| To build without a local server that watches for changes, use | ||
|
|
||
| ```shell | ||
| yarn build |
There was a problem hiding this comment.
this does not work for me -- should it?
There was a problem hiding this comment.
when I use yarn start, I end up with a labextension that errors out with 'Failed to load model class 'KeplerGlModal' from module 'keplergl-jupyter'`, is that because something is missing in the build?
|
|
||
| ```shell | ||
| pip install -e . # in this folder | ||
| cd js && jupyter labextension develop . --overwrite |
There was a problem hiding this comment.
this fails for me as well -- build in js works but develop in this directory fails.
|
Can someone who actively works on the plugin please suggest improvements? I am unable to build/use the plugin. |
|
The issue "Failed to load model class" should be fixed in #2588. However, this PR has not been merged yet. So, can you try to test it using that pr? Also, I've noticed the jupyter kernels are very easy to be misconfigured for jupyter notebook / jupyter lab. Can you run the test using the docker file: bindings/kepler.gl-jupyter/Dockerfile in that pr? Thanks! |
There was a problem hiding this comment.
Thanks @kopp! I think the easy way to setup the dev environment is using the docker. Here is one in the repo: https://github.com/keplergl/kepler.gl/blob/master/bindings/kepler.gl-jupyter/Dockerfile
I also create docker images with keplergl-jupyter (v0.3.6). You can run the following command:
Run the docker under your notebook directory
docker run -v $(pwd):/notebooks --rm -p 8888:8888/tcp lixun910/keplergl-jupyter:latestRun your notebooks in browser with the token which you can see in the terminal or log e.g.
http://127.0.0.1:8888/tree?token=f5be411ce5567b49baaaa80977f100aa4819d61fd66d3559The repo is here: https://github.com/lixun910/kepler-jupyter-docker
bindings/kepler.gl-jupyter/js/.nvmrc
Outdated
There was a problem hiding this comment.
I think we don't need this file, since the project uses volta (see root level package.json). Can you delete this file? Thanks!
