Skip to content

Feat/extract notebook metadata#43

Open
firzaariany wants to merge 20 commits into
mainfrom
feat/extract-notebook-metadata
Open

Feat/extract notebook metadata#43
firzaariany wants to merge 20 commits into
mainfrom
feat/extract-notebook-metadata

Conversation

@firzaariany
Copy link
Copy Markdown
Contributor

@firzaariany firzaariany commented Apr 23, 2026

Summary

This PR contributes to #32 and is ready for review

What's changed

  • Notebook metadata convention

    • Modifies templates/: provide dict for metadata, set tagged cells preview_image and notebook_metadata
    • Modifies notebooks/sentinel/sentinel-2/fire_and_disaster_monitoring/fire_boundary.ipynb: as a working example with metadata dict
  • Record generator and image extraction

    • Adds algorithm_registration/populate_record.py: Python CLI to produce thumbnail and preview pictures, and to create OGC API records from tagged cells
    • Adds algorithm_registration/records_template.json: OGC API record template

How to test this

  • Since the UDP and records were committed, it will appear in your local repo. Delete them to test this pipeline
  • Run the notebook fire_boundary.ipynb from top to bottom
  • Notebook will produce UDP, thumbnail & preview pictures, and OGC API records in this directory structure:
openeo-udp/algorithm_registration/fire_boundary/
├── openeo_udp/fire_boundary.json
└── records/
    ├── fire_boundary.json
    ├── preview.png
    └── thumbnail.png
  • If you want to run the QA test
    • Clone developmentseed/apex_algorithms repo
    • Move the records to APEx repo
cd apex_algorithms
git checkout -b alg/fire_boundary
cp -r ../algorithm_registration/fire_boundary algorithm_catalog/developmentseed
  • Run QA test locally
uv pip install qa/tools -r qa/unittests/requirements.txt
uv run pytest qa/unittests/tests/test_records.py

Problems

When running QA tests I received this error for fire_boundary records. It checks if the records exist in the main branch of ESA-APEx/apex_algorithms, which wouldn't be if the commit with fire_boundary records are not yet merged to main.

AssertionError: Link 'https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/main/algorithm_catalog/developmentseed/fire_boundary/openeo_udp/fire_boundary.json' in record 'fire_boundary' is not returning a valid response (200, 301, 302, 308, 401, 403), got 404

@firzaariany firzaariany marked this pull request as ready for review April 27, 2026 09:30
@firzaariany firzaariany force-pushed the feat/extract-notebook-metadata branch from a657297 to 59059ea Compare May 7, 2026 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant