docs: tutorial notebook for OGC API – Moving Features endpoints#9
Open
estebanzimanyi wants to merge 1 commit into
Open
docs: tutorial notebook for OGC API – Moving Features endpoints#9estebanzimanyi wants to merge 1 commit into
estebanzimanyi wants to merge 1 commit into
Conversation
…outputs tutorial.ipynb walks through the eight core MobilityAPI endpoints (DELETE/POST collection, POST/GET items, bbox spatial filter, tgsequence, velocity, subTrajectory) end-to-end against the Danish Maritime Authority AIS dataset, with matplotlib + contextily visualisations: - All-vessels overview map (brown trajectories on CartoDB Positron) - BBox-filtered map with Rødby harbour envelope on OpenStreetMap - Multi-vessel velocity profile comparison with a 10-knot speed-limit reference line and shaded violation zone - Subtrajectory result summary table (DataFrame) - Green-over-brown subtrajectory overlay against full trajectories Outputs committed inline (14/17 code cells have rendered outputs: image/png, text/html, stream) so the notebook renders fully on GitHub without a server. Two conceptual figures bundled under doc/images: - ogc-moving-features-class-diagram.png — OGC standard figure 1 - mobilityapi-backing-schema.png — the PostgreSQL schema MobilityAPI creates on first POST (collections, moving_features, temporal_geometries, temporal_properties, temporal_values) README gains a one-line pointer to tutorial.ipynb under Usage.
ccbb5c4 to
7d0bd03
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
tutorial.ipynbat the repo root — a guided notebook walking through MobilityAPI's OGC API – Moving Features endpoints against the Danish Maritime Authority AIS dataset that is already used bydemo.ipynband across the wider MEOS ecosystem (PyMEOS-Examples, JMEOS-Examples).Mirrors the slide-deck narrative without re-implementing the substrate: endpoint shapes, JSON payloads, and the
data/trajectories_mf1.jsonsource match the existingdemo.ipynbso the same backend session serves both notebooks.Sections
DELETE /collections/{id}POST /collectionsshipscollectionGET /collectionsPOST /collections/{id}/itemsFeatureCollectionofMovingPointfeaturesGET /collections/{id}/items?limit=…GET /collections/{id}/items?bbox=…GET /…/items/{mFeatureId}/tgsequenceGET /…/tgsequence/{tGeometryId}/velocityTRealmeasure + matplotlib plotGET /…/items?subTrajectory=true&datetime=…Files
tutorial.ipynb— 32 cells (16 markdown / 16 code),nbformat 4.5README.md— one-line pointer to the notebook under UsageValidation
python3 -m nbformat ... validate→ OK, all 32 cells have IDsast.parseon every code cell → no syntax errorsdemo.ipynb(which runs against a live server today)Test plan
./run.shtutorial.ipynbin Jupyter / VS Code