-
Notifications
You must be signed in to change notification settings - Fork 0
first version of capability requirements #4
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# Integration Requirements for Argo Workflows on EOxHub | ||
|
||
This document outlines the minimum requirements for integrating a new process into the Argo Workflow system on EOxHub. This includes input definitions, expected Docker image standards, and output formats. | ||
|
||
## Input Requirements | ||
|
||
If your service should be integrated into the eodash processing widget docker input fields must correspond to our supported options. Beside this we expect to get information regarding: | ||
UndeadFairy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- Description of expected input data - does the service expect data already present or data are downloaded as part of the dockerized algorithm? | ||
- Description of expected argument and parameters | ||
- Description of expected output - see Output requirements section | ||
|
||
|
||
### Arguments and parameters | ||
|
||
eodash processing widget support multiple ways how to pass input. | ||
- Area/location - process can take as input drawn point or polygon from the eodash user interface. For this integration, input field must accept eather coorinates directly or geoJSON as a string. File input is not accepted. | ||
UndeadFairy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- Date - standard date formats are supported. eodash also supports start and end time to create range. | ||
UndeadFairy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- Numeric fields - integer or float values | ||
- Text fields | ||
- Dropdowns with limited options | ||
|
||
|
||
All fields can have default value | ||
|
||
|
||
## Docker Image Requirements | ||
|
||
Your process must be encapsulated in a Docker image without the strict limitations. It is helpful if the image is "slim" - only with required dependencies installed. | ||
UndeadFairy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
We expect to know resource usage estimation - RAM consumption and CPU estimates. | ||
|
||
|
||
|
||
## Output Requirements | ||
|
||
The workflow should store its results in `/output` folder, which will be collected automatically by our processes. | ||
|
||
Expected outputs: | ||
- Results (e.g., COG, geoJSON, CSV) | ||
- Inputs are expected to be cloud-native so for raster output formats, COGs are expected, for vector data geoJSON for small files up to 5Mb or flatGeobuf | ||
- Logs (optional but encouraged) | ||
|
||
|
||
Outputs must be: | ||
- Written with unique filenames if multiple files are generated. | ||
- Validated (e.g., for COG format or JSON schema compliance). | ||
|
||
|
||
|
||
## Sample Checklist | ||
|
||
To submit your process for integration, make sure these information are included: | ||
- [ ] Dockerfile included and builds correctly | ||
- [ ] README with usage instructions and input/output description | ||
- [ ] Sample call example | ||
- [ ] License file / link to repository (not mandatory) | ||
- [ ] Sample input/output for testing | ||
- [ ] Visualisation expectations | ||
|
||
--- | ||
|
||
Please contact the EOxHub team or submit a ticket if youneed more information. |
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.
Uh oh!
There was an error while loading. Please reload this page.