Skip to content

Non-public UDP docs #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions guides/udp_writer_guide.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -358,3 +358,20 @@ When an algorithm is updated, or the underlying data changes for some reason, a
on the reference data comparison. Updating the reference data is practically the same as defining it initially:look up
the URLs of the actual results in the benchmark report, validate these new results, and update the benchmark scenario
with the new reference data URLs.


### Licensing your process

The default mechanism of registering algorithms in APEx involves sharing the full process graph publicly. This can be
considered an 'open source' approach, and also assumes that a license is present. The "license" field in the algorithm record
is foreseen to indicate use of an open source or properietary license.

### Sharing UDP's without open sourcing process graphs

It may not be desirable to share the full process graph publicly, in case you want to hide the algorithm or specific
parameters. This is fully supported by APEx, as the exact requirements for ESA project may vary depending on the ITT requirements.

To support this, you do need this feature to be supported by your openEO backend provider, as there is no 'standardized'
option available via the openEO API. Typically, the backend will allow you to register your process graph as a 'custom'
process, without exposing it externally. Once that is available, you can follow the regular step to create a public UDP
that describes process metadata, but simply relies on the 'custom' process rather than a standardized process graph.