Updated and organized ipynb examples directory for clarity #872

mapninja · 2025-08-13T23:50:07Z

Resolves Issue #783

Description

moved JGIS files and data sources to /data/ folder.
updated Jupyter notebooks for creating a new JGIS document, exploring data in a map, and opening existing JGIS projects to correct data and file paths.
renamed files for better description & future organization into "paths"

Checklist

PR has a descriptive title and content.
PR description contains references to any issues the PR resolves, e.g. Resolves #XXX.
PR has one of the labels: documentation, bug, enhancement, feature, maintenance
Checks are passing.
Failing lint checks can be resolved with:
- pre-commit run --all-files
- jlpm run lint

📚 Documentation preview: https://jupytergis--872.org.readthedocs.build/en/872/
💡 JupyterLite preview: https://jupytergis--872.org.readthedocs.build/en/872/lite

github-actions · 2025-08-13T23:50:15Z

👈 Launch a Binder on branch mapninja/jupytergis-docwork/main

github-actions · 2025-08-14T00:02:09Z

Integration tests report: appsharing.space

arjxn-py

Hi @mapninja, Thanks for starting this :)
I think this needs some rework as the original idea was to move the data files such as eq.geojson, france_regions.gsojson, geotiff-example.tif in the examples/data/ directory but I see that we have also moved .jGIS files (A .jGIS file is the project file format for JupyterGIS.)

mfisher87 · 2025-08-19T21:04:40Z

Hey Stace! Thanks for this! There are some overlapping changes between this PR and #878 . How should we think about how these 2 PRs are related? Does one depend on the other?

I'm also curious about your thoughts on JGIS files living in the data/ directory - previously we considered those to be the examples, and e.g. GeoJSON, GeoTIFF, etc. files to be the data. I was thinking the JGIS files should live in the root of examples/ but I could be convinced :)

mapninja · 2025-08-19T21:17:55Z

These 2 PRs are sequential, with one a continuation of the other.
I can see leaving the jGIS files in the main /examples/ directory, since they are technically "documents." I think my thinking was that they are documents, but they are dependent upon an ipynb to be opened, so I put them into the /data/ directory to keep that higher level /examples/ directory clean, particularly if we will be creating many more of these example.ipynb

mfisher87 · 2025-08-19T21:33:26Z

These 2 PRs are sequential, with one a continuation of the other.

Cool! Which one is first?

they are dependent upon an ipynb to be opened

This is actually not the case, you can directly double-click a .jGIS file :)

mapninja · 2025-08-19T21:55:46Z

872, then 878.

mfisher87 · 2025-08-20T15:32:01Z

Thanks, Stace! Is it OK if I push to this branch or are you actively working on this?

mfisher87 · 2025-08-20T17:32:54Z

Stuff I'd like to push: mfisher87@ae85779

mapninja · 2025-08-20T17:38:24Z

go for it

mfisher87 · 2025-08-20T17:49:29Z

Pushed! What do you think?

mfisher87 · 2025-08-22T15:31:15Z

It's taking a bit of time for me to get through all the new stuff on GitHub, my apologies!

implemented

mfisher87 · 2025-08-27T00:54:01Z

I got the examples files to copy into the JupyterLite docs deployment about as well as I think I possibly can. The .qgz files are copied in, which I don't want, but there's no good way to exclude them and copy in a nested directory structure.

jupyterlite/jupyterlite-sphinx#309
jupyterlite/jupyterlite-sphinx#307

mfisher87 · 2025-08-28T01:13:54Z

bot please update snapshots

mfisher87 · 2025-08-28T01:47:27Z

bot please update snapshots pretty pretty please

mfisher87 · 2025-08-28T02:04:49Z

Hooray! Anything is possible if one asks nicely 😆

Let's see if those integration tests pass...

mfisher87 · 2025-08-28T02:08:12Z

Looks like we need one more go-around with the bot...

- Created new JGIS files: shapefile.jGIS, test.jGIS, and world.jGIS with various layers and sources. - Added Jupyter notebooks for creating a new JGIS document, exploring data in a map, and opening existing JGIS projects. - Implemented vector styling examples and added raster and GeoJSON layers to demonstrate usage of the JupyterGIS API. - Enhanced documentation with markdown cells to provide context and instructions for users.

for more information, see https://pre-commit.ci

…ument

…anted content

The globstar doesn't work how I expected! <jupyterlite/jupyterlite-sphinx#307>

The contents of `examples/` should be directly visible at the root of the filesystem in the Lite deployment, not inside an `examples/` directory.

Use symlinks to any files that also exist in `examples/` and `cp --dereference` when copying into the JupyterLite deployment

mfisher87 · 2025-08-28T02:57:44Z

bot please update snapshots again pretty please 🙇

arjxn-py

Neat!
Thanks @mapninja @mfisher87

martinRenou · 2025-08-28T07:45:16Z

@mfisher87 I see you struggled with the bot 😬 Sorry! I don't know if this is what happened exactly, but the bot needs to run after the Build jupytergis workflow is done, the reasoning for this is that the bot looks for the build artifact (the built JupyterGIS package) and downloads it for the screenshots update workflow

mfisher87 · 2025-08-28T15:02:37Z

the bot needs to run after the Build jupytergis workflow is done, the reasoning for this is that the bot looks for the build artifact (the built JupyterGIS package) and downloads it for the screenshots update workflow

Yeah, I figured this out the hard way! We could use some docs on this :)

mfisher87 · 2025-08-28T15:03:47Z

#911

mapninja · 2025-08-28T17:53:01Z

Looks great. +1 on the decision to put the JGIS files back in /examples/. WIth the numbering on the ipynb files, it's not nearly as messy as I imagined. I'll work more on fleshing out the notebooks with supporting text, next week when I have time, if you think that is useful.

mfisher87 · 2025-08-28T18:23:41Z

@mapninja Absolutely useful! Thank you! And I think we could also use numbering on the .jGIS files if we want to interleave notebooks and jGIS project files in the examples. E.g. 01-etc.ipynb creates 02-etc.jGIS, 03-etc.ipynb updates 04-etc.jGIS. Or something -- not sure at the moment as mutation within the examples could be messy ;)

arjxn-py previously requested changes Aug 14, 2025

View reviewed changes

arjxn-py added the documentation Improvements or additions to documentation label Aug 14, 2025

mfisher87 mentioned this pull request Aug 20, 2025

Examples rework #878

Closed

mfisher87 requested a review from arjxn-py August 25, 2025 20:12

mfisher87 force-pushed the main branch from 6611171 to 6d13cfd Compare August 26, 2025 23:23

mfisher87 closed this Aug 28, 2025

mfisher87 reopened this Aug 28, 2025

mfisher87 force-pushed the main branch from 2302045 to 6be064d Compare August 28, 2025 02:31

mapninja and others added 5 commits August 27, 2025 20:35

[pre-commit.ci] auto fixes from pre-commit.com hooks

1781b58

for more information, see https://pre-commit.ci

Add introductory content and explanations for creating a new JGIS doc…

38eb714

…ument

rename open map doc

a03c738

push branch to Main

8fabdd7

mfisher87 and others added 16 commits August 27, 2025 20:35

Relocate example jGIS projects, fix data references

9655e81

Update JupyterLite build for new content locations

dbae877

Move QGZ project files out of data directory

a8261b5

Remove spaces from filename

cd27b6c

Copy nyc data folder for Lite build

e9dbe85

Move a missed project file out of data/ dir

b25f176

Copy examples excluding unwanted content instead of enumerating all w…

d68a591

…anted content

Add all example content in RTD build

e358647

Pass in only the examples directory as jupyterlite_contents

2b479db

The globstar doesn't work how I expected! <jupyterlite/jupyterlite-sphinx#307>

Re-add jgis.ipynb as test data

c504934

Un-nest the examples directory in the content directory

c56ea14

The contents of `examples/` should be directly visible at the root of the filesystem in the Lite deployment, not inside an `examples/` directory.

Move all ui-test dependencies into ui-tests/content subdir

78bc062

Use symlinks to any files that also exist in `examples/` and `cp --dereference` when copying into the JupyterLite deployment

Add more test dependency symlinks

cb34c63

Restore previous viewport position to updated examples

3afae14

Update Playwright Snapshots

ee78766

Fix broken test.jGIS project file

7fef933

mfisher87 force-pushed the main branch from 6be064d to 7fef933 Compare August 28, 2025 02:35

Update Playwright Snapshots

790d637

mfisher87 closed this Aug 28, 2025

mfisher87 reopened this Aug 28, 2025

arjxn-py approved these changes Aug 28, 2025

View reviewed changes

arjxn-py merged commit ccd5a60 into geojupyter:main Aug 28, 2025
13 checks passed

mfisher87 mentioned this pull request Aug 28, 2025

Document snapshot testing and the bot #911

Open

Updated and organized ipynb examples directory for clarity #872

Updated and organized ipynb examples directory for clarity #872

Uh oh!

Conversation

mapninja commented Aug 13, 2025 • edited by mfisher87 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

github-actions bot commented Aug 13, 2025

Uh oh!

github-actions bot commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

arjxn-py left a comment

Choose a reason for hiding this comment

Uh oh!

mfisher87 commented Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mapninja commented Aug 19, 2025

Uh oh!

mfisher87 commented Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mapninja commented Aug 19, 2025

Uh oh!

mfisher87 commented Aug 20, 2025

Uh oh!

mfisher87 commented Aug 20, 2025

Uh oh!

mapninja commented Aug 20, 2025

Uh oh!

mfisher87 commented Aug 20, 2025

Uh oh!

mfisher87 commented Aug 22, 2025

Uh oh!

mfisher87 commented Aug 27, 2025

Uh oh!

mfisher87 commented Aug 28, 2025

Uh oh!

mfisher87 commented Aug 28, 2025

Uh oh!

mfisher87 commented Aug 28, 2025

Uh oh!

mfisher87 commented Aug 28, 2025

Uh oh!

mfisher87 commented Aug 28, 2025

Uh oh!

arjxn-py left a comment

Choose a reason for hiding this comment

Uh oh!

martinRenou commented Aug 28, 2025

Uh oh!

Uh oh!

mfisher87 commented Aug 28, 2025

Uh oh!

mfisher87 commented Aug 28, 2025

Uh oh!

mapninja commented Aug 28, 2025

Uh oh!

mfisher87 commented Aug 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

mapninja commented Aug 13, 2025 •

edited by mfisher87

Loading

github-actions bot commented Aug 14, 2025 •

edited

Loading

mfisher87 commented Aug 19, 2025 •

edited

Loading

mfisher87 commented Aug 19, 2025 •

edited

Loading

mfisher87 commented Aug 28, 2025 •

edited

Loading