Open-EO / Open-EO/openeo-python-client

Support UDP parameters in run_udf calls

Open
#207 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

usability
Dominant language
Python
Stars
217
Forks
56
Avg merge
1d 22h
Merged PRs (30d)
2

Description

We recently had a couple of use cases where a user wanted to access UDP parameters from UDF functions (e.g. apply_datacube) through the context argument.

Currently this has to be done with a bit of boilerplate code like for example

    fapar_masked = S2_bands_mask.reduce_dimension(dimension="bands", reducer=PGNode(
        process_id="run_udf",
        data={"from_parameter": "data"},
        udf=udf,
        runtime="Python",
        context={"biopar": {"from_parameter": "biopar"}}
    ))

This context/parameter handling should be supported directly by reduce_dimension() and the like, or better: through a helper for easily building a run_udf node

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing reduce_dimension() and related process-building entry points, then compare them with the run_udf node example using context and UDP parameters. Define how parameters should reach apply_datacube through context, and consider whether direct support or a run_udf helper gives a complete, consistent API.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.