Make the repository "notebook.link ready"#1281
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds support for notebook.link to enable users to open leafmap example notebooks live in a browser-based JupyterLite environment with all dependencies pre-installed.
Changes:
- Added notebook.link badge to README.md
- Created
.nblink/environment.ymldefining the conda environment with leafmap and its dependencies for the emscripten-wasm32 platform - Created
.nblink/nblink-lock.jsonlock file containing resolved package specifications for reproducible environments
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Added notebook.link badge for easy access to live notebooks |
| .nblink/environment.yml | Defines conda environment with xeus-python kernel and leafmap dependencies |
| .nblink/nblink-lock.json | Lock file with resolved package versions for the emscripten-wasm32 platform |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| [](https://studiolab.sagemaker.aws/import/github/opengeos/leafmap/blob/master/examples/notebooks/00_key_features.ipynb) | ||
| [](https://colab.research.google.com/github/opengeos/leafmap/blob/master) | ||
| [](https://notebook.link/github/opengeos/leafmap/tree/master/lab/) |
There was a problem hiding this comment.
The badge URL points to /tree/master/lab/ but there doesn't appear to be a lab directory in the repository. According to the PR description, this is meant to allow people to open leafmap example notebooks from https://notebook.link/github/opengeos/leafmap/tree/master/lab/.
However, based on the repository structure, notebooks are located in examples/notebooks/ or docs/notebooks/, not in a lab/ directory. The URL should likely point to one of these existing directories, such as:
https://notebook.link/github/opengeos/leafmap/tree/master/examples/https://notebook.link/github/opengeos/leafmap/tree/master/docs/notebooks/
Please verify that the URL is correct and points to an existing directory containing the notebooks, or ensure that the lab/ directory is created in this PR if that's the intended structure.
| [](https://notebook.link/github/opengeos/leafmap/tree/master/lab/) | |
| [](https://notebook.link/github/opengeos/leafmap/tree/master/examples/notebooks/) |
There was a problem hiding this comment.
Indeed let's point to the example notebooks directory. But the suggested change by copilot is wrong.
giswqs
left a comment
giswqs
left a comment
There was a problem hiding this comment.
Awesome! Thank you very much for this.
* Make the repository nblink-ready * Update * Add README badge * Point to the first Notebook
This will allow people to open leafmap example notebooks live in https://notebook.link/github/opengeos/leafmap/tree/master/lab/ with a working environment and leafmap already installed.
@giswqs I'm happy to make any change to the
environment.ymlfile if you think there are too many packages or missing ones.