forked from Open-EO/openeo-community-examples
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
90 additions
and
1 deletion.
There are no files selected for viewing
This file contains 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 |
---|---|---|
@@ -1,2 +1,17 @@ | ||
# openeo-community-example | ||
# openEO Community Examples | ||
|
||
A community-driven effort to make examples, user-defined processes and code snippets available in a single place. | ||
|
||
* [User-defined Processes](processes/) | ||
* [JavaScript Client examples and code snippets](javascript/) | ||
* [Python Client examples and code snippets](python/) | ||
* [R Client examples and code snippets](r/) | ||
* [Other resources](other/) | ||
|
||
## Contributing | ||
|
||
* We are looking forward for contributions from anyone! | ||
* Each contribution must be submitted as a PR to the most suitable folder (see above). | ||
* Please add each contribution to the overview tables in the corresponding README.md file. | ||
* PRs may need to fulfill a set of requirements that are documented in each folder separately and may be checked by a CI tool. | ||
* All contributions here will be licensed under the terms of the [Apache-2.0 license](LICENSE). |
This file contains 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,15 @@ | ||
# JavaScript Client - Examples and Code Snippets | ||
|
||
This folder contains examples and code snippets for the openEO JavaScript client (including NodeJS and TypeScript). | ||
|
||
## Overview | ||
|
||
Environments: `JS`, `TS` or `Node` | ||
|
||
| Title | Environment | Description | | ||
| ----- | ----------- | ----------- | | ||
| ... | `JS` | ... | | ||
|
||
## Contributing | ||
|
||
* Please provide each contribution in a separate folder. |
This file contains 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,13 @@ | ||
# Other useful resources | ||
|
||
This folder contains all useful resources that don't fit into any of the other categories. | ||
|
||
## Overview | ||
|
||
| Title | Description | | ||
| ----- | ----------- | | ||
| ... | ... | | ||
|
||
## Contributing | ||
|
||
* Please provide each contribution in a separate folder, if required. You may also just link to external web pages. |
This file contains 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,16 @@ | ||
# User-defined Processes | ||
|
||
This folder contains user-defined processes that can be run by any openEO client (e.g. Web Editor, Python or R). | ||
|
||
## Overview | ||
|
||
| ID | Categories | Summary | | ||
| -- | ---------- | ------- | | ||
| ... | ... | ... | | ||
|
||
## Contributing | ||
|
||
* Please provide one JSON file per user-defined process directly into this folder (no sub-folders). | ||
* All processes must be parametrized (e.g. no hard-coded collection names). | ||
* All processes must have appropriate metadata included and follow common best practices. These are enforces by a CI tool that checks the processes for compliance. | ||
Run `npm test` to check your contributon for compliance. |
This file contains 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,15 @@ | ||
# Python Client - Examples and Code Snippets | ||
|
||
This folder contains examples and code snippets for the openEO Python client. | ||
|
||
## Overview | ||
|
||
Environments: `Python` (plain Python code), `Jupyter` (e.g. Notebooks) | ||
|
||
| Title | Environment | Description | | ||
| ----- | ----------- | ----------- | | ||
| ... | `Python` | ... | | ||
|
||
## Contributing | ||
|
||
* Please provide each contribution in a separate folder. |
This file contains 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,15 @@ | ||
# R Client - Examples and Code Snippets | ||
|
||
This folder contains examples and code snippets for the openEO R client. | ||
|
||
## Overview | ||
|
||
Environments: `R` (plain R code), `RMarkdown` (incl. knitr), `Jupyter` (e.g. Notebooks) | ||
|
||
| Title | Environment | Description | | ||
| ----- | ----------- | ----------- | | ||
| ... | `R` | ... | | ||
|
||
## Contributing | ||
|
||
* Please provide each contribution in a separate folder. |