Skip to content
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

Some processes are documented, some are "hidden" #284

Open
m-mohr opened this issue Mar 21, 2022 · 5 comments
Open

Some processes are documented, some are "hidden" #284

m-mohr opened this issue Mar 21, 2022 · 5 comments

Comments

@m-mohr
Copy link
Member

m-mohr commented Mar 21, 2022

So due to the fact that there are some processes specifically documented and some are only available through the "generic way", people seem to think some processes are not available.

So it seems people are looking at e.g. https://open-eo.github.io/openeo-python-client/api.html#openeo.rest.datacube.DataCube for processes and don't find all processes they expect and then don't understand that they have to switch to using the generic way ( https://open-eo.github.io/openeo-python-client/processes.html#generic-api-for-adding-processes ). Instead, they seem to think that the other processes are not available (or not documented) as they don't find the process specifically mentioned in the client docs while they find some other specific processes.

How can this be improved?

@m-mohr m-mohr changed the title Some processes are documented some are "not" Some processes are documented, some are "hidden" Mar 21, 2022
@jdries
Copy link
Collaborator

jdries commented Mar 21, 2022

The documentation you point to yourself actually contains the whole explanation, so users should either read the manual, or ask on the forum so we can point them to the manual.
The only other thing we're doing is avoiding these 'hidden' processes in the first place, by creating the necessary methods in the python client, which is really not that much work, and could also be done by others through pull requests.

So rather inclined to close this one, unless there's other suggestions?

@m-mohr
Copy link
Member Author

m-mohr commented Mar 21, 2022

cc @patrick-griffiths: So to use processes such as resample_cube_temporal that are not specifically documented in the Python client, you need to read this: https://open-eo.github.io/openeo-python-client/processes.html#generic-api-for-adding-processes

The only thing you could likely do is to reference https://open-eo.github.io/openeo-python-client/processes.html#generic-api-for-adding-processes more often and tell users that if processes can't be found in client docs, then they need to use the generic way.

@jdries
Copy link
Collaborator

jdries commented Mar 22, 2022

resample_cube_temporal can now be used directly as well!

@soxofaan
Copy link
Member

soxofaan commented Mar 22, 2022

Under #236 I also started with associating DataCube methods with the corresponding openeo processes. At the moment, it just adds a also see openeo.org/...{process_id} link to the method documentation.

But ultimately this also allow us to build an automated page where we map each (official) openeo process with a corresponding Python-style snippet

@soxofaan
Copy link
Member

resample_cube_temporal can now be used directly as well!

FYI: added in afb56eb,
not yet in a released version, but will be in next (probably tagged 0.10.0)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants