diff --git a/404.html b/404.html index 3cd7dda07..20df56728 100644 --- a/404.html +++ b/404.html @@ -8,13 +8,13 @@ - + -

404

Looks like we've got some broken links.
+ - + diff --git a/about.html b/about.html index c6debe079..faf325a13 100644 --- a/about.html +++ b/about.html @@ -8,7 +8,7 @@ - + @@ -206,6 +206,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/assets/js/100.d9a1c32c.js b/assets/js/100.563c9377.js similarity index 95% rename from assets/js/100.d9a1c32c.js rename to assets/js/100.563c9377.js index 7729f568a..c906fa53f 100644 --- a/assets/js/100.d9a1c32c.js +++ b/assets/js/100.563c9377.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[100],{549:function(e,t,n){"use strict";n.r(t);var r=n(4),a=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("p",[e._v("Today, the newly established "),t("RouterLink",{attrs:{to:"/psc.html"}},[e._v("openEO Project Steering Committee")]),e._v("\nreleased a new version 1.0.1 of the openEO API. This doesn't include any new\nfunctionality, but clarifies ambiguous parts of the specification and changes\nthe API's recommendation regarding CORS headers to avoid potential security\nissues with credentials in web browsers. Back-ends are advised to check their\nimplementations against the new specification and update the CORS headers\naccordingly. The web clients have already been updated accordingly.")],1),e._v(" "),t("p",[e._v("More details about the release:")]),e._v(" "),t("ul",[t("li",[e._v("Details on the "),t("a",{attrs:{href:"https://github.com/Open-EO/PSC/issues/7",target:"_blank",rel:"noopener noreferrer"}},[e._v("CORS issue"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/tree/1.0.1/CHANGELOG.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("Changelog"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://api.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("API documentation"),t("OutboundLink")],1)])])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[100],{550:function(e,t,n){"use strict";n.r(t);var r=n(4),a=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("p",[e._v("Today, the newly established "),t("RouterLink",{attrs:{to:"/psc.html"}},[e._v("openEO Project Steering Committee")]),e._v("\nreleased a new version 1.0.1 of the openEO API. This doesn't include any new\nfunctionality, but clarifies ambiguous parts of the specification and changes\nthe API's recommendation regarding CORS headers to avoid potential security\nissues with credentials in web browsers. Back-ends are advised to check their\nimplementations against the new specification and update the CORS headers\naccordingly. The web clients have already been updated accordingly.")],1),e._v(" "),t("p",[e._v("More details about the release:")]),e._v(" "),t("ul",[t("li",[e._v("Details on the "),t("a",{attrs:{href:"https://github.com/Open-EO/PSC/issues/7",target:"_blank",rel:"noopener noreferrer"}},[e._v("CORS issue"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/tree/1.0.1/CHANGELOG.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("Changelog"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://api.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("API documentation"),t("OutboundLink")],1)])])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/102.11f27837.js b/assets/js/102.99a99e80.js similarity index 96% rename from assets/js/102.11f27837.js rename to assets/js/102.99a99e80.js index 0646a2daa..97a3f04cb 100644 --- a/assets/js/102.11f27837.js +++ b/assets/js/102.99a99e80.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[102],{552:function(e,t,n){"use strict";n.r(t);var r=n(4),a=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("p",[e._v("Today, we released a new version 1.1.0 of the openEO R Client, which features a couple of "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client/blob/master/NEWS.md#version-110",target:"_blank",rel:"noopener noreferrer"}},[e._v("improvements and bug fixes"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("At the same time, the R client has been published on CRAN, too: "),t("a",{attrs:{href:"https://cran.r-project.org/package=openeo",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo"),t("OutboundLink")],1),e._v("\nThis means you can now install the R client more easily and directly through CRAN with the following command:")]),e._v(" "),t("div",{staticClass:"language-r extra-class"},[t("pre",{pre:!0,attrs:{class:"language-r"}},[t("code",[e._v("install.packages"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"openeo"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\n")])])]),t("p",[e._v("If you have trouble installing or working with the package, feel free to leave an issue in the "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub issue tracker"),t("OutboundLink")],1),e._v(".")])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[102],{553:function(e,t,n){"use strict";n.r(t);var r=n(4),a=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("p",[e._v("Today, we released a new version 1.1.0 of the openEO R Client, which features a couple of "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client/blob/master/NEWS.md#version-110",target:"_blank",rel:"noopener noreferrer"}},[e._v("improvements and bug fixes"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("At the same time, the R client has been published on CRAN, too: "),t("a",{attrs:{href:"https://cran.r-project.org/package=openeo",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo"),t("OutboundLink")],1),e._v("\nThis means you can now install the R client more easily and directly through CRAN with the following command:")]),e._v(" "),t("div",{staticClass:"language-r extra-class"},[t("pre",{pre:!0,attrs:{class:"language-r"}},[t("code",[e._v("install.packages"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"openeo"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\n")])])]),t("p",[e._v("If you have trouble installing or working with the package, feel free to leave an issue in the "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub issue tracker"),t("OutboundLink")],1),e._v(".")])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/103.9dbeca29.js b/assets/js/103.4915e368.js similarity index 93% rename from assets/js/103.9dbeca29.js rename to assets/js/103.4915e368.js index 54775ea8a..413ee95c0 100644 --- a/assets/js/103.9dbeca29.js +++ b/assets/js/103.4915e368.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[103],{553:function(e,t,n){"use strict";n.r(t);var s=n(4),o=Object(s.a)({},(function(){var e=this._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[e("p",[this._v("Last wednesday, the first regular openEO PSC meeting took place.\nWe have now agreed to meet on a monthly basis, each "),e("strong",[this._v("first Wednesday of the month at 15:00 CET/CEST")]),this._v(".\nWe will always discuss the open issues in the "),e("a",{attrs:{href:"https://github.com/Open-EO/PSC/issues",target:"_blank",rel:"noopener noreferrer"}},[this._v("PSC issue tracker"),e("OutboundLink")],1),this._v(" and talk through the future and strategic directions openEO is heading towards.\nThe meetings are open to the public and anyone can join as a guest.\nIf you'd like to join the next meeting, please contact "),e("code",[this._v("openeo.psc@uni-muenster.de")]),this._v(" and we'll send you an invite.")])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[103],{552:function(e,t,n){"use strict";n.r(t);var s=n(4),o=Object(s.a)({},(function(){var e=this._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[e("p",[this._v("Last wednesday, the first regular openEO PSC meeting took place.\nWe have now agreed to meet on a monthly basis, each "),e("strong",[this._v("first Wednesday of the month at 15:00 CET/CEST")]),this._v(".\nWe will always discuss the open issues in the "),e("a",{attrs:{href:"https://github.com/Open-EO/PSC/issues",target:"_blank",rel:"noopener noreferrer"}},[this._v("PSC issue tracker"),e("OutboundLink")],1),this._v(" and talk through the future and strategic directions openEO is heading towards.\nThe meetings are open to the public and anyone can join as a guest.\nIf you'd like to join the next meeting, please contact "),e("code",[this._v("openeo.psc@uni-muenster.de")]),this._v(" and we'll send you an invite.")])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/104.e808d2be.js b/assets/js/104.3944b1de.js similarity index 94% rename from assets/js/104.e808d2be.js rename to assets/js/104.3944b1de.js index 7abae415f..249c5dddb 100644 --- a/assets/js/104.e808d2be.js +++ b/assets/js/104.3944b1de.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[104],{556:function(e,n,t){"use strict";t.r(n);var o=t(4),s=Object(o.a)({},(function(){var e=this,n=e._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[n("p",[e._v("The openEO PSC is pleased to announce a new monthly openEO community meeting that\ntakes place "),n("strong",[e._v("every first Wednesday of a month at 14:00 CET")]),e._v(".")]),e._v(" "),n("p",[e._v("This is meant to be a "),n("em",[e._v("project-independant")]),e._v(" platform for developers to announce news,\ninform about recent or planned work, exchange ideas, discuss issues and get to\nknow each other. In the past there have been project-specific developer calls, but\nwe would like to build bridges between projects and coordinate the work better.")]),e._v(" "),n("p",[n("strong",[e._v("If you'd like to join these calls, please send an e-mail to "),n("a",{attrs:{href:"mailto:openeo.psc@uni-muenster.de"}},[e._v("openeo.psc@uni-muenster.de")]),e._v(".")]),e._v("\nEveryone is welcome!")])])}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[104],{554:function(e,n,t){"use strict";t.r(n);var o=t(4),s=Object(o.a)({},(function(){var e=this,n=e._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[n("p",[e._v("The openEO PSC is pleased to announce a new monthly openEO community meeting that\ntakes place "),n("strong",[e._v("every first Wednesday of a month at 14:00 CET")]),e._v(".")]),e._v(" "),n("p",[e._v("This is meant to be a "),n("em",[e._v("project-independant")]),e._v(" platform for developers to announce news,\ninform about recent or planned work, exchange ideas, discuss issues and get to\nknow each other. In the past there have been project-specific developer calls, but\nwe would like to build bridges between projects and coordinate the work better.")]),e._v(" "),n("p",[n("strong",[e._v("If you'd like to join these calls, please send an e-mail to "),n("a",{attrs:{href:"mailto:openeo.psc@uni-muenster.de"}},[e._v("openeo.psc@uni-muenster.de")]),e._v(".")]),e._v("\nEveryone is welcome!")])])}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/105.445f82d8.js b/assets/js/105.8d1db589.js similarity index 99% rename from assets/js/105.445f82d8.js rename to assets/js/105.8d1db589.js index b91f49995..0e5b4b91f 100644 --- a/assets/js/105.445f82d8.js +++ b/assets/js/105.8d1db589.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[105],{555:function(e,t,s){"use strict";s.r(t);var a=s(4),n=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("p",[e._v("We released a new version of the R client (1.3.0) with new exciting improvements\nand a couple of new vignettes. To see the full list of changes, please consult the\n"),t("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/news/index.html#version-130",target:"_blank",rel:"noopener noreferrer"}},[e._v("Changelog"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("You can get the new version through CRAN: "),t("a",{attrs:{href:"https://cran.r-project.org/package=openeo",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo"),t("OutboundLink")],1),e._v("\nThis means you can install or update the R client with the following command:")]),e._v(" "),t("div",{staticClass:"language-r extra-class"},[t("pre",{pre:!0,attrs:{class:"language-r"}},[t("code",[e._v("install.packages"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"openeo"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\n")])])]),t("p",[e._v("If you have trouble installing or working with the package, feel free to leave an issue in the "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub issue tracker"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"better-support-for-sf"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#better-support-for-sf"}},[e._v("#")]),e._v(" Better support for "),t("code",[e._v("sf")])]),e._v(" "),t("p",[e._v("A new feature is that "),t("code",[e._v("sf")]),e._v(" objects can be used in processes as parameters.\nFor example, "),t("code",[e._v("st_bbox()")]),e._v(" can be used to pass bounding boxes more easily as spatial extent to the process "),t("code",[e._v("load_collection")]),e._v(".\nPlease see the following example for details:")]),e._v(" "),t("div",{staticClass:"language-r extra-class"},[t("pre",{pre:!0,attrs:{class:"language-r"}},[t("code",[e._v("library"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("sf"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\nbbox "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" st_bbox"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("c"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("xmin"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("16.1")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n xmax"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("16.6")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n ymax"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("48.6")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n ymin"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("47.2")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" crs "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("4326")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\n\ndata "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" p"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("$")]),e._v("load_collection"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("id "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"SENTINEL-2"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n spatial_extent "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" bbox"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n temporal_extent "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" list"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"2018-04-01"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"2018-05-01"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\n")])])]),t("p",[e._v("You can see a full example "),t("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/articles/openeo-05-process_graph_building_application.html#building-the-graph-for-data-manipulation",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"new-vignettes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#new-vignettes"}},[e._v("#")]),e._v(" New Vignettes")]),e._v(" "),t("p",[e._v("The new vignettes cover the following topics:")]),e._v(" "),t("ol",[t("li",[t("p",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/articles/openeo-04-process_graph_concepts.html",target:"_blank",rel:"noopener noreferrer"}},[t("strong",[e._v("Process Graph Concepts")]),t("OutboundLink")],1),e._v("\nThis vignette shows the main concepts regarding the process graph building with the openeo package and explains aspects the openEO API and the openEO processes from a user perspective. It states the logical structure of an openEO process description and how process graphs are created from predefined processes. Also, the details about parameters and arguments of processes are explained, especially how this affects R, where function parameters are usually type free.")])]),e._v(" "),t("li",[t("p",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/articles/openeo-05-process_graph_building_application.html",target:"_blank",rel:"noopener noreferrer"}},[t("strong",[e._v("Process Graph Building Application")]),t("OutboundLink")],1),e._v('\nWe describe the details on how to create process graphs and respectively "User Defined Processes" (UDP). Those processes can be seen as the analysis workflows that are run as jobs at a designated openEO back-end. They might be called later directly or some variables can be added to the UDP to customize the processes at runtime, e.g. set the temporal interval or the area of interest. This vignette focuses on the user point of view.')])]),e._v(" "),t("li",[t("p",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/articles/openeo-03-package-software-architecture.html",target:"_blank",rel:"noopener noreferrer"}},[t("strong",[e._v("Package Software Architecture")]),t("OutboundLink")],1),e._v("\nThis is the first part of a contribution guide which ensures that developers can effectively contribute to the R-Client. Since a server-client based package is different from most other R packages some concepts are used that most R users and developers are not so familiar with. Therefore, this contribution guide eases the process of actively contributing to the packages development or bug fixing by explaining the underlying concepts.")])]),e._v(" "),t("li",[t("p",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/articles/openeo-06-developer_implementation_details.html",target:"_blank",rel:"noopener noreferrer"}},[t("strong",[e._v("Developer Implementation Details")]),t("OutboundLink")],1),e._v("\nIn this guide selected core mechanisms of the openEO package are described. It is targeted towards interested developers and it is highly recommended to dive into the source code, while reading through this guide. The explanations here are abstracted from the code and shall guide new developers on the concepts and routines of this package.")])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[105],{556:function(e,t,s){"use strict";s.r(t);var a=s(4),n=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("p",[e._v("We released a new version of the R client (1.3.0) with new exciting improvements\nand a couple of new vignettes. To see the full list of changes, please consult the\n"),t("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/news/index.html#version-130",target:"_blank",rel:"noopener noreferrer"}},[e._v("Changelog"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("You can get the new version through CRAN: "),t("a",{attrs:{href:"https://cran.r-project.org/package=openeo",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo"),t("OutboundLink")],1),e._v("\nThis means you can install or update the R client with the following command:")]),e._v(" "),t("div",{staticClass:"language-r extra-class"},[t("pre",{pre:!0,attrs:{class:"language-r"}},[t("code",[e._v("install.packages"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"openeo"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\n")])])]),t("p",[e._v("If you have trouble installing or working with the package, feel free to leave an issue in the "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub issue tracker"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"better-support-for-sf"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#better-support-for-sf"}},[e._v("#")]),e._v(" Better support for "),t("code",[e._v("sf")])]),e._v(" "),t("p",[e._v("A new feature is that "),t("code",[e._v("sf")]),e._v(" objects can be used in processes as parameters.\nFor example, "),t("code",[e._v("st_bbox()")]),e._v(" can be used to pass bounding boxes more easily as spatial extent to the process "),t("code",[e._v("load_collection")]),e._v(".\nPlease see the following example for details:")]),e._v(" "),t("div",{staticClass:"language-r extra-class"},[t("pre",{pre:!0,attrs:{class:"language-r"}},[t("code",[e._v("library"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("sf"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\nbbox "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" st_bbox"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("c"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("xmin"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("16.1")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n xmax"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("16.6")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n ymax"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("48.6")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n ymin"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("47.2")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" crs "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("4326")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\n\ndata "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" p"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("$")]),e._v("load_collection"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("id "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"SENTINEL-2"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n spatial_extent "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" bbox"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n temporal_extent "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" list"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"2018-04-01"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"2018-05-01"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\n")])])]),t("p",[e._v("You can see a full example "),t("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/articles/openeo-05-process_graph_building_application.html#building-the-graph-for-data-manipulation",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"new-vignettes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#new-vignettes"}},[e._v("#")]),e._v(" New Vignettes")]),e._v(" "),t("p",[e._v("The new vignettes cover the following topics:")]),e._v(" "),t("ol",[t("li",[t("p",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/articles/openeo-04-process_graph_concepts.html",target:"_blank",rel:"noopener noreferrer"}},[t("strong",[e._v("Process Graph Concepts")]),t("OutboundLink")],1),e._v("\nThis vignette shows the main concepts regarding the process graph building with the openeo package and explains aspects the openEO API and the openEO processes from a user perspective. It states the logical structure of an openEO process description and how process graphs are created from predefined processes. Also, the details about parameters and arguments of processes are explained, especially how this affects R, where function parameters are usually type free.")])]),e._v(" "),t("li",[t("p",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/articles/openeo-05-process_graph_building_application.html",target:"_blank",rel:"noopener noreferrer"}},[t("strong",[e._v("Process Graph Building Application")]),t("OutboundLink")],1),e._v('\nWe describe the details on how to create process graphs and respectively "User Defined Processes" (UDP). Those processes can be seen as the analysis workflows that are run as jobs at a designated openEO back-end. They might be called later directly or some variables can be added to the UDP to customize the processes at runtime, e.g. set the temporal interval or the area of interest. This vignette focuses on the user point of view.')])]),e._v(" "),t("li",[t("p",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/articles/openeo-03-package-software-architecture.html",target:"_blank",rel:"noopener noreferrer"}},[t("strong",[e._v("Package Software Architecture")]),t("OutboundLink")],1),e._v("\nThis is the first part of a contribution guide which ensures that developers can effectively contribute to the R-Client. Since a server-client based package is different from most other R packages some concepts are used that most R users and developers are not so familiar with. Therefore, this contribution guide eases the process of actively contributing to the packages development or bug fixing by explaining the underlying concepts.")])]),e._v(" "),t("li",[t("p",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/articles/openeo-06-developer_implementation_details.html",target:"_blank",rel:"noopener noreferrer"}},[t("strong",[e._v("Developer Implementation Details")]),t("OutboundLink")],1),e._v("\nIn this guide selected core mechanisms of the openEO package are described. It is targeted towards interested developers and it is highly recommended to dive into the source code, while reading through this guide. The explanations here are abstracted from the code and shall guide new developers on the concepts and routines of this package.")])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/106.f4f8246a.js b/assets/js/106.75cc6dff.js similarity index 99% rename from assets/js/106.f4f8246a.js rename to assets/js/106.75cc6dff.js index 262b06c49..33c014198 100644 --- a/assets/js/106.f4f8246a.js +++ b/assets/js/106.75cc6dff.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[106],{559:function(e,o,t){"use strict";t.r(o);var r=t(4),n=Object(r.a)({},(function(){var e=this,o=e._self._c;return o("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[o("p",[e._v("Today, we have released the new version 1.2.0 of the openEO API. At the same time, we've also released a 2.0.0 release candidate for the openEO processes.")]),e._v(" "),o("p",[e._v("The focus of these releases is to implement vector data (cube) support in openEO so that the focus is not strongly on raster data any longer.")]),e._v(" "),o("p",[e._v("Back-ends and clients are advised to check their implementations against the new specifications and update accordingly.")]),e._v(" "),o("p",[e._v("Below you can find details about the individual releases:")]),e._v(" "),o("h2",{attrs:{id:"openeo-api-v1-2-0"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#openeo-api-v1-2-0"}},[e._v("#")]),e._v(" openEO API v1.2.0")]),e._v(" "),o("p",[e._v('We\'ve collected improvements and useful new features for two years. It contains clarifications, new extensions (for orders and federation), vector data cubes, STAC (API) updates, alignment with OGC APIs, more link relation types, improved batch job results and logs, and other minor improvements. This API release is required to be able to release openEO processes in version 2.0.0-rc.1 due to the changes from the "raster-cube" to "datacube" subtype and the related changes in the process schema.')]),e._v(" "),o("ul",[o("li",[o("a",{attrs:{href:"https://api.openeo.org/1.2.0",target:"_blank",rel:"noopener noreferrer"}},[e._v("API documentation"),o("OutboundLink")],1)])]),e._v(" "),o("p",[e._v("Please consult the "),o("strong",[o("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/tree/1.2.0/CHANGELOG.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("changelog"),o("OutboundLink")],1)]),e._v(" for the changes and additions that have been made to the API.")]),e._v(" "),o("h2",{attrs:{id:"openeo-processes-v2-0-0-rc-1"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#openeo-processes-v2-0-0-rc-1"}},[e._v("#")]),e._v(" openEO Processes v2.0.0-rc.1")]),e._v(" "),o("p",[e._v("AsWe've collected improvements and useful new processes for over a year. The processes incorporate the long-awaited changes for vector data cubes. Unfortunately, this involves some breaking changes (e.g., the new "),o("code",[e._v("datacube")]),e._v(" datatype) and thus we are moving from 1.x to 2.x. Due to the amount of (breaking) changes, we propose the changes to the community as a release candidate first so that we can evaluate whether it all works as expected. We'll then cut the final release once some implementations confirm that the changes work as planned. Feedback is more than welcome and we'll closely monitor the "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub issue tracker"),o("OutboundLink")],1),e._v(" for your issues. Please feel encoruaged to post your feedback there.")]),e._v(" "),o("ul",[o("li",[o("a",{attrs:{href:"https://processes.openeo.org/2.0.0-rc.1",target:"_blank",rel:"noopener noreferrer"}},[e._v("Processes documentation"),o("OutboundLink")],1)])]),e._v(" "),o("p",[e._v("This release includes (for the first time) a couple of breaking changes. Therefore, we'll highlight the breaking changes below.\nPlease consult the "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/tree/2.0.0-rc.1/CHANGELOG.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("changelog"),o("OutboundLink")],1),e._v(" for a full list of changes and additions.")]),e._v(" "),o("ul",[o("li",[e._v("Added better support for labeled arrays. Labels are not discarded in all cases anymore. Affected processes:\n"),o("ul",[o("li",[o("code",[e._v("array_append")])]),e._v(" "),o("li",[o("code",[e._v("array_concat")])]),e._v(" "),o("li",[o("code",[e._v("array_modify")])])])]),e._v(" "),o("li",[o("code",[e._v("array_modify")]),e._v(": Change the default value for "),o("code",[e._v("length")]),e._v(" from "),o("code",[e._v("1")]),e._v(" to "),o("code",[e._v("0")]),e._v(". "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/312",target:"_blank",rel:"noopener noreferrer"}},[e._v("#312"),o("OutboundLink")],1)]),e._v(" "),o("li",[o("code",[e._v("aggregate_temporal")]),e._v(", "),o("code",[e._v("filter_temporal")]),e._v(", "),o("code",[e._v("load_collection")]),e._v(" and "),o("code",[e._v("load_result")]),e._v("/"),o("code",[e._v("load_stac")]),e._v(":\n"),o("ul",[o("li",[e._v("The temporal intervals must always be non-empty, i.e. the second instance in time must be after the first instance in time. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/331",target:"_blank",rel:"noopener noreferrer"}},[e._v("#331"),o("OutboundLink")],1)]),e._v(" "),o("li",[o("code",[e._v("24")]),e._v(" as the hour is not allowed anymore.** "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/331",target:"_blank",rel:"noopener noreferrer"}},[e._v("#331"),o("OutboundLink")],1)])])]),e._v(" "),o("li",[o("code",[e._v("inspect")]),e._v(": The parameter "),o("code",[e._v("message")]),e._v(" has been moved to be the second argument. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/369",target:"_blank",rel:"noopener noreferrer"}},[e._v("#369"),o("OutboundLink")],1)]),e._v(" "),o("li",[e._v("New definition for "),o("code",[e._v("aggregate_spatial")]),e._v(":\n"),o("ul",[o("li",[e._v("Allows more than 3 input dimensions "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/126",target:"_blank",rel:"noopener noreferrer"}},[e._v("#126"),o("OutboundLink")],1)]),e._v(" "),o("li",[e._v("Allow to not export statistics by changing the parameter "),o("code",[e._v("target_dimension")]),e._v(" "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/366",target:"_blank",rel:"noopener noreferrer"}},[e._v("#366"),o("OutboundLink")],1)])])]),e._v(" "),o("li",[e._v("Updated the processes based on the subtypes "),o("code",[e._v("raster-cube")]),e._v(" or "),o("code",[e._v("vector-cube")]),e._v(" to work with the subtype "),o("code",[e._v("datacube")]),e._v(" instead. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/68",target:"_blank",rel:"noopener noreferrer"}},[e._v("#68"),o("OutboundLink")],1)]),e._v(" "),o("li",[o("code",[e._v("sort")]),e._v(" and "),o("code",[e._v("order")]),e._v(": The ordering of ties is not defined anymore. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/409",target:"_blank",rel:"noopener noreferrer"}},[e._v("#409"),o("OutboundLink")],1)]),e._v(" "),o("li",[o("code",[e._v("quantiles")]),e._v(": Parameter "),o("code",[e._v("probabilities")]),e._v(" provided as array must be in ascending order. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/pull/297",target:"_blank",rel:"noopener noreferrer"}},[e._v("#297"),o("OutboundLink")],1)]),e._v(" "),o("li",[o("code",[e._v("fit_curve")]),e._v(" and "),o("code",[e._v("predict_curve")]),e._v(": Heavily modified specifications. "),o("code",[e._v("fit_curve")]),e._v(" works on arrays instead of data cubes, "),o("code",[e._v("predict_curve")]),e._v(" doesn't support gap filling anymore, clarify no-data handling, ... "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/425",target:"_blank",rel:"noopener noreferrer"}},[e._v("#425"),o("OutboundLink")],1)]),e._v(" "),o("li",[o("code",[e._v("climatological_normal")]),e._v(": The "),o("code",[e._v("climatology_period")]),e._v(" parameter accepts an array of integers instead of strings. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/331",target:"_blank",rel:"noopener noreferrer"}},[e._v("#331"),o("OutboundLink")],1)]),e._v(" "),o("li",[o("code",[e._v("between")]),e._v(": Support for temporal comparison. Use "),o("code",[e._v("date_between")]),e._v(" instead. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/331",target:"_blank",rel:"noopener noreferrer"}},[e._v("#331"),o("OutboundLink")],1)]),e._v(" "),o("li",[e._v("Deprecated "),o("code",[e._v("GeometryCollections")]),e._v(" are not supported any longer. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/389",target:"_blank",rel:"noopener noreferrer"}},[e._v("#389"),o("OutboundLink")],1)]),e._v(" "),o("li",[e._v("Deprecated PROJ definitions for the CRS are not supported any longer.")]),e._v(" "),o("li",[e._v("The comparison processes "),o("code",[e._v("eq")]),e._v(", "),o("code",[e._v("neq")]),e._v(", "),o("code",[e._v("lt")]),e._v(", "),o("code",[e._v("lte")]),e._v(", "),o("code",[e._v("gt")]),e._v(", "),o("code",[e._v("gte")]),e._v(" and "),o("code",[e._v("array_contains")]),e._v(":\n"),o("ul",[o("li",[e._v("Removed support for temporal comparison. Instead explicitly use "),o("code",[e._v("date_difference")]),e._v(".")]),e._v(" "),o("li",[e._v("Removed support for the input data types array and object. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/208",target:"_blank",rel:"noopener noreferrer"}},[e._v("#208"),o("OutboundLink")],1)])])]),e._v(" "),o("li",[o("code",[e._v("sort")]),e._v(" and "),o("code",[e._v("order")]),e._v(": Removed support for time-only values. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/331",target:"_blank",rel:"noopener noreferrer"}},[e._v("#331"),o("OutboundLink")],1)])])])}),[],!1,null,null,null);o.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[106],{557:function(e,o,t){"use strict";t.r(o);var r=t(4),n=Object(r.a)({},(function(){var e=this,o=e._self._c;return o("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[o("p",[e._v("Today, we have released the new version 1.2.0 of the openEO API. At the same time, we've also released a 2.0.0 release candidate for the openEO processes.")]),e._v(" "),o("p",[e._v("The focus of these releases is to implement vector data (cube) support in openEO so that the focus is not strongly on raster data any longer.")]),e._v(" "),o("p",[e._v("Back-ends and clients are advised to check their implementations against the new specifications and update accordingly.")]),e._v(" "),o("p",[e._v("Below you can find details about the individual releases:")]),e._v(" "),o("h2",{attrs:{id:"openeo-api-v1-2-0"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#openeo-api-v1-2-0"}},[e._v("#")]),e._v(" openEO API v1.2.0")]),e._v(" "),o("p",[e._v('We\'ve collected improvements and useful new features for two years. It contains clarifications, new extensions (for orders and federation), vector data cubes, STAC (API) updates, alignment with OGC APIs, more link relation types, improved batch job results and logs, and other minor improvements. This API release is required to be able to release openEO processes in version 2.0.0-rc.1 due to the changes from the "raster-cube" to "datacube" subtype and the related changes in the process schema.')]),e._v(" "),o("ul",[o("li",[o("a",{attrs:{href:"https://api.openeo.org/1.2.0",target:"_blank",rel:"noopener noreferrer"}},[e._v("API documentation"),o("OutboundLink")],1)])]),e._v(" "),o("p",[e._v("Please consult the "),o("strong",[o("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/tree/1.2.0/CHANGELOG.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("changelog"),o("OutboundLink")],1)]),e._v(" for the changes and additions that have been made to the API.")]),e._v(" "),o("h2",{attrs:{id:"openeo-processes-v2-0-0-rc-1"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#openeo-processes-v2-0-0-rc-1"}},[e._v("#")]),e._v(" openEO Processes v2.0.0-rc.1")]),e._v(" "),o("p",[e._v("AsWe've collected improvements and useful new processes for over a year. The processes incorporate the long-awaited changes for vector data cubes. Unfortunately, this involves some breaking changes (e.g., the new "),o("code",[e._v("datacube")]),e._v(" datatype) and thus we are moving from 1.x to 2.x. Due to the amount of (breaking) changes, we propose the changes to the community as a release candidate first so that we can evaluate whether it all works as expected. We'll then cut the final release once some implementations confirm that the changes work as planned. Feedback is more than welcome and we'll closely monitor the "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub issue tracker"),o("OutboundLink")],1),e._v(" for your issues. Please feel encoruaged to post your feedback there.")]),e._v(" "),o("ul",[o("li",[o("a",{attrs:{href:"https://processes.openeo.org/2.0.0-rc.1",target:"_blank",rel:"noopener noreferrer"}},[e._v("Processes documentation"),o("OutboundLink")],1)])]),e._v(" "),o("p",[e._v("This release includes (for the first time) a couple of breaking changes. Therefore, we'll highlight the breaking changes below.\nPlease consult the "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/tree/2.0.0-rc.1/CHANGELOG.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("changelog"),o("OutboundLink")],1),e._v(" for a full list of changes and additions.")]),e._v(" "),o("ul",[o("li",[e._v("Added better support for labeled arrays. Labels are not discarded in all cases anymore. Affected processes:\n"),o("ul",[o("li",[o("code",[e._v("array_append")])]),e._v(" "),o("li",[o("code",[e._v("array_concat")])]),e._v(" "),o("li",[o("code",[e._v("array_modify")])])])]),e._v(" "),o("li",[o("code",[e._v("array_modify")]),e._v(": Change the default value for "),o("code",[e._v("length")]),e._v(" from "),o("code",[e._v("1")]),e._v(" to "),o("code",[e._v("0")]),e._v(". "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/312",target:"_blank",rel:"noopener noreferrer"}},[e._v("#312"),o("OutboundLink")],1)]),e._v(" "),o("li",[o("code",[e._v("aggregate_temporal")]),e._v(", "),o("code",[e._v("filter_temporal")]),e._v(", "),o("code",[e._v("load_collection")]),e._v(" and "),o("code",[e._v("load_result")]),e._v("/"),o("code",[e._v("load_stac")]),e._v(":\n"),o("ul",[o("li",[e._v("The temporal intervals must always be non-empty, i.e. the second instance in time must be after the first instance in time. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/331",target:"_blank",rel:"noopener noreferrer"}},[e._v("#331"),o("OutboundLink")],1)]),e._v(" "),o("li",[o("code",[e._v("24")]),e._v(" as the hour is not allowed anymore.** "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/331",target:"_blank",rel:"noopener noreferrer"}},[e._v("#331"),o("OutboundLink")],1)])])]),e._v(" "),o("li",[o("code",[e._v("inspect")]),e._v(": The parameter "),o("code",[e._v("message")]),e._v(" has been moved to be the second argument. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/369",target:"_blank",rel:"noopener noreferrer"}},[e._v("#369"),o("OutboundLink")],1)]),e._v(" "),o("li",[e._v("New definition for "),o("code",[e._v("aggregate_spatial")]),e._v(":\n"),o("ul",[o("li",[e._v("Allows more than 3 input dimensions "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/126",target:"_blank",rel:"noopener noreferrer"}},[e._v("#126"),o("OutboundLink")],1)]),e._v(" "),o("li",[e._v("Allow to not export statistics by changing the parameter "),o("code",[e._v("target_dimension")]),e._v(" "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/366",target:"_blank",rel:"noopener noreferrer"}},[e._v("#366"),o("OutboundLink")],1)])])]),e._v(" "),o("li",[e._v("Updated the processes based on the subtypes "),o("code",[e._v("raster-cube")]),e._v(" or "),o("code",[e._v("vector-cube")]),e._v(" to work with the subtype "),o("code",[e._v("datacube")]),e._v(" instead. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/68",target:"_blank",rel:"noopener noreferrer"}},[e._v("#68"),o("OutboundLink")],1)]),e._v(" "),o("li",[o("code",[e._v("sort")]),e._v(" and "),o("code",[e._v("order")]),e._v(": The ordering of ties is not defined anymore. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/409",target:"_blank",rel:"noopener noreferrer"}},[e._v("#409"),o("OutboundLink")],1)]),e._v(" "),o("li",[o("code",[e._v("quantiles")]),e._v(": Parameter "),o("code",[e._v("probabilities")]),e._v(" provided as array must be in ascending order. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/pull/297",target:"_blank",rel:"noopener noreferrer"}},[e._v("#297"),o("OutboundLink")],1)]),e._v(" "),o("li",[o("code",[e._v("fit_curve")]),e._v(" and "),o("code",[e._v("predict_curve")]),e._v(": Heavily modified specifications. "),o("code",[e._v("fit_curve")]),e._v(" works on arrays instead of data cubes, "),o("code",[e._v("predict_curve")]),e._v(" doesn't support gap filling anymore, clarify no-data handling, ... "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/425",target:"_blank",rel:"noopener noreferrer"}},[e._v("#425"),o("OutboundLink")],1)]),e._v(" "),o("li",[o("code",[e._v("climatological_normal")]),e._v(": The "),o("code",[e._v("climatology_period")]),e._v(" parameter accepts an array of integers instead of strings. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/331",target:"_blank",rel:"noopener noreferrer"}},[e._v("#331"),o("OutboundLink")],1)]),e._v(" "),o("li",[o("code",[e._v("between")]),e._v(": Support for temporal comparison. Use "),o("code",[e._v("date_between")]),e._v(" instead. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/331",target:"_blank",rel:"noopener noreferrer"}},[e._v("#331"),o("OutboundLink")],1)]),e._v(" "),o("li",[e._v("Deprecated "),o("code",[e._v("GeometryCollections")]),e._v(" are not supported any longer. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/389",target:"_blank",rel:"noopener noreferrer"}},[e._v("#389"),o("OutboundLink")],1)]),e._v(" "),o("li",[e._v("Deprecated PROJ definitions for the CRS are not supported any longer.")]),e._v(" "),o("li",[e._v("The comparison processes "),o("code",[e._v("eq")]),e._v(", "),o("code",[e._v("neq")]),e._v(", "),o("code",[e._v("lt")]),e._v(", "),o("code",[e._v("lte")]),e._v(", "),o("code",[e._v("gt")]),e._v(", "),o("code",[e._v("gte")]),e._v(" and "),o("code",[e._v("array_contains")]),e._v(":\n"),o("ul",[o("li",[e._v("Removed support for temporal comparison. Instead explicitly use "),o("code",[e._v("date_difference")]),e._v(".")]),e._v(" "),o("li",[e._v("Removed support for the input data types array and object. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/208",target:"_blank",rel:"noopener noreferrer"}},[e._v("#208"),o("OutboundLink")],1)])])]),e._v(" "),o("li",[o("code",[e._v("sort")]),e._v(" and "),o("code",[e._v("order")]),e._v(": Removed support for time-only values. "),o("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues/331",target:"_blank",rel:"noopener noreferrer"}},[e._v("#331"),o("OutboundLink")],1)])])])}),[],!1,null,null,null);o.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/107.e39878e3.js b/assets/js/107.83d14bd4.js similarity index 96% rename from assets/js/107.e39878e3.js rename to assets/js/107.83d14bd4.js index 6c04db5c1..335b7d68a 100644 --- a/assets/js/107.e39878e3.js +++ b/assets/js/107.83d14bd4.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[107],{557:function(e,o,t){"use strict";t.r(o);var n=t(4),s=Object(n.a)({},(function(){var e=this,o=e._self._c;return o("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[o("p",[e._v("The openEO PSC is happy to share that we have submitted openEO to OGC for consideration as an OGC community standard.\nMore specifically, the "),o("a",{attrs:{href:"https://github.com/Open-EO/PSC/blob/main/documents/ogc-submission.adoc",target:"_blank",rel:"noopener noreferrer"}},[e._v("submission document"),o("OutboundLink")],1),e._v(" justifies why the openEO API specification (version 1.2.0) and the openEO process specification (version 1.2.0) are - from our point of view - a good candidate for an OGC community standard.\nWe hope OGC accepts our documents and establishes the corresponding procedures soon.")]),e._v(" "),o("p",[e._v("The members of the openEO PSC voted to submit the justification document to OGC by unanimous consent.\nWe are glad that the following OGC members confirmed to support the OCG submmissin of openEO:")]),e._v(" "),o("ul",[o("li",[e._v("University of Münster - Institute for Geoinformatics")]),e._v(" "),o("li",[e._v("Eurac Research")]),e._v(" "),o("li",[e._v("VITO (Flemish Institute for Technological Research)")]),e._v(" "),o("li",[e._v("GeoConnections - Natural Resources Canada")]),e._v(" "),o("li",[e._v("EUMETSAT")]),e._v(" "),o("li",[e._v("European Space Agency (ESA)")]),e._v(" "),o("li",[e._v("EOX IT Services GmbH")]),e._v(" "),o("li",[e._v("Telespazio VEGA UK Ltd")]),e._v(" "),o("li",[e._v("Planet Labs PBC")]),e._v(" "),o("li",[e._v("German Aerospace Center – DLR")]),e._v(" "),o("li",[e._v("Matthias Mohr - Softwareentwicklung")])]),e._v(" "),o("p",[e._v("We'll keep you updated about the progress. The next step is likely a public request for comments.")])])}),[],!1,null,null,null);o.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[107],{558:function(e,o,t){"use strict";t.r(o);var n=t(4),s=Object(n.a)({},(function(){var e=this,o=e._self._c;return o("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[o("p",[e._v("The openEO PSC is happy to share that we have submitted openEO to OGC for consideration as an OGC community standard.\nMore specifically, the "),o("a",{attrs:{href:"https://github.com/Open-EO/PSC/blob/main/documents/ogc-submission.adoc",target:"_blank",rel:"noopener noreferrer"}},[e._v("submission document"),o("OutboundLink")],1),e._v(" justifies why the openEO API specification (version 1.2.0) and the openEO process specification (version 1.2.0) are - from our point of view - a good candidate for an OGC community standard.\nWe hope OGC accepts our documents and establishes the corresponding procedures soon.")]),e._v(" "),o("p",[e._v("The members of the openEO PSC voted to submit the justification document to OGC by unanimous consent.\nWe are glad that the following OGC members confirmed to support the OCG submmissin of openEO:")]),e._v(" "),o("ul",[o("li",[e._v("University of Münster - Institute for Geoinformatics")]),e._v(" "),o("li",[e._v("Eurac Research")]),e._v(" "),o("li",[e._v("VITO (Flemish Institute for Technological Research)")]),e._v(" "),o("li",[e._v("GeoConnections - Natural Resources Canada")]),e._v(" "),o("li",[e._v("EUMETSAT")]),e._v(" "),o("li",[e._v("European Space Agency (ESA)")]),e._v(" "),o("li",[e._v("EOX IT Services GmbH")]),e._v(" "),o("li",[e._v("Telespazio VEGA UK Ltd")]),e._v(" "),o("li",[e._v("Planet Labs PBC")]),e._v(" "),o("li",[e._v("German Aerospace Center – DLR")]),e._v(" "),o("li",[e._v("Matthias Mohr - Softwareentwicklung")])]),e._v(" "),o("p",[e._v("We'll keep you updated about the progress. The next step is likely a public request for comments.")])])}),[],!1,null,null,null);o.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/108.e8cf09cc.js b/assets/js/108.1922640d.js similarity index 94% rename from assets/js/108.e8cf09cc.js rename to assets/js/108.1922640d.js index dbb778476..798b5db57 100644 --- a/assets/js/108.e8cf09cc.js +++ b/assets/js/108.1922640d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[108],{558:function(e,t,n){"use strict";n.r(t);var o=n(4),s=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("p",[e._v("After submitting openEO to OGC for consideration as an OGC community standard two months ago,\nOGC now seeks public comment on the potential adoption of openEO as an OGC Community Standard.\nComments are due by February 27, 2024.")]),e._v(" "),t("p",[e._v("For more details, please read the press release that was published today by OGC:\n"),t("strong",[t("a",{attrs:{href:"https://www.ogc.org/requests/ogc-considering-openeo-as-a-community-standard-comment-sought-on-its-adoption/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Request for Comments: OGC considering openEO as a Community Standard; comment sought on its adoption"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("openEO will also be presented at the next OGC member meeting in Delft on Thu, 28 Mar 2024 during the closing planery.")]),e._v(" "),t("p",[e._v("We'll keep you updated about the progress.")])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[108],{559:function(e,t,n){"use strict";n.r(t);var o=n(4),s=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("p",[e._v("After submitting openEO to OGC for consideration as an OGC community standard two months ago,\nOGC now seeks public comment on the potential adoption of openEO as an OGC Community Standard.\nComments are due by February 27, 2024.")]),e._v(" "),t("p",[e._v("For more details, please read the press release that was published today by OGC:\n"),t("strong",[t("a",{attrs:{href:"https://www.ogc.org/requests/ogc-considering-openeo-as-a-community-standard-comment-sought-on-its-adoption/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Request for Comments: OGC considering openEO as a Community Standard; comment sought on its adoption"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("openEO will also be presented at the next OGC member meeting in Delft on Thu, 28 Mar 2024 during the closing planery.")]),e._v(" "),t("p",[e._v("We'll keep you updated about the progress.")])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/110.30647715.js b/assets/js/110.36e201e5.js similarity index 85% rename from assets/js/110.30647715.js rename to assets/js/110.36e201e5.js index 67c71e8b1..0a4671b63 100644 --- a/assets/js/110.30647715.js +++ b/assets/js/110.36e201e5.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[110],{561:function(t,s,e){"use strict";e.r(s);var n=e(4),r=Object(n.a)({},(function(){var t=this._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"news"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#news"}},[this._v("#")]),this._v(" News")]),this._v(" "),t("News")],1)}),[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[110],{563:function(t,s,e){"use strict";e.r(s);var n=e(4),r=Object(n.a)({},(function(){var t=this._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"news"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#news"}},[this._v("#")]),this._v(" News")]),this._v(" "),t("News")],1)}),[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/111.ac5caffd.js b/assets/js/111.906d682b.js similarity index 99% rename from assets/js/111.ac5caffd.js rename to assets/js/111.906d682b.js index 446c467c6..a27f8c822 100644 --- a/assets/js/111.ac5caffd.js +++ b/assets/js/111.906d682b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[111],{562:function(e,t,o){"use strict";o.r(t);var r=o(4),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"openeo-project-steering-committee"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#openeo-project-steering-committee"}},[e._v("#")]),e._v(" openEO Project Steering Committee")]),e._v(" "),t("p",[e._v("This document describes how the openEO Project Steering Committee determines membership, and makes decisions on openEO project issues. The openEO project is concerned with all repositories (software and specifications etc.) found under "),t("a",{attrs:{href:"https://github.com/Open-EO",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/Open-EO"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("In brief the committee votes on proposals on "),t("a",{attrs:{href:"https://github.com/Open-EO/PSC/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/Open-EO/PSC/issues"),t("OutboundLink")],1),e._v(". Proposals are available for review for at least five business days, and a single veto is sufficient to delay progress though ultimately a majority of members can pass a proposal.")]),e._v(" "),t("h2",{attrs:{id:"members"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#members"}},[e._v("#")]),e._v(" Members")]),e._v(" "),t("p",[e._v("The list of members of the Project Steering Committee is:")]),e._v(" "),t("ul",[t("li",[e._v("Jeroen Dries ("),t("a",{attrs:{href:"https://github.com/jdries",target:"_blank",rel:"noopener noreferrer"}},[e._v("@jdries"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Alexander Jacob ("),t("a",{attrs:{href:"https://github.com/aljacob",target:"_blank",rel:"noopener noreferrer"}},[e._v("@aljacob"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Miha Kadunc ("),t("a",{attrs:{href:"https://github.com/mkadunc",target:"_blank",rel:"noopener noreferrer"}},[e._v("@mkadunc"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Matthias Mohr ("),t("strong",[e._v("chair")]),e._v(", "),t("a",{attrs:{href:"https://github.com/m-mohr",target:"_blank",rel:"noopener noreferrer"}},[e._v("@m-mohr"),t("OutboundLink")],1),e._v(", e-mail: openeo.psc@uni-muenster.de)")]),e._v(" "),t("li",[e._v("Markus Neteler ("),t("a",{attrs:{href:"https://github.com/neteler",target:"_blank",rel:"noopener noreferrer"}},[e._v("@neteler"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Edzer Pebesma ("),t("a",{attrs:{href:"https://github.com/edzer",target:"_blank",rel:"noopener noreferrer"}},[e._v("@edzer"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Benjamin Schumacher ("),t("a",{attrs:{href:"https://github.com/bschumac",target:"_blank",rel:"noopener noreferrer"}},[e._v("@bschumac"),t("OutboundLink")],1),e._v(")")])]),e._v(" "),t("p",[e._v("The current list will be maintained by the openEO chair on this page and will be published to the openEO web pages, too.")]),e._v(" "),t("h2",{attrs:{id:"detailed-process"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#detailed-process"}},[e._v("#")]),e._v(" Detailed Process")]),e._v(" "),t("ol",[t("li",[e._v("Proposals are written up and submitted on "),t("a",{attrs:{href:"https://github.com/Open-EO/PSC/issues/new/choose",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/Open-EO/PSC/issues/new/choose"),t("OutboundLink")],1),e._v(" for discussion and voting, by any interested party, not just committee members.")]),e._v(" "),t("li",[e._v("Proposals need to be available for review for at least five business days before a final decision can be made. Public holidays count as business days.")]),e._v(" "),t("li",[e._v("Respondents may vote "),t("code",[e._v("+1")]),e._v(" to indicate support for the proposal and a willingness to support implementation.")]),e._v(" "),t("li",[e._v("Respondents may vote "),t("code",[e._v("-1")]),e._v(" to veto a proposal, but must provide clear reasoning and alternate approaches to resolving the problem within the five business days.")]),e._v(" "),t("li",[e._v("A vote of "),t("code",[e._v("-0")]),e._v(" indicates mild disagreement, but has no effect. A "),t("code",[e._v("0")]),e._v(" indicates no opinion. A "),t("code",[e._v("+0")]),e._v(" indicates mild support, but has no effect.")]),e._v(" "),t("li",[e._v("Anyone may comment on proposals on the list, but only members of the Project Steering Committee’s votes will be counted.")]),e._v(" "),t("li",[e._v("A proposal will be accepted if it receives +4 (including the proposer) and no vetoes (-1) or has not received enough votes in 20 business days.")]),e._v(" "),t("li",[e._v("If a proposal is vetoed, and it cannot be revised to satisfy all parties, then it can be resubmitted for an override vote in which a majority of all eligible voters indicating +1 is sufficient to pass it. Note that this is a majority of all committee members, not just those who actively vote.")]),e._v(" "),t("li",[e._v("Upon completion of discussion and voting the proposer should announce whether they are proceeding (proposal accepted) or are withdrawing their proposal (vetoed).")]),e._v(" "),t("li",[e._v("The Chair gets a vote.")]),e._v(" "),t("li",[e._v("The Chair is responsible for keeping track of who is a member of the Project Steering Committee.")]),e._v(" "),t("li",[e._v("Addition and removal of members from the committee, as well as selection of a Chair should be handled as a proposal to the committee.")]),e._v(" "),t("li",[e._v("The Chair adjudicates in cases of disputes about voting.")])]),e._v(" "),t("h3",{attrs:{id:"when-is-vote-required"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#when-is-vote-required"}},[e._v("#")]),e._v(" When is Vote Required?")]),e._v(" "),t("p",[e._v("Generally speaking, technical decisions should be made by consensus within openEO components. However, if a decision cannot be decided by consensus of the committers involved in the component, any committer can request the decision be brought to a vote of the openEO PSC. Technical decision that would be suitable for such a process include:")]),e._v(" "),t("ul",[t("li",[e._v("Any change to PSC membership (new members, removing inactive members)")]),e._v(" "),t("li",[e._v("Anything that could cause backward compatibility issues in normative specifications (e.g., API or process specifications).")]),e._v(" "),t("li",[e._v("Adding or changing substantial amounts of the normative specifications.")]),e._v(" "),t("li",[e._v("Issues of procedure (e.g. changes to these guidelines).")]),e._v(" "),t("li",[e._v("When stable releases should take place.")]),e._v(" "),t("li",[e._v("Strategic decisions regarding the project and anything that might be controversial.")])]),e._v(" "),t("h3",{attrs:{id:"final-remarks"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#final-remarks"}},[e._v("#")]),e._v(" Final remarks")]),e._v(" "),t("ul",[t("li",[e._v("The Chair is the ultimate adjudicator if things break down.")]),e._v(" "),t("li",[e._v("The absolute majority rule can be used to override an obstructionist veto, but it is intended that in normal circumstances vetoers need to be convinced to withdraw their veto. We are trying to reach consensus.")]),e._v(" "),t("li",[e._v("Software components that at least two other software repositories under "),t("a",{attrs:{href:"https://github.com/Open-EO",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/Open-EO"),t("OutboundLink")],1),e._v(" depend on, are encouraged to implement a review system for breaking changes (e.g. GitHub Pull Request Approvals) that require a certain number of approvals: 2 dependents require 1 approval, more than 2 dependents require 2 approvals. Exceptions for this must go through the PSC process.")])]),e._v(" "),t("h2",{attrs:{id:"committee-membership"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#committee-membership"}},[e._v("#")]),e._v(" Committee Membership")]),e._v(" "),t("h3",{attrs:{id:"adding-members"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#adding-members"}},[e._v("#")]),e._v(" Adding Members")]),e._v(" "),t("p",[e._v("Anyone with a contribution to the "),t("a",{attrs:{href:"https://github.com/Open-EO",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO organization"),t("OutboundLink")],1),e._v(" may nominate someone for committee membership at any time. Only existing PSC committee members may vote on new members. Nominees must receive a majority vote from existing members to be added to the PSC.")]),e._v(" "),t("h3",{attrs:{id:"stepping-down"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#stepping-down"}},[e._v("#")]),e._v(" Stepping Down")]),e._v(" "),t("p",[e._v("If for any reason a PSC member is not able to fully participate then they certainly are free to step down. If a member is not active (e.g., no voting or email participation) for a period of 12 months then the PSC reserves the right to seek nominations to fill that position. Should that person become active again then they would certainly be welcome, but would require a nomination.")]),e._v(" "),t("h2",{attrs:{id:"history"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#history"}},[e._v("#")]),e._v(" History")]),e._v(" "),t("p",[e._v("This document is based on the "),t("a",{attrs:{href:"https://gdal.org/development/rfc/rfc1_pmc.html#rfc-1",target:"_blank",rel:"noopener noreferrer"}},[e._v("GDAL Project Management Committee Guidelines"),t("OutboundLink")],1),e._v(" and was accepted by the openEO project board on October, 7 2020.")]),e._v(" "),t("p",[e._v("The following changes have been made thereafter: "),t("a",{attrs:{href:"https://github.com/Open-EO/PSC/compare/v1...main",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/Open-EO/PSC/compare/v1...main"),t("OutboundLink")],1)])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[111],{561:function(e,t,o){"use strict";o.r(t);var r=o(4),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"openeo-project-steering-committee"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#openeo-project-steering-committee"}},[e._v("#")]),e._v(" openEO Project Steering Committee")]),e._v(" "),t("p",[e._v("This document describes how the openEO Project Steering Committee determines membership, and makes decisions on openEO project issues. The openEO project is concerned with all repositories (software and specifications etc.) found under "),t("a",{attrs:{href:"https://github.com/Open-EO",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/Open-EO"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("In brief the committee votes on proposals on "),t("a",{attrs:{href:"https://github.com/Open-EO/PSC/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/Open-EO/PSC/issues"),t("OutboundLink")],1),e._v(". Proposals are available for review for at least five business days, and a single veto is sufficient to delay progress though ultimately a majority of members can pass a proposal.")]),e._v(" "),t("h2",{attrs:{id:"members"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#members"}},[e._v("#")]),e._v(" Members")]),e._v(" "),t("p",[e._v("The list of members of the Project Steering Committee is:")]),e._v(" "),t("ul",[t("li",[e._v("Jeroen Dries ("),t("a",{attrs:{href:"https://github.com/jdries",target:"_blank",rel:"noopener noreferrer"}},[e._v("@jdries"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Alexander Jacob ("),t("a",{attrs:{href:"https://github.com/aljacob",target:"_blank",rel:"noopener noreferrer"}},[e._v("@aljacob"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Miha Kadunc ("),t("a",{attrs:{href:"https://github.com/mkadunc",target:"_blank",rel:"noopener noreferrer"}},[e._v("@mkadunc"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Matthias Mohr ("),t("strong",[e._v("chair")]),e._v(", "),t("a",{attrs:{href:"https://github.com/m-mohr",target:"_blank",rel:"noopener noreferrer"}},[e._v("@m-mohr"),t("OutboundLink")],1),e._v(", e-mail: openeo.psc@uni-muenster.de)")]),e._v(" "),t("li",[e._v("Markus Neteler ("),t("a",{attrs:{href:"https://github.com/neteler",target:"_blank",rel:"noopener noreferrer"}},[e._v("@neteler"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Edzer Pebesma ("),t("a",{attrs:{href:"https://github.com/edzer",target:"_blank",rel:"noopener noreferrer"}},[e._v("@edzer"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Benjamin Schumacher ("),t("a",{attrs:{href:"https://github.com/bschumac",target:"_blank",rel:"noopener noreferrer"}},[e._v("@bschumac"),t("OutboundLink")],1),e._v(")")])]),e._v(" "),t("p",[e._v("The current list will be maintained by the openEO chair on this page and will be published to the openEO web pages, too.")]),e._v(" "),t("h2",{attrs:{id:"detailed-process"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#detailed-process"}},[e._v("#")]),e._v(" Detailed Process")]),e._v(" "),t("ol",[t("li",[e._v("Proposals are written up and submitted on "),t("a",{attrs:{href:"https://github.com/Open-EO/PSC/issues/new/choose",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/Open-EO/PSC/issues/new/choose"),t("OutboundLink")],1),e._v(" for discussion and voting, by any interested party, not just committee members.")]),e._v(" "),t("li",[e._v("Proposals need to be available for review for at least five business days before a final decision can be made. Public holidays count as business days.")]),e._v(" "),t("li",[e._v("Respondents may vote "),t("code",[e._v("+1")]),e._v(" to indicate support for the proposal and a willingness to support implementation.")]),e._v(" "),t("li",[e._v("Respondents may vote "),t("code",[e._v("-1")]),e._v(" to veto a proposal, but must provide clear reasoning and alternate approaches to resolving the problem within the five business days.")]),e._v(" "),t("li",[e._v("A vote of "),t("code",[e._v("-0")]),e._v(" indicates mild disagreement, but has no effect. A "),t("code",[e._v("0")]),e._v(" indicates no opinion. A "),t("code",[e._v("+0")]),e._v(" indicates mild support, but has no effect.")]),e._v(" "),t("li",[e._v("Anyone may comment on proposals on the list, but only members of the Project Steering Committee’s votes will be counted.")]),e._v(" "),t("li",[e._v("A proposal will be accepted if it receives +4 (including the proposer) and no vetoes (-1) or has not received enough votes in 20 business days.")]),e._v(" "),t("li",[e._v("If a proposal is vetoed, and it cannot be revised to satisfy all parties, then it can be resubmitted for an override vote in which a majority of all eligible voters indicating +1 is sufficient to pass it. Note that this is a majority of all committee members, not just those who actively vote.")]),e._v(" "),t("li",[e._v("Upon completion of discussion and voting the proposer should announce whether they are proceeding (proposal accepted) or are withdrawing their proposal (vetoed).")]),e._v(" "),t("li",[e._v("The Chair gets a vote.")]),e._v(" "),t("li",[e._v("The Chair is responsible for keeping track of who is a member of the Project Steering Committee.")]),e._v(" "),t("li",[e._v("Addition and removal of members from the committee, as well as selection of a Chair should be handled as a proposal to the committee.")]),e._v(" "),t("li",[e._v("The Chair adjudicates in cases of disputes about voting.")])]),e._v(" "),t("h3",{attrs:{id:"when-is-vote-required"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#when-is-vote-required"}},[e._v("#")]),e._v(" When is Vote Required?")]),e._v(" "),t("p",[e._v("Generally speaking, technical decisions should be made by consensus within openEO components. However, if a decision cannot be decided by consensus of the committers involved in the component, any committer can request the decision be brought to a vote of the openEO PSC. Technical decision that would be suitable for such a process include:")]),e._v(" "),t("ul",[t("li",[e._v("Any change to PSC membership (new members, removing inactive members)")]),e._v(" "),t("li",[e._v("Anything that could cause backward compatibility issues in normative specifications (e.g., API or process specifications).")]),e._v(" "),t("li",[e._v("Adding or changing substantial amounts of the normative specifications.")]),e._v(" "),t("li",[e._v("Issues of procedure (e.g. changes to these guidelines).")]),e._v(" "),t("li",[e._v("When stable releases should take place.")]),e._v(" "),t("li",[e._v("Strategic decisions regarding the project and anything that might be controversial.")])]),e._v(" "),t("h3",{attrs:{id:"final-remarks"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#final-remarks"}},[e._v("#")]),e._v(" Final remarks")]),e._v(" "),t("ul",[t("li",[e._v("The Chair is the ultimate adjudicator if things break down.")]),e._v(" "),t("li",[e._v("The absolute majority rule can be used to override an obstructionist veto, but it is intended that in normal circumstances vetoers need to be convinced to withdraw their veto. We are trying to reach consensus.")]),e._v(" "),t("li",[e._v("Software components that at least two other software repositories under "),t("a",{attrs:{href:"https://github.com/Open-EO",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/Open-EO"),t("OutboundLink")],1),e._v(" depend on, are encouraged to implement a review system for breaking changes (e.g. GitHub Pull Request Approvals) that require a certain number of approvals: 2 dependents require 1 approval, more than 2 dependents require 2 approvals. Exceptions for this must go through the PSC process.")])]),e._v(" "),t("h2",{attrs:{id:"committee-membership"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#committee-membership"}},[e._v("#")]),e._v(" Committee Membership")]),e._v(" "),t("h3",{attrs:{id:"adding-members"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#adding-members"}},[e._v("#")]),e._v(" Adding Members")]),e._v(" "),t("p",[e._v("Anyone with a contribution to the "),t("a",{attrs:{href:"https://github.com/Open-EO",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO organization"),t("OutboundLink")],1),e._v(" may nominate someone for committee membership at any time. Only existing PSC committee members may vote on new members. Nominees must receive a majority vote from existing members to be added to the PSC.")]),e._v(" "),t("h3",{attrs:{id:"stepping-down"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#stepping-down"}},[e._v("#")]),e._v(" Stepping Down")]),e._v(" "),t("p",[e._v("If for any reason a PSC member is not able to fully participate then they certainly are free to step down. If a member is not active (e.g., no voting or email participation) for a period of 12 months then the PSC reserves the right to seek nominations to fill that position. Should that person become active again then they would certainly be welcome, but would require a nomination.")]),e._v(" "),t("h2",{attrs:{id:"history"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#history"}},[e._v("#")]),e._v(" History")]),e._v(" "),t("p",[e._v("This document is based on the "),t("a",{attrs:{href:"https://gdal.org/development/rfc/rfc1_pmc.html#rfc-1",target:"_blank",rel:"noopener noreferrer"}},[e._v("GDAL Project Management Committee Guidelines"),t("OutboundLink")],1),e._v(" and was accepted by the openEO project board on October, 7 2020.")]),e._v(" "),t("p",[e._v("The following changes have been made thereafter: "),t("a",{attrs:{href:"https://github.com/Open-EO/PSC/compare/v1...main",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/Open-EO/PSC/compare/v1...main"),t("OutboundLink")],1)])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/112.350b20cf.js b/assets/js/112.e18361f3.js similarity index 99% rename from assets/js/112.350b20cf.js rename to assets/js/112.e18361f3.js index acb0f0d71..58013c3f5 100644 --- a/assets/js/112.350b20cf.js +++ b/assets/js/112.e18361f3.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[112],{563:function(e,r,t){"use strict";t.r(r);var n=t(4),o=Object(n.a)({},(function(){var e=this,r=e._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"software"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#software"}},[e._v("#")]),e._v(" Software")]),e._v(" "),r("p",[e._v("All developed software is organized within the "),r("a",{attrs:{href:"https://github.com/open-eo/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO GitHub organization"),r("OutboundLink")],1),e._v(".")]),e._v(" "),r("h2",{attrs:{id:"clients"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clients"}},[e._v("#")]),e._v(" Clients")]),e._v(" "),r("p",[e._v("Software that allows remote sensers and other users to access the openEO back-ends:")]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Client software")]),e._v(" "),r("th",[e._v("Package Manager / Hosted Version")]),e._v(" "),r("th",[e._v("GitHub")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("JavaScript/TypeScript library")]),e._v(" "),r("td",[e._v("npm: "),r("a",{attrs:{href:"https://www.npmjs.com/package/@openeo/js-client",target:"_blank",rel:"noopener noreferrer"}},[e._v("@openeo/js-client"),r("OutboundLink")],1)]),e._v(" "),r("td",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-js-client",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo-js-client"),r("OutboundLink")],1)])]),e._v(" "),r("tr",[r("td",[e._v("Python library")]),e._v(" "),r("td",[e._v("PyPI: "),r("a",{attrs:{href:"https://pypi.org/project/openeo/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo"),r("OutboundLink")],1),e._v(" / Conda Forge: "),r("a",{attrs:{href:"https://anaconda.org/conda-forge/openeo",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo"),r("OutboundLink")],1)]),e._v(" "),r("td",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-python-client",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo-python-client"),r("OutboundLink")],1)])]),e._v(" "),r("tr",[r("td",[e._v("QGIS plugin")]),e._v(" "),r("td",[e._v("QGIS plugin repository: "),r("a",{attrs:{href:"https://plugins.qgis.org/plugins/openeo-qgis-plugin-master/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo-qgis-plugin-master"),r("OutboundLink")],1)]),e._v(" "),r("td",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-qgis-plugin",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo-qgis-plugin"),r("OutboundLink")],1)])]),e._v(" "),r("tr",[r("td",[e._v("R library")]),e._v(" "),r("td",[e._v("CRAN: "),r("a",{attrs:{href:"https://cran.r-project.org/package=openeo",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo"),r("OutboundLink")],1)]),e._v(" "),r("td",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo-r-client"),r("OutboundLink")],1)])]),e._v(" "),r("tr",[r("td",[e._v("Web Editor")]),e._v(" "),r("td",[r("a",{attrs:{href:"https://editor.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("Hosted Version"),r("OutboundLink")],1)]),e._v(" "),r("td",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-web-editor",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo-web-editor"),r("OutboundLink")],1)])])])]),e._v(" "),r("p",[e._v("See the "),r("a",{attrs:{href:e.$site.themeConfig.docPath+"getting-started.html"}},[r("strong",[e._v("getting started guide for users")])]),e._v(" for more information.\nUsers considering to implement a new client library should read the "),r("a",{attrs:{href:e.$site.themeConfig.docPath+"developers/clients/getting-started.html"}},[r("strong",[e._v("getting started guide for client developers")])]),e._v(".")]),e._v(" "),r("h2",{attrs:{id:"back-ends"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#back-ends"}},[e._v("#")]),e._v(" Back-ends")]),e._v(" "),r("p",[e._v("Data and infrastructure providers can host their own instance of the openEO API:")]),e._v(" "),r("ul",[r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-geopyspark-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("GeoPySpark (Geotrellis)"),r("OutboundLink")],1),e._v(" (by VITO) - has "),r("a",{attrs:{href:"https://github.com/Open-EO/openeo-geopyspark-integrationtests",target:"_blank",rel:"noopener noreferrer"}},[e._v("integration tests"),r("OutboundLink")],1),e._v(", requires "),r("a",{attrs:{href:"https://github.com/Open-EO/openeo-geotrellis-extensions",target:"_blank",rel:"noopener noreferrer"}},[e._v("GeoTrellis extensions"),r("OutboundLink")],1),e._v(".")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-earthengine-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Google Earth Engine"),r("OutboundLink")],1),e._v(" (by WWU)")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-grassgis-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("GRASS GIS"),r("OutboundLink")],1),e._v(" (by mundialis)")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-jeodpp-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("JEODPP"),r("OutboundLink")],1),e._v(" (by JRC)")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/SARScripts/openeo_odc_driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Open Data Cube"),r("OutboundLink")],1),e._v(" (by EURAC, funded by ESA)")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-eodc-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Apache Airflow / eoDataReaders"),r("OutboundLink")],1),e._v(" (by EODC)")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-sentinelhub-python-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Sentinel Hub"),r("OutboundLink")],1),e._v(" (by Sinergise)")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-wcps-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("WCPS (rasdaman)"),r("OutboundLink")],1),e._v(" (by EURAC)")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-backend",target:"_blank",rel:"noopener noreferrer"}},[e._v("R back-end"),r("OutboundLink")],1),e._v(" (by WWU) - discontinued until further notice (last version: 0.3)")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/IBM/tensorlakehouse-openeo-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("TensorLakeHouse"),r("OutboundLink")],1),e._v(" (by IBM Research)")])]),e._v(" "),r("p",[e._v("See the "),r("a",{attrs:{href:e.$site.themeConfig.docPath+"developers/backends/getting-started.html"}},[r("strong",[e._v("getting started guide for back-end providers")])]),e._v(" for more information.")]),e._v(" "),r("p",[e._v("To start developing a new back-end driver, you may start with any of the common functionalities implemented in several programming languages:")]),e._v(" "),r("ul",[r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-spring-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Java (Spring) API Commons"),r("OutboundLink")],1)]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-python-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Python API Commons"),r("OutboundLink")],1)]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-pg-parser-python",target:"_blank",rel:"noopener noreferrer"}},[e._v("Python Process Graph Parser"),r("OutboundLink")],1)]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-js-processgraphs",target:"_blank",rel:"noopener noreferrer"}},[e._v("JavaScript Process Graph Parser"),r("OutboundLink")],1)]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes-python",target:"_blank",rel:"noopener noreferrer"}},[e._v("Python Processes"),r("OutboundLink")],1),e._v(" - many openEO processes implemented in Python")])]),e._v(" "),r("p",[e._v("Our approach to tackle language-agnostic user-defined functions can be found in the following repositories:")]),e._v(" "),r("ul",[r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-udf",target:"_blank",rel:"noopener noreferrer"}},[e._v("UDF Python reference implementation"),r("OutboundLink")],1)]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-udf",target:"_blank",rel:"noopener noreferrer"}},[e._v("UDF R reference implementation"),r("OutboundLink")],1)])]),e._v(" "),r("h2",{attrs:{id:"specification"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#specification"}},[e._v("#")]),e._v(" Specification")]),e._v(" "),r("p",[e._v("The API specification is available in the "),r("strong",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-api",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO API repository"),r("OutboundLink")],1)]),e._v(".\nThe process definitions are available in the "),r("strong",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO processes repository"),r("OutboundLink")],1)]),e._v(".")]),e._v(" "),r("h2",{attrs:{id:"ecosystem"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#ecosystem"}},[e._v("#")]),e._v(" Ecosystem")]),e._v(" "),r("ul",[r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-backend-validator",target:"_blank",rel:"noopener noreferrer"}},[e._v("Back-end validator"),r("OutboundLink")],1),e._v(" - Validation for back-end implementations. "),r("a",{attrs:{href:"https://github.com/Open-EO/openeo-result-validation-engine",target:"_blank",rel:"noopener noreferrer"}},[e._v("Image-based validation of EO processing results"),r("OutboundLink")],1),e._v(" is also worked on.")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://hub.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO Hub"),r("OutboundLink")],1),e._v(" ("),r("a",{attrs:{href:"https://github.com/Open-EO/openeo-hub",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub"),r("OutboundLink")],1),e._v(") - The central platform for openEO services.")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes-docgen",target:"_blank",rel:"noopener noreferrer"}},[e._v("Processes DocGen"),r("OutboundLink")],1),e._v(" - A tool to generate a visual interface for openEO process definitions.")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-vue-components",target:"_blank",rel:"noopener noreferrer"}},[e._v("Vue.js Components"),r("OutboundLink")],1),e._v(" - Common Vue.js 2 components for openEO")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-js-commons",target:"_blank",rel:"noopener noreferrer"}},[e._v("JavaScript Commons"),r("OutboundLink")],1),e._v(" - Common JavaScript functionality for openEO clients and back-ends")])])])}),[],!1,null,null,null);r.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[112],{562:function(e,r,t){"use strict";t.r(r);var n=t(4),o=Object(n.a)({},(function(){var e=this,r=e._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"software"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#software"}},[e._v("#")]),e._v(" Software")]),e._v(" "),r("p",[e._v("All developed software is organized within the "),r("a",{attrs:{href:"https://github.com/open-eo/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO GitHub organization"),r("OutboundLink")],1),e._v(".")]),e._v(" "),r("h2",{attrs:{id:"clients"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clients"}},[e._v("#")]),e._v(" Clients")]),e._v(" "),r("p",[e._v("Software that allows remote sensers and other users to access the openEO back-ends:")]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Client software")]),e._v(" "),r("th",[e._v("Package Manager / Hosted Version")]),e._v(" "),r("th",[e._v("GitHub")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("JavaScript/TypeScript library")]),e._v(" "),r("td",[e._v("npm: "),r("a",{attrs:{href:"https://www.npmjs.com/package/@openeo/js-client",target:"_blank",rel:"noopener noreferrer"}},[e._v("@openeo/js-client"),r("OutboundLink")],1)]),e._v(" "),r("td",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-js-client",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo-js-client"),r("OutboundLink")],1)])]),e._v(" "),r("tr",[r("td",[e._v("Python library")]),e._v(" "),r("td",[e._v("PyPI: "),r("a",{attrs:{href:"https://pypi.org/project/openeo/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo"),r("OutboundLink")],1),e._v(" / Conda Forge: "),r("a",{attrs:{href:"https://anaconda.org/conda-forge/openeo",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo"),r("OutboundLink")],1)]),e._v(" "),r("td",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-python-client",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo-python-client"),r("OutboundLink")],1)])]),e._v(" "),r("tr",[r("td",[e._v("QGIS plugin")]),e._v(" "),r("td",[e._v("QGIS plugin repository: "),r("a",{attrs:{href:"https://plugins.qgis.org/plugins/openeo-qgis-plugin-master/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo-qgis-plugin-master"),r("OutboundLink")],1)]),e._v(" "),r("td",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-qgis-plugin",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo-qgis-plugin"),r("OutboundLink")],1)])]),e._v(" "),r("tr",[r("td",[e._v("R library")]),e._v(" "),r("td",[e._v("CRAN: "),r("a",{attrs:{href:"https://cran.r-project.org/package=openeo",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo"),r("OutboundLink")],1)]),e._v(" "),r("td",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo-r-client"),r("OutboundLink")],1)])]),e._v(" "),r("tr",[r("td",[e._v("Web Editor")]),e._v(" "),r("td",[r("a",{attrs:{href:"https://editor.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("Hosted Version"),r("OutboundLink")],1)]),e._v(" "),r("td",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-web-editor",target:"_blank",rel:"noopener noreferrer"}},[e._v("openeo-web-editor"),r("OutboundLink")],1)])])])]),e._v(" "),r("p",[e._v("See the "),r("a",{attrs:{href:e.$site.themeConfig.docPath+"getting-started.html"}},[r("strong",[e._v("getting started guide for users")])]),e._v(" for more information.\nUsers considering to implement a new client library should read the "),r("a",{attrs:{href:e.$site.themeConfig.docPath+"developers/clients/getting-started.html"}},[r("strong",[e._v("getting started guide for client developers")])]),e._v(".")]),e._v(" "),r("h2",{attrs:{id:"back-ends"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#back-ends"}},[e._v("#")]),e._v(" Back-ends")]),e._v(" "),r("p",[e._v("Data and infrastructure providers can host their own instance of the openEO API:")]),e._v(" "),r("ul",[r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-geopyspark-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("GeoPySpark (Geotrellis)"),r("OutboundLink")],1),e._v(" (by VITO) - has "),r("a",{attrs:{href:"https://github.com/Open-EO/openeo-geopyspark-integrationtests",target:"_blank",rel:"noopener noreferrer"}},[e._v("integration tests"),r("OutboundLink")],1),e._v(", requires "),r("a",{attrs:{href:"https://github.com/Open-EO/openeo-geotrellis-extensions",target:"_blank",rel:"noopener noreferrer"}},[e._v("GeoTrellis extensions"),r("OutboundLink")],1),e._v(".")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-earthengine-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Google Earth Engine"),r("OutboundLink")],1),e._v(" (by WWU)")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-grassgis-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("GRASS GIS"),r("OutboundLink")],1),e._v(" (by mundialis)")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-jeodpp-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("JEODPP"),r("OutboundLink")],1),e._v(" (by JRC)")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/SARScripts/openeo_odc_driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Open Data Cube"),r("OutboundLink")],1),e._v(" (by EURAC, funded by ESA)")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-eodc-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Apache Airflow / eoDataReaders"),r("OutboundLink")],1),e._v(" (by EODC)")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-sentinelhub-python-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Sentinel Hub"),r("OutboundLink")],1),e._v(" (by Sinergise)")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-wcps-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("WCPS (rasdaman)"),r("OutboundLink")],1),e._v(" (by EURAC)")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-backend",target:"_blank",rel:"noopener noreferrer"}},[e._v("R back-end"),r("OutboundLink")],1),e._v(" (by WWU) - discontinued until further notice (last version: 0.3)")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/IBM/tensorlakehouse-openeo-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("TensorLakeHouse"),r("OutboundLink")],1),e._v(" (by IBM Research)")])]),e._v(" "),r("p",[e._v("See the "),r("a",{attrs:{href:e.$site.themeConfig.docPath+"developers/backends/getting-started.html"}},[r("strong",[e._v("getting started guide for back-end providers")])]),e._v(" for more information.")]),e._v(" "),r("p",[e._v("To start developing a new back-end driver, you may start with any of the common functionalities implemented in several programming languages:")]),e._v(" "),r("ul",[r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-spring-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Java (Spring) API Commons"),r("OutboundLink")],1)]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-python-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Python API Commons"),r("OutboundLink")],1)]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-pg-parser-python",target:"_blank",rel:"noopener noreferrer"}},[e._v("Python Process Graph Parser"),r("OutboundLink")],1)]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-js-processgraphs",target:"_blank",rel:"noopener noreferrer"}},[e._v("JavaScript Process Graph Parser"),r("OutboundLink")],1)]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes-python",target:"_blank",rel:"noopener noreferrer"}},[e._v("Python Processes"),r("OutboundLink")],1),e._v(" - many openEO processes implemented in Python")])]),e._v(" "),r("p",[e._v("Our approach to tackle language-agnostic user-defined functions can be found in the following repositories:")]),e._v(" "),r("ul",[r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-udf",target:"_blank",rel:"noopener noreferrer"}},[e._v("UDF Python reference implementation"),r("OutboundLink")],1)]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-udf",target:"_blank",rel:"noopener noreferrer"}},[e._v("UDF R reference implementation"),r("OutboundLink")],1)])]),e._v(" "),r("h2",{attrs:{id:"specification"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#specification"}},[e._v("#")]),e._v(" Specification")]),e._v(" "),r("p",[e._v("The API specification is available in the "),r("strong",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-api",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO API repository"),r("OutboundLink")],1)]),e._v(".\nThe process definitions are available in the "),r("strong",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO processes repository"),r("OutboundLink")],1)]),e._v(".")]),e._v(" "),r("h2",{attrs:{id:"ecosystem"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#ecosystem"}},[e._v("#")]),e._v(" Ecosystem")]),e._v(" "),r("ul",[r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-backend-validator",target:"_blank",rel:"noopener noreferrer"}},[e._v("Back-end validator"),r("OutboundLink")],1),e._v(" - Validation for back-end implementations. "),r("a",{attrs:{href:"https://github.com/Open-EO/openeo-result-validation-engine",target:"_blank",rel:"noopener noreferrer"}},[e._v("Image-based validation of EO processing results"),r("OutboundLink")],1),e._v(" is also worked on.")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://hub.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO Hub"),r("OutboundLink")],1),e._v(" ("),r("a",{attrs:{href:"https://github.com/Open-EO/openeo-hub",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub"),r("OutboundLink")],1),e._v(") - The central platform for openEO services.")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes-docgen",target:"_blank",rel:"noopener noreferrer"}},[e._v("Processes DocGen"),r("OutboundLink")],1),e._v(" - A tool to generate a visual interface for openEO process definitions.")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-vue-components",target:"_blank",rel:"noopener noreferrer"}},[e._v("Vue.js Components"),r("OutboundLink")],1),e._v(" - Common Vue.js 2 components for openEO")]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/Open-EO/openeo-js-commons",target:"_blank",rel:"noopener noreferrer"}},[e._v("JavaScript Commons"),r("OutboundLink")],1),e._v(" - Common JavaScript functionality for openEO clients and back-ends")])])])}),[],!1,null,null,null);r.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/15.f7f1e41c.js b/assets/js/15.f548d8e3.js similarity index 99% rename from assets/js/15.f7f1e41c.js rename to assets/js/15.f548d8e3.js index bd41e889d..c39008d4f 100644 --- a/assets/js/15.f7f1e41c.js +++ b/assets/js/15.f548d8e3.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[15],{325:function(e,t,o){e.exports=o.p+"assets/img/qgis_button.2b5f39a5.png"},326:function(e,t,o){e.exports=o.p+"assets/img/login_dialog.424c4b4e.png"},327:function(e,t,o){e.exports=o.p+"assets/img/backend_info.a00e7a1d.png"},328:function(e,t,o){e.exports=o.p+"assets/img/jobs.fef9e692.png"},329:function(e,t,o){e.exports=o.p+"assets/img/adapt_job.64ea4b55.png"},330:function(e,t,o){e.exports=o.p+"assets/img/edit_spatial.23df03fa.png"},331:function(e,t,o){e.exports=o.p+"assets/img/edit_temporal.609c87e2.png"},332:function(e,t,o){e.exports=o.p+"assets/img/edit_bands.d9ed77a5.png"},333:function(e,t,o){e.exports=o.p+"assets/img/edit_subpg.c7fbfd4d.png"},334:function(e,t,o){e.exports=o.p+"assets/img/services.a958fd61.png"},335:function(e,t,o){e.exports=o.p+"assets/img/services_create.0881f2cd.png"},534:function(e,t,o){"use strict";o.r(t);var n=o(4),a=Object(n.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"qgis-plugin"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#qgis-plugin"}},[e._v("#")]),e._v(" QGIS Plugin")]),e._v(" "),t("p",[e._v("The openEO QGIS plugin enables exploring openEO backends as well as execute and modify your jobs at an backend\nwithin QGIS. The plugin can load the results of a job execution to the QGIS map, so that the user can make further\nanalyses and visualisation steps.")]),e._v(" "),t("h2",{attrs:{id:"installation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[e._v("#")]),e._v(" Installation")]),e._v(" "),t("p",[e._v("There are two different versions of the QGIS Plugin available:")]),e._v(" "),t("ol",[t("li",[e._v("The "),t("strong",[e._v("latest stable version")]),e._v(' is accessible in the plugin\nmanager of QGIS (Plugins -> Manage and Install Plugins). Note that you have to activate the option to show experimental\nplugins (Settings -> Show also experimental plugins). After that, you can search for\n"OpenEO", install and activate the plugin.')]),e._v(" "),t("li",[e._v("The "),t("strong",[e._v("latest version")]),e._v(" is accessible at the\n"),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-qgis-plugin",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub repository"),t("OutboundLink")],1),e._v('. First, download the repository as zip archive.\nNow, open the plugin manager of QGIS (Plugins -> Manage and Install Plugins) and select "Install from ZIP".\nThere you can browse for the downloaded zip archive, install and activate it.')])]),e._v(" "),t("p",[e._v("This tutorial shows the capabilities of version 0.9.2. Make sure you have installed at least that version by checking in\nthe plugin manager.")]),e._v(" "),t("p",[e._v("After successfully installing and activating the plugin, the openEO logo should be part of the toolbar:")]),e._v(" "),t("p",[t("img",{attrs:{src:o(325),alt:"QGIS Plugin Icon"}})]),e._v(" "),t("p",[e._v("Simply click on the icon to start the plugin.")]),e._v(" "),t("h2",{attrs:{id:"connecting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#connecting"}},[e._v("#")]),e._v(" Connecting")]),e._v(" "),t("p",[e._v("The first window you see when starting the plugin is a login dialog, since you can only access your jobs at the backend\nif you are authenticated. The backend dropdown menu contains the available openEO backends from\nthe "),t("a",{attrs:{href:"https://hub.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO Hub"),t("OutboundLink")],1),e._v('. By default, the plugin chooses the latest compatible version from the\nselected provider. If you want to connect to a specific version of a backend, you need to uncheck\nthe checkbox labeled "Only Latest versions". You can also manually type a backend url into the selection\nfield, in case it is not registered at our hub yet.')]),e._v(" "),t("p",[t("img",{attrs:{src:o(326),alt:"QGIS Login Dialog"}})]),e._v(" "),t("p",[e._v("Now that you have chosen a backend, you can log in with your username and password provided by the backend.\nNote that the QGIS plugin only supports Basic authentication and not "),t("a",{attrs:{href:"https://openid.net/connect/",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenID Connect"),t("OutboundLink")],1),e._v(" yet.\nBackends that do not support this authentication can not be accessed via this plugin at the moment.")]),e._v(" "),t("p",[e._v("If logged in successfully, the main window of the plugin appears with three tabs ("),t("strong",[e._v("Backend Info")]),e._v(", "),t("strong",[e._v("Jobs")]),e._v(", "),t("strong",[e._v("Services")]),e._v(").\nThe following sections will go through the capabilities of these tabs.")]),e._v(" "),t("h2",{attrs:{id:"exploring-a-backend"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#exploring-a-backend"}},[e._v("#")]),e._v(" Exploring a backend")]),e._v(" "),t("p",[e._v("The first tab shows information about the backend and the available collections and processes.\nOn the top, there is a basic description about the backend you are connected to.\nNext, you can choose a collection in the drop down menu to see a description of that dataset.")]),e._v(" "),t("p",[t("img",{attrs:{src:o(327),alt:"QGIS Backend Info"}})]),e._v(" "),t("p",[e._v("On the bottom, you can use the drop down menu to choose one of the available processes from the backend.\nAfter selection, the parameters of the process are listed in the table below. The first column contains the\nparameter name, which is required if bold and otherwise optional.\nThe second column shows the type of the parameter (e.g. number) and the third column a short description.\nTo learn more about the process, you can click on the info button next to the drop down menu\n(marked red in the figure above). The return type of the process is written next to the info box. If you want to get an\noverview of all processes of openEO you might visit the "),t("RouterLink",{attrs:{to:"/documentation/1.0/processes.html"}},[e._v("official processes page")]),e._v(", but note that not all backends\nwill implement all processes listed there, whereas only available processes of the backend are in the QGIS plugin.")],1),e._v(" "),t("h2",{attrs:{id:"job-management"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#job-management"}},[e._v("#")]),e._v(" Job Management")]),e._v(" "),t("p",[e._v('The "Jobs" tab lists all of your '),t("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#data-processing-modes"}},[e._v("jobs")]),e._v("\nat the backend. In openEO a job describes what the backend needs to process\n(e.g. by defining a "),t("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#processes"}},[e._v("process graph")]),e._v(") as well as\nadditional meta-information (e.g. title, creation date). The first two columns show the title and the creation date of\nthe job. The other elements of the table are numbered in the screenshot and described in the following.")],1),e._v(" "),t("p",[t("img",{attrs:{src:o(328),alt:"QGIS Jobs"}})]),e._v(" "),t("ol",[t("li",[t("strong",[e._v("Status")]),e._v(' - Shows the current lifecycle state of the job. The first status of a job is "created",\nif it got created at the backend, but not executed yet. After the job gets executed it will be\n"queued" if the backend plans to executes it, but has not started yet. If the execution started but hasn\'t finished yet,\nit has the status of "running". Last but not least it will have either "canceled", if it was stopped during execution,\n"finished" if the execution was successfully or "error", if an error occurred during execution.')]),e._v(" "),t("li",[t("strong",[e._v("Execute")]),e._v(' - By clicking on the "Play" button, the plugin will start the execution of the job at the backend.\nAlready finished jobs are executed again. The icon of the button will change if the job is in the "running" state,\nso that it looks like a "Stop" button, which will cancel the job execution.')]),e._v(" "),t("li",[t("strong",[e._v("Display")]),e._v(' - By clicking on the "Eye" button, the plugin downloads the resulting image(s) of the job from the backend\nand creates a new layer in QGIS named after the title and the creation date of the image. Note that if the result\nis not geo referenced, you might get a dialog from QGIS to choose a coordinate reference system, therefore it is\nrecommended to choose GeoTiff as job output format if available at the backend.')]),e._v(" "),t("li",[t("strong",[e._v("Save")]),e._v(' - By clicking on the "Download" button, you can navigate to the folder where you want to store the\nresulting image(s) of the job and the plugin will download it there.')]),e._v(" "),t("li",[t("strong",[e._v("Adapt")]),e._v(' - By clicking on the "Pencil" button a new dialog appears, where you can adapt the job title and\ndescription as well as the processes and extent of the job. How this works in detail is described in the following sections.')]),e._v(" "),t("li",[t("strong",[e._v("Information")]),e._v(' - By clicking on the "Info" button a window with additional information about the job appears.\nIt contains information like a description, a cost plan etc., of course only if this information is provided by the\nbackend. If the backend provides a logging output, it is also part of this info window.')]),e._v(" "),t("li",[t("strong",[e._v("Delete")]),e._v(' - By clicking on the "Trash" button the job gets deleted from the backend, after being asked if you are\nreally sure about it.')]),e._v(" "),t("li",[t("strong",[e._v("Load Job from openEO Hub")]),e._v(" - At the moment it is recommended to not use this feature, since the exchange of\nprocess graphs in the OpenEO Hub is under development.")]),e._v(" "),t("li",[t("strong",[e._v("Create new Job in Web Editor")]),e._v(" - This button opens the "),t("a",{attrs:{href:"https://editor.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO web editor"),t("OutboundLink")],1),e._v(" in your\nsystem browser, so that you can create a new job using it. This is the recommended way for creating a new job, since it has\na graphical and therefore more convenient way of doing so.")]),e._v(" "),t("li",[t("strong",[e._v("Create new Job")]),e._v(" - You can create a job from scratch using this button.\nMore information in the next sections.")]),e._v(" "),t("li",[t("strong",[e._v("Refresh Table")]),e._v(" - This button refreshes the list of jobs manually, in general the list will refresh every few\nseconds. If you do not want to automatically refresh the list (it might cause some lags if the connection to the\nbackend is low) you can do so by deactivating the checkbox next to the refresh button.")]),e._v(" "),t("li",[t("strong",[e._v("User Manual")]),e._v(" - This button opens your browser with this introduction page.")])]),e._v(" "),t("h3",{attrs:{id:"creating-new-jobs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-new-jobs"}},[e._v("#")]),e._v(" Creating new Jobs")]),e._v(" "),t("p",[e._v("There are three approaches to create a new job using this plugin, depending on whether you want to start from scratch or just\nchange existing jobs:")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("From scratch with web editor")]),e._v(" - As described in the job table overview above, there is a button (no. 9) that opens\nyour web browser with the "),t("a",{attrs:{href:"https://editor.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO web editor"),t("OutboundLink")],1),e._v(". It is the recommended way to create a new job\nfrom scratch, since it has a very convenient graphical user interface. It also shows the process graph in a neat graph\nbased manner for a better understanding of how processes are connected.")]),e._v(" "),t("li",[t("strong",[e._v("From scratch with QGIS")]),e._v(' - If you want to use the QGIS plugin, you can create a new job using the\nbutton (no. 10) of the job overview dialog. It opens the job adaption window (more details in the section below).\nIn the beginning the job has already a "load_collection" process as a starting point.')]),e._v(" "),t("li",[t("strong",[e._v("From existing Job")]),e._v(" - You can create a new job by adapting\none of your existing jobs at the backend. You can e.g. create a new job with a different spatial extent, or\nadding a few processes to the original one. To do so, you need to click on the edit button in the job overview window (no. 5)")])]),e._v(" "),t("h3",{attrs:{id:"adapting-existing-jobs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#adapting-existing-jobs"}},[e._v("#")]),e._v(" Adapting existing Jobs")]),e._v(" "),t("p",[e._v("In this section you'll get an overview of the job adaption workflow using the job adaption window.\nHow you get there was described in the previous section.")]),e._v(" "),t("p",[t("img",{attrs:{src:o(329),alt:"QGIS Adapting Job"}})]),e._v(" "),t("ol",[t("li",[t("strong",[e._v("Job Title")]),e._v(" - Here you can write the title of the job. It is recommended to choose it in a way that\nmakes you identify the job in a list more easily.")]),e._v(" "),t("li",[t("strong",[e._v("Job Description")]),e._v(" - You can describe the job in more detail in this field (e.g. what is calculated and how).")]),e._v(" "),t("li",[t("strong",[e._v("Process Graph Table")]),e._v(" - In the process graph table you can see a list of all processes used by the job.\nThe first column contains the identifier of the process node, so a unique identifier of the process throughout the\nwhole process graph (e.g. loadcollection1). Most openEO clients generate these identifiers automatically. We define a\nprocess node (or just node) as one element of the process graph, so a single executed process."),t("br"),e._v('\nIn the second column you can see the name/identifier of the process (e.g. load_collection), which needs to be one of the\nprocesses that the backend provides. The third column shows the node identifier of the predecessor node.\nFor example, "loadcollection1" in the second row means that the output of the node with id "loadcollection1" is the input\nof the node with id "reducedimension1". In other words the process of the second row uses the output of the process of\nthe first row and is therefore executed after the first process.')]),e._v(" "),t("li",[t("strong",[e._v("Process Edit")]),e._v(' - When pressing on the "pencil" button, the process of the same row is loaded into the process\ntable on the right (see no. 6). On this table you can adapt the arguments of the chosen process and therefore configure\nits behaviour.')]),e._v(" "),t("li",[t("strong",[e._v("Delete Process")]),e._v(' - Clicking on the "trash" button deletes the selected process from the process graph.\nNote that other processes, which have this process as predecessor might fail after the deletion.')]),e._v(" "),t("li",[t("strong",[e._v("Undo Changes")]),e._v(" - Press this button if you want to undo all your changes on the job.")]),e._v(" "),t("li",[t("strong",[e._v("Raw Graph")]),e._v(' - Press this button to see the raw process graph (JSON format) in a pop up window. Changes to the\nprocess graph are also applied if you click "Apply". Therefore, you can also copy and paste here a complete process graph'),t("br"),e._v("\ninto the QGIS plugin.")]),e._v(" "),t("li",[t("strong",[e._v("Add Process")]),e._v(' - If you want to add a new process to the process graph you can select one at the drop down menu\n(see "Select a process") and press the button labeled "Add Process". The text field on the right will be the new node id\nand it is autogenerated after selecting a process, but can also be manually defined by typing it into the text field. Note\nthat it has to be unique within the job, otherwise the plugin shows an error message.\nOnce added, the id can not be modified.')]),e._v(" "),t("li",[t("strong",[e._v("Process Table")]),e._v(" - In this table you see all arguments of the currently selected process, the expected type and\nthe current value. If the name of the argument is bold, it is a required argument, hence it must be set.\nYou can edit the values of the arguments directly in the text field of the value column. For some arguments the plugin\nprovides helper function in the fourth column of the process table (e.g. drop down menu of all available collections in\nthe first row)")]),e._v(" "),t("li",[t("strong",[e._v("Process Argument Helper")]),e._v(" - For some arguments of a process, the QGIS Plugin provides helper functions to make the\nadaption of the arguments easier. This is the case, if the field of the fourth column in the process table is\nnot empty.")]),e._v(" "),t("li",[t("strong",[e._v("Result Process")]),e._v(' - This checkbox needs to be checked on the last process of the process graph. It tells the\nbackend that the result of the checked process is the output of the job (usually a "save_result" process). Note that\nonly one process of the process graph can be a result node. If you create a sub process graph in the process graph\n(e.g. when using apply or reduce), it also needs to have exactly one resulting process.')]),e._v(" "),t("li",[t("strong",[e._v("Clone Process")]),e._v(' - When clicking on this button, a clone of the currently selected node gets created and loaded\ninto the process table on the right. Note that clicking on this button does not add it to the job already, so you need to\npress on the "Add Process" button to do so.')]),e._v(" "),t("li",[t("strong",[e._v("Save Process")]),e._v(" - Changes on the process arguments are not stored in the process graph until this button is pressed.\nYou can see if there are unsaved changes if this button is enabled, otherwise it is disabled (see screenshot).")]),e._v(" "),t("li",[t("strong",[e._v("Manage Job")]),e._v(' - In this section of the adaption dialog, there are three options to handle changes on the job.\nFirst, by pressing on "Adapt Job" the selected job will be adapted to the changes you did and no new job will be created.\nSecond, by pressing on "Create New Job" a new job will be created at the backend, so if you have selected a job before\nfor the adaption, it will stay unchanged and your changes will just be applied to the newly created job.\nThird, the "Cancel" button closes the job adaption dialog with your changes having no effect. The same behaviour applies\nby closing the dialog.')])]),e._v(" "),t("h4",{attrs:{id:"process-argument-helper"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#process-argument-helper"}},[e._v("#")]),e._v(" Process Argument Helper")]),e._v(" "),t("p",[e._v("For some process arguments the QGIS plugin provides helper functions for a more convenient editing.\nThis section provides a list of the available helper functions and how to use them:")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("Collection Id")]),e._v(' - Whenever an argument expects a collection id (e.g. "load_collection" process), the plugin shows a\ndrop down menu with all available collections of the backend. There you can select one and it will be put into the\narguments value.')]),e._v(" "),t("li",[t("strong",[e._v("Spatial Extent")]),e._v(" - Edit buttons of arguments which expect a spatial extent (e.g. geojson, bounding-box) open a\nspatial extent dialog:")])]),e._v(" "),t("p",[t("img",{attrs:{src:o(330),alt:"QGIS Edit spatial extent"}})]),e._v(" "),t("p",[e._v('On the bottom you can edit the spatial extent manually in the text box. In the drop down menu on the top you can choose\nhow to select the spatial extent. You can get the extent of the current layer, the extent of a shape file, the extent of\nthe current QGIS map canvas, by drawing a rectangle on the QGIS map canvas or by drawing a polygon on the QGIS map\ncanvas. The drawings start after clicking on the "Draw Extent" button, so that your curser becomes a cross to draw on\nthe map. After pressing the "OK" button, the extent string in the text field is set to the process argument and the\nwindow closes.')]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("Temporal Extent")]),e._v(" - If an argument expects a start and end date, the edit button opens a calendar dialog:")])]),e._v(" "),t("p",[t("img",{attrs:{src:o(331),alt:"QGIS Edit temporal extent"}})]),e._v(" "),t("p",[e._v("The left calendar sets the start date and the right calendar the end date.")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("Band selection")]),e._v(" - If an argument expects a selection of bands, the edit button opens the following dialog to choose\nfrom the bands available at the selected collection. Note that it always lists all bands of the collection even if some\nbands are filtered by previous processes and therefore not available in the datacube anymore.")])]),e._v(" "),t("p",[t("img",{attrs:{src:o(332),alt:"QGIS Edit band selection"}})]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("Process Graph Node")]),e._v(' - If an argument expects a raster data cube, a drop down menu will appear on the edit column.\nThere you can choose from existing process graph nodes (e.g. "loadcollection1") It uses the output of the given node\nidentifier as input of the process argument.')]),e._v(" "),t("li",[t("strong",[e._v("Sub Process Graph")]),e._v(" - Some processes need a whole (sub-)process graph as input value (e.g. apply or reduce\nprocesses). When clicking on the edit button, the plugin opens a new adaption window, which looks similar to the job\nadaption window, but shows the sub process graph:")])]),e._v(" "),t("p",[t("img",{attrs:{src:o(333),alt:"QGIS Edit sub process graph"}})]),e._v(" "),t("p",[e._v('In this window you can adapt the sub process graph in the same way as the original process graph. After pressing on\n"Adapt", the changes are written to the original job. Process arguments, which do not have special editing fields,\nhave a "Proc-Param" button. If pressed it will forward the input data of the parent node\n(so the one with the subgraph as attribute) to the selected argument (see screenshot "data" argument). Note that the\nsub process graph also needs to have at least one result node.')]),e._v(" "),t("h2",{attrs:{id:"service-management"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#service-management"}},[e._v("#")]),e._v(" Service Management")]),e._v(" "),t("p",[e._v('The "Services" tab lists all of your '),t("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#data-processing-modes"}},[e._v("secondary web services")]),e._v("\nat the backend. In openEO a secondary service has a process graph like a job, but depending on the service type it is\npossible for the user to change the viewing extent dynamically. The first two columns shows the title, the description\nand the date and time it got created at the backend.\nThe other elements of this window are numbered at the screenshot below and described in the following.")],1),e._v(" "),t("p",[t("img",{attrs:{src:o(334),alt:"QGIS Services"}})]),e._v(" "),t("ol",[t("li",[t("strong",[e._v("Display")]),e._v(' - When clicking on the "Eye", the secondary service gets loaded into a new QGIS layer, named after the\nservice. QGIS now fetches the result of the processing into the current extent of the QGIS map canvas. Note that it will\nload the whole screen at once, so it might take a while.')]),e._v(" "),t("li",[t("strong",[e._v("Information")]),e._v(" - Clicking on the Infobox, shows detailed information about the service.")]),e._v(" "),t("li",[t("strong",[e._v("Delete")]),e._v(" - Clicking on the delete button removes the service from the backend.")]),e._v(" "),t("li",[t("strong",[e._v("Create from job")]),e._v(' - By clicking on this button you can create a new service from one of your jobs. It will create a\nservice with the same process graph as the selected job, but the extent will be dynamically loaded via the service. By\nclicking on the button a new dialog pops up. On the creation dialog you can set a title and a description text, but note\nthat they are optional. Nevertheless, you have to select a job and choose a type of secondary service. The drop down\nmenu of the service types contains only the ones supported by your backend. By clicking on "Create Service" the\nplugin creates the service on the backend, so you should be able to see it on the table. Note that the list of jobs\ncontains only successfully executed jobs (e.g. with "finished" status). By clicking on "Raw Graph"\n'),t("img",{attrs:{src:o(335),alt:"QGIS Create Services from job"}})]),e._v(" "),t("li",[t("strong",[e._v("Create from web editor")]),e._v(" - Similarly to the job table overview, this button opens your web browser with\nthe "),t("a",{attrs:{href:"https://editor.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO web editor"),t("OutboundLink")],1),e._v(". There you can create new services via the editor or from your jobs.")]),e._v(" "),t("li",[t("strong",[e._v("Refresh Table")]),e._v(" - Similar to the jobs table, this button refreshes the list of services manually, in general the list will refresh every few\nseconds. If you do not want to automatically refresh the list (it might cause some lags if the connection to the\nbackend is low) you can do so by deactivating the checkbox next to the refresh button.")]),e._v(" "),t("li",[t("strong",[e._v("Create from web editor")]),e._v(" - This button opens your browser with this introduction page.")])]),e._v(" "),t("h2",{attrs:{id:"additional-information"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#additional-information"}},[e._v("#")]),e._v(" Additional Information")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://github.com/Open-EO/openeo-qgis-plugin",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github Repository"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://plugins.qgis.org/plugins/openeo-qgis-plugin-master/",target:"_blank",rel:"noopener noreferrer"}},[e._v("QGIS Plugin Page"),t("OutboundLink")],1)])])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[15],{325:function(e,t,o){e.exports=o.p+"assets/img/qgis_button.2b5f39a5.png"},326:function(e,t,o){e.exports=o.p+"assets/img/login_dialog.424c4b4e.png"},327:function(e,t,o){e.exports=o.p+"assets/img/backend_info.a00e7a1d.png"},328:function(e,t,o){e.exports=o.p+"assets/img/jobs.fef9e692.png"},329:function(e,t,o){e.exports=o.p+"assets/img/adapt_job.64ea4b55.png"},330:function(e,t,o){e.exports=o.p+"assets/img/edit_spatial.23df03fa.png"},331:function(e,t,o){e.exports=o.p+"assets/img/edit_temporal.609c87e2.png"},332:function(e,t,o){e.exports=o.p+"assets/img/edit_bands.d9ed77a5.png"},333:function(e,t,o){e.exports=o.p+"assets/img/edit_subpg.c7fbfd4d.png"},334:function(e,t,o){e.exports=o.p+"assets/img/services.a958fd61.png"},335:function(e,t,o){e.exports=o.p+"assets/img/services_create.0881f2cd.png"},533:function(e,t,o){"use strict";o.r(t);var n=o(4),a=Object(n.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"qgis-plugin"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#qgis-plugin"}},[e._v("#")]),e._v(" QGIS Plugin")]),e._v(" "),t("p",[e._v("The openEO QGIS plugin enables exploring openEO backends as well as execute and modify your jobs at an backend\nwithin QGIS. The plugin can load the results of a job execution to the QGIS map, so that the user can make further\nanalyses and visualisation steps.")]),e._v(" "),t("h2",{attrs:{id:"installation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[e._v("#")]),e._v(" Installation")]),e._v(" "),t("p",[e._v("There are two different versions of the QGIS Plugin available:")]),e._v(" "),t("ol",[t("li",[e._v("The "),t("strong",[e._v("latest stable version")]),e._v(' is accessible in the plugin\nmanager of QGIS (Plugins -> Manage and Install Plugins). Note that you have to activate the option to show experimental\nplugins (Settings -> Show also experimental plugins). After that, you can search for\n"OpenEO", install and activate the plugin.')]),e._v(" "),t("li",[e._v("The "),t("strong",[e._v("latest version")]),e._v(" is accessible at the\n"),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-qgis-plugin",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub repository"),t("OutboundLink")],1),e._v('. First, download the repository as zip archive.\nNow, open the plugin manager of QGIS (Plugins -> Manage and Install Plugins) and select "Install from ZIP".\nThere you can browse for the downloaded zip archive, install and activate it.')])]),e._v(" "),t("p",[e._v("This tutorial shows the capabilities of version 0.9.2. Make sure you have installed at least that version by checking in\nthe plugin manager.")]),e._v(" "),t("p",[e._v("After successfully installing and activating the plugin, the openEO logo should be part of the toolbar:")]),e._v(" "),t("p",[t("img",{attrs:{src:o(325),alt:"QGIS Plugin Icon"}})]),e._v(" "),t("p",[e._v("Simply click on the icon to start the plugin.")]),e._v(" "),t("h2",{attrs:{id:"connecting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#connecting"}},[e._v("#")]),e._v(" Connecting")]),e._v(" "),t("p",[e._v("The first window you see when starting the plugin is a login dialog, since you can only access your jobs at the backend\nif you are authenticated. The backend dropdown menu contains the available openEO backends from\nthe "),t("a",{attrs:{href:"https://hub.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO Hub"),t("OutboundLink")],1),e._v('. By default, the plugin chooses the latest compatible version from the\nselected provider. If you want to connect to a specific version of a backend, you need to uncheck\nthe checkbox labeled "Only Latest versions". You can also manually type a backend url into the selection\nfield, in case it is not registered at our hub yet.')]),e._v(" "),t("p",[t("img",{attrs:{src:o(326),alt:"QGIS Login Dialog"}})]),e._v(" "),t("p",[e._v("Now that you have chosen a backend, you can log in with your username and password provided by the backend.\nNote that the QGIS plugin only supports Basic authentication and not "),t("a",{attrs:{href:"https://openid.net/connect/",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenID Connect"),t("OutboundLink")],1),e._v(" yet.\nBackends that do not support this authentication can not be accessed via this plugin at the moment.")]),e._v(" "),t("p",[e._v("If logged in successfully, the main window of the plugin appears with three tabs ("),t("strong",[e._v("Backend Info")]),e._v(", "),t("strong",[e._v("Jobs")]),e._v(", "),t("strong",[e._v("Services")]),e._v(").\nThe following sections will go through the capabilities of these tabs.")]),e._v(" "),t("h2",{attrs:{id:"exploring-a-backend"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#exploring-a-backend"}},[e._v("#")]),e._v(" Exploring a backend")]),e._v(" "),t("p",[e._v("The first tab shows information about the backend and the available collections and processes.\nOn the top, there is a basic description about the backend you are connected to.\nNext, you can choose a collection in the drop down menu to see a description of that dataset.")]),e._v(" "),t("p",[t("img",{attrs:{src:o(327),alt:"QGIS Backend Info"}})]),e._v(" "),t("p",[e._v("On the bottom, you can use the drop down menu to choose one of the available processes from the backend.\nAfter selection, the parameters of the process are listed in the table below. The first column contains the\nparameter name, which is required if bold and otherwise optional.\nThe second column shows the type of the parameter (e.g. number) and the third column a short description.\nTo learn more about the process, you can click on the info button next to the drop down menu\n(marked red in the figure above). The return type of the process is written next to the info box. If you want to get an\noverview of all processes of openEO you might visit the "),t("RouterLink",{attrs:{to:"/documentation/1.0/processes.html"}},[e._v("official processes page")]),e._v(", but note that not all backends\nwill implement all processes listed there, whereas only available processes of the backend are in the QGIS plugin.")],1),e._v(" "),t("h2",{attrs:{id:"job-management"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#job-management"}},[e._v("#")]),e._v(" Job Management")]),e._v(" "),t("p",[e._v('The "Jobs" tab lists all of your '),t("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#data-processing-modes"}},[e._v("jobs")]),e._v("\nat the backend. In openEO a job describes what the backend needs to process\n(e.g. by defining a "),t("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#processes"}},[e._v("process graph")]),e._v(") as well as\nadditional meta-information (e.g. title, creation date). The first two columns show the title and the creation date of\nthe job. The other elements of the table are numbered in the screenshot and described in the following.")],1),e._v(" "),t("p",[t("img",{attrs:{src:o(328),alt:"QGIS Jobs"}})]),e._v(" "),t("ol",[t("li",[t("strong",[e._v("Status")]),e._v(' - Shows the current lifecycle state of the job. The first status of a job is "created",\nif it got created at the backend, but not executed yet. After the job gets executed it will be\n"queued" if the backend plans to executes it, but has not started yet. If the execution started but hasn\'t finished yet,\nit has the status of "running". Last but not least it will have either "canceled", if it was stopped during execution,\n"finished" if the execution was successfully or "error", if an error occurred during execution.')]),e._v(" "),t("li",[t("strong",[e._v("Execute")]),e._v(' - By clicking on the "Play" button, the plugin will start the execution of the job at the backend.\nAlready finished jobs are executed again. The icon of the button will change if the job is in the "running" state,\nso that it looks like a "Stop" button, which will cancel the job execution.')]),e._v(" "),t("li",[t("strong",[e._v("Display")]),e._v(' - By clicking on the "Eye" button, the plugin downloads the resulting image(s) of the job from the backend\nand creates a new layer in QGIS named after the title and the creation date of the image. Note that if the result\nis not geo referenced, you might get a dialog from QGIS to choose a coordinate reference system, therefore it is\nrecommended to choose GeoTiff as job output format if available at the backend.')]),e._v(" "),t("li",[t("strong",[e._v("Save")]),e._v(' - By clicking on the "Download" button, you can navigate to the folder where you want to store the\nresulting image(s) of the job and the plugin will download it there.')]),e._v(" "),t("li",[t("strong",[e._v("Adapt")]),e._v(' - By clicking on the "Pencil" button a new dialog appears, where you can adapt the job title and\ndescription as well as the processes and extent of the job. How this works in detail is described in the following sections.')]),e._v(" "),t("li",[t("strong",[e._v("Information")]),e._v(' - By clicking on the "Info" button a window with additional information about the job appears.\nIt contains information like a description, a cost plan etc., of course only if this information is provided by the\nbackend. If the backend provides a logging output, it is also part of this info window.')]),e._v(" "),t("li",[t("strong",[e._v("Delete")]),e._v(' - By clicking on the "Trash" button the job gets deleted from the backend, after being asked if you are\nreally sure about it.')]),e._v(" "),t("li",[t("strong",[e._v("Load Job from openEO Hub")]),e._v(" - At the moment it is recommended to not use this feature, since the exchange of\nprocess graphs in the OpenEO Hub is under development.")]),e._v(" "),t("li",[t("strong",[e._v("Create new Job in Web Editor")]),e._v(" - This button opens the "),t("a",{attrs:{href:"https://editor.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO web editor"),t("OutboundLink")],1),e._v(" in your\nsystem browser, so that you can create a new job using it. This is the recommended way for creating a new job, since it has\na graphical and therefore more convenient way of doing so.")]),e._v(" "),t("li",[t("strong",[e._v("Create new Job")]),e._v(" - You can create a job from scratch using this button.\nMore information in the next sections.")]),e._v(" "),t("li",[t("strong",[e._v("Refresh Table")]),e._v(" - This button refreshes the list of jobs manually, in general the list will refresh every few\nseconds. If you do not want to automatically refresh the list (it might cause some lags if the connection to the\nbackend is low) you can do so by deactivating the checkbox next to the refresh button.")]),e._v(" "),t("li",[t("strong",[e._v("User Manual")]),e._v(" - This button opens your browser with this introduction page.")])]),e._v(" "),t("h3",{attrs:{id:"creating-new-jobs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-new-jobs"}},[e._v("#")]),e._v(" Creating new Jobs")]),e._v(" "),t("p",[e._v("There are three approaches to create a new job using this plugin, depending on whether you want to start from scratch or just\nchange existing jobs:")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("From scratch with web editor")]),e._v(" - As described in the job table overview above, there is a button (no. 9) that opens\nyour web browser with the "),t("a",{attrs:{href:"https://editor.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO web editor"),t("OutboundLink")],1),e._v(". It is the recommended way to create a new job\nfrom scratch, since it has a very convenient graphical user interface. It also shows the process graph in a neat graph\nbased manner for a better understanding of how processes are connected.")]),e._v(" "),t("li",[t("strong",[e._v("From scratch with QGIS")]),e._v(' - If you want to use the QGIS plugin, you can create a new job using the\nbutton (no. 10) of the job overview dialog. It opens the job adaption window (more details in the section below).\nIn the beginning the job has already a "load_collection" process as a starting point.')]),e._v(" "),t("li",[t("strong",[e._v("From existing Job")]),e._v(" - You can create a new job by adapting\none of your existing jobs at the backend. You can e.g. create a new job with a different spatial extent, or\nadding a few processes to the original one. To do so, you need to click on the edit button in the job overview window (no. 5)")])]),e._v(" "),t("h3",{attrs:{id:"adapting-existing-jobs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#adapting-existing-jobs"}},[e._v("#")]),e._v(" Adapting existing Jobs")]),e._v(" "),t("p",[e._v("In this section you'll get an overview of the job adaption workflow using the job adaption window.\nHow you get there was described in the previous section.")]),e._v(" "),t("p",[t("img",{attrs:{src:o(329),alt:"QGIS Adapting Job"}})]),e._v(" "),t("ol",[t("li",[t("strong",[e._v("Job Title")]),e._v(" - Here you can write the title of the job. It is recommended to choose it in a way that\nmakes you identify the job in a list more easily.")]),e._v(" "),t("li",[t("strong",[e._v("Job Description")]),e._v(" - You can describe the job in more detail in this field (e.g. what is calculated and how).")]),e._v(" "),t("li",[t("strong",[e._v("Process Graph Table")]),e._v(" - In the process graph table you can see a list of all processes used by the job.\nThe first column contains the identifier of the process node, so a unique identifier of the process throughout the\nwhole process graph (e.g. loadcollection1). Most openEO clients generate these identifiers automatically. We define a\nprocess node (or just node) as one element of the process graph, so a single executed process."),t("br"),e._v('\nIn the second column you can see the name/identifier of the process (e.g. load_collection), which needs to be one of the\nprocesses that the backend provides. The third column shows the node identifier of the predecessor node.\nFor example, "loadcollection1" in the second row means that the output of the node with id "loadcollection1" is the input\nof the node with id "reducedimension1". In other words the process of the second row uses the output of the process of\nthe first row and is therefore executed after the first process.')]),e._v(" "),t("li",[t("strong",[e._v("Process Edit")]),e._v(' - When pressing on the "pencil" button, the process of the same row is loaded into the process\ntable on the right (see no. 6). On this table you can adapt the arguments of the chosen process and therefore configure\nits behaviour.')]),e._v(" "),t("li",[t("strong",[e._v("Delete Process")]),e._v(' - Clicking on the "trash" button deletes the selected process from the process graph.\nNote that other processes, which have this process as predecessor might fail after the deletion.')]),e._v(" "),t("li",[t("strong",[e._v("Undo Changes")]),e._v(" - Press this button if you want to undo all your changes on the job.")]),e._v(" "),t("li",[t("strong",[e._v("Raw Graph")]),e._v(' - Press this button to see the raw process graph (JSON format) in a pop up window. Changes to the\nprocess graph are also applied if you click "Apply". Therefore, you can also copy and paste here a complete process graph'),t("br"),e._v("\ninto the QGIS plugin.")]),e._v(" "),t("li",[t("strong",[e._v("Add Process")]),e._v(' - If you want to add a new process to the process graph you can select one at the drop down menu\n(see "Select a process") and press the button labeled "Add Process". The text field on the right will be the new node id\nand it is autogenerated after selecting a process, but can also be manually defined by typing it into the text field. Note\nthat it has to be unique within the job, otherwise the plugin shows an error message.\nOnce added, the id can not be modified.')]),e._v(" "),t("li",[t("strong",[e._v("Process Table")]),e._v(" - In this table you see all arguments of the currently selected process, the expected type and\nthe current value. If the name of the argument is bold, it is a required argument, hence it must be set.\nYou can edit the values of the arguments directly in the text field of the value column. For some arguments the plugin\nprovides helper function in the fourth column of the process table (e.g. drop down menu of all available collections in\nthe first row)")]),e._v(" "),t("li",[t("strong",[e._v("Process Argument Helper")]),e._v(" - For some arguments of a process, the QGIS Plugin provides helper functions to make the\nadaption of the arguments easier. This is the case, if the field of the fourth column in the process table is\nnot empty.")]),e._v(" "),t("li",[t("strong",[e._v("Result Process")]),e._v(' - This checkbox needs to be checked on the last process of the process graph. It tells the\nbackend that the result of the checked process is the output of the job (usually a "save_result" process). Note that\nonly one process of the process graph can be a result node. If you create a sub process graph in the process graph\n(e.g. when using apply or reduce), it also needs to have exactly one resulting process.')]),e._v(" "),t("li",[t("strong",[e._v("Clone Process")]),e._v(' - When clicking on this button, a clone of the currently selected node gets created and loaded\ninto the process table on the right. Note that clicking on this button does not add it to the job already, so you need to\npress on the "Add Process" button to do so.')]),e._v(" "),t("li",[t("strong",[e._v("Save Process")]),e._v(" - Changes on the process arguments are not stored in the process graph until this button is pressed.\nYou can see if there are unsaved changes if this button is enabled, otherwise it is disabled (see screenshot).")]),e._v(" "),t("li",[t("strong",[e._v("Manage Job")]),e._v(' - In this section of the adaption dialog, there are three options to handle changes on the job.\nFirst, by pressing on "Adapt Job" the selected job will be adapted to the changes you did and no new job will be created.\nSecond, by pressing on "Create New Job" a new job will be created at the backend, so if you have selected a job before\nfor the adaption, it will stay unchanged and your changes will just be applied to the newly created job.\nThird, the "Cancel" button closes the job adaption dialog with your changes having no effect. The same behaviour applies\nby closing the dialog.')])]),e._v(" "),t("h4",{attrs:{id:"process-argument-helper"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#process-argument-helper"}},[e._v("#")]),e._v(" Process Argument Helper")]),e._v(" "),t("p",[e._v("For some process arguments the QGIS plugin provides helper functions for a more convenient editing.\nThis section provides a list of the available helper functions and how to use them:")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("Collection Id")]),e._v(' - Whenever an argument expects a collection id (e.g. "load_collection" process), the plugin shows a\ndrop down menu with all available collections of the backend. There you can select one and it will be put into the\narguments value.')]),e._v(" "),t("li",[t("strong",[e._v("Spatial Extent")]),e._v(" - Edit buttons of arguments which expect a spatial extent (e.g. geojson, bounding-box) open a\nspatial extent dialog:")])]),e._v(" "),t("p",[t("img",{attrs:{src:o(330),alt:"QGIS Edit spatial extent"}})]),e._v(" "),t("p",[e._v('On the bottom you can edit the spatial extent manually in the text box. In the drop down menu on the top you can choose\nhow to select the spatial extent. You can get the extent of the current layer, the extent of a shape file, the extent of\nthe current QGIS map canvas, by drawing a rectangle on the QGIS map canvas or by drawing a polygon on the QGIS map\ncanvas. The drawings start after clicking on the "Draw Extent" button, so that your curser becomes a cross to draw on\nthe map. After pressing the "OK" button, the extent string in the text field is set to the process argument and the\nwindow closes.')]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("Temporal Extent")]),e._v(" - If an argument expects a start and end date, the edit button opens a calendar dialog:")])]),e._v(" "),t("p",[t("img",{attrs:{src:o(331),alt:"QGIS Edit temporal extent"}})]),e._v(" "),t("p",[e._v("The left calendar sets the start date and the right calendar the end date.")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("Band selection")]),e._v(" - If an argument expects a selection of bands, the edit button opens the following dialog to choose\nfrom the bands available at the selected collection. Note that it always lists all bands of the collection even if some\nbands are filtered by previous processes and therefore not available in the datacube anymore.")])]),e._v(" "),t("p",[t("img",{attrs:{src:o(332),alt:"QGIS Edit band selection"}})]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("Process Graph Node")]),e._v(' - If an argument expects a raster data cube, a drop down menu will appear on the edit column.\nThere you can choose from existing process graph nodes (e.g. "loadcollection1") It uses the output of the given node\nidentifier as input of the process argument.')]),e._v(" "),t("li",[t("strong",[e._v("Sub Process Graph")]),e._v(" - Some processes need a whole (sub-)process graph as input value (e.g. apply or reduce\nprocesses). When clicking on the edit button, the plugin opens a new adaption window, which looks similar to the job\nadaption window, but shows the sub process graph:")])]),e._v(" "),t("p",[t("img",{attrs:{src:o(333),alt:"QGIS Edit sub process graph"}})]),e._v(" "),t("p",[e._v('In this window you can adapt the sub process graph in the same way as the original process graph. After pressing on\n"Adapt", the changes are written to the original job. Process arguments, which do not have special editing fields,\nhave a "Proc-Param" button. If pressed it will forward the input data of the parent node\n(so the one with the subgraph as attribute) to the selected argument (see screenshot "data" argument). Note that the\nsub process graph also needs to have at least one result node.')]),e._v(" "),t("h2",{attrs:{id:"service-management"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#service-management"}},[e._v("#")]),e._v(" Service Management")]),e._v(" "),t("p",[e._v('The "Services" tab lists all of your '),t("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#data-processing-modes"}},[e._v("secondary web services")]),e._v("\nat the backend. In openEO a secondary service has a process graph like a job, but depending on the service type it is\npossible for the user to change the viewing extent dynamically. The first two columns shows the title, the description\nand the date and time it got created at the backend.\nThe other elements of this window are numbered at the screenshot below and described in the following.")],1),e._v(" "),t("p",[t("img",{attrs:{src:o(334),alt:"QGIS Services"}})]),e._v(" "),t("ol",[t("li",[t("strong",[e._v("Display")]),e._v(' - When clicking on the "Eye", the secondary service gets loaded into a new QGIS layer, named after the\nservice. QGIS now fetches the result of the processing into the current extent of the QGIS map canvas. Note that it will\nload the whole screen at once, so it might take a while.')]),e._v(" "),t("li",[t("strong",[e._v("Information")]),e._v(" - Clicking on the Infobox, shows detailed information about the service.")]),e._v(" "),t("li",[t("strong",[e._v("Delete")]),e._v(" - Clicking on the delete button removes the service from the backend.")]),e._v(" "),t("li",[t("strong",[e._v("Create from job")]),e._v(' - By clicking on this button you can create a new service from one of your jobs. It will create a\nservice with the same process graph as the selected job, but the extent will be dynamically loaded via the service. By\nclicking on the button a new dialog pops up. On the creation dialog you can set a title and a description text, but note\nthat they are optional. Nevertheless, you have to select a job and choose a type of secondary service. The drop down\nmenu of the service types contains only the ones supported by your backend. By clicking on "Create Service" the\nplugin creates the service on the backend, so you should be able to see it on the table. Note that the list of jobs\ncontains only successfully executed jobs (e.g. with "finished" status). By clicking on "Raw Graph"\n'),t("img",{attrs:{src:o(335),alt:"QGIS Create Services from job"}})]),e._v(" "),t("li",[t("strong",[e._v("Create from web editor")]),e._v(" - Similarly to the job table overview, this button opens your web browser with\nthe "),t("a",{attrs:{href:"https://editor.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO web editor"),t("OutboundLink")],1),e._v(". There you can create new services via the editor or from your jobs.")]),e._v(" "),t("li",[t("strong",[e._v("Refresh Table")]),e._v(" - Similar to the jobs table, this button refreshes the list of services manually, in general the list will refresh every few\nseconds. If you do not want to automatically refresh the list (it might cause some lags if the connection to the\nbackend is low) you can do so by deactivating the checkbox next to the refresh button.")]),e._v(" "),t("li",[t("strong",[e._v("Create from web editor")]),e._v(" - This button opens your browser with this introduction page.")])]),e._v(" "),t("h2",{attrs:{id:"additional-information"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#additional-information"}},[e._v("#")]),e._v(" Additional Information")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://github.com/Open-EO/openeo-qgis-plugin",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github Repository"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://plugins.qgis.org/plugins/openeo-qgis-plugin-master/",target:"_blank",rel:"noopener noreferrer"}},[e._v("QGIS Plugin Page"),t("OutboundLink")],1)])])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/28.fe86027d.js b/assets/js/28.bd2c4f3b.js similarity index 89% rename from assets/js/28.fe86027d.js rename to assets/js/28.bd2c4f3b.js index 5d9dbf4ea..9821535f6 100644 --- a/assets/js/28.fe86027d.js +++ b/assets/js/28.bd2c4f3b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[28],{233:function(s,e,r){},344:function(s,e,r){"use strict";r(233)},483:function(s,e,r){"use strict";r.r(e);var a={name:"InlineFrame",props:["url","version"],data:()=>({frameUrl:null}),beforeMount(){this.frameUrl=this.url.replace("{apiTag}",this.version.apiTag).replace("{processesTag}",this.version.processesTag),window.location.hash&&(this.frameUrl+=window.location.hash)}},t=(r(344),r(4)),n=Object(t.a)(a,(function(){return(0,this._self._c)("iframe",{staticClass:"stretch",attrs:{src:this.frameUrl}})}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[28],{233:function(s,e,r){},344:function(s,e,r){"use strict";r(233)},482:function(s,e,r){"use strict";r.r(e);var a={name:"InlineFrame",props:["url","version"],data:()=>({frameUrl:null}),beforeMount(){this.frameUrl=this.url.replace("{apiTag}",this.version.apiTag).replace("{processesTag}",this.version.processesTag),window.location.hash&&(this.frameUrl+=window.location.hash)}},t=(r(344),r(4)),n=Object(t.a)(a,(function(){return(0,this._self._c)("iframe",{staticClass:"stretch",attrs:{src:this.frameUrl}})}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/40.72056c25.js b/assets/js/40.6bb7c8ad.js similarity index 99% rename from assets/js/40.72056c25.js rename to assets/js/40.6bb7c8ad.js index 7f05fccfd..217d821b5 100644 --- a/assets/js/40.72056c25.js +++ b/assets/js/40.6bb7c8ad.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[40],{213:function(t,e,r){t.exports=function(){"use strict";var t=6e4,e=36e5,r="millisecond",n="second",s="minute",i="hour",a="day",u="week",o="month",c="quarter",f="year",h="date",d="Invalid Date",l=/^(\d{4})[-/]?(\d{1,2})?[-/]?(\d{0,2})[Tt\s]*(\d{1,2})?:?(\d{1,2})?:?(\d{1,2})?[.:]?(\d+)?$/,$=/\[([^\]]+)]|Y{1,4}|M{1,4}|D{1,2}|d{1,4}|H{1,2}|h{1,2}|a|A|m{1,2}|s{1,2}|Z{1,2}|SSS/g,m={name:"en",weekdays:"Sunday_Monday_Tuesday_Wednesday_Thursday_Friday_Saturday".split("_"),months:"January_February_March_April_May_June_July_August_September_October_November_December".split("_"),ordinal:function(t){var e=["th","st","nd","rd"],r=t%100;return"["+t+(e[(r-20)%10]||e[r]||e[0])+"]"}},M=function(t,e,r){var n=String(t);return!n||n.length>=e?t:""+Array(e+1-n.length).join(r)+t},p={s:M,z:function(t){var e=-t.utcOffset(),r=Math.abs(e),n=Math.floor(r/60),s=r%60;return(e<=0?"+":"-")+M(n,2,"0")+":"+M(s,2,"0")},m:function t(e,r){if(e.date()1)return t(a[0])}else{var u=e.name;D[u]=e,s=u}return!n&&s&&(v=s),s||!n&&v},S=function(t,e){if(w(t))return t.clone();var r="object"==typeof e?e:{};return r.date=t,r.args=arguments,new O(r)},_=p;_.l=y,_.i=w,_.w=function(t,e){return S(t,{locale:e.$L,utc:e.$u,x:e.$x,$offset:e.$offset})};var O=function(){function m(t){this.$L=y(t.locale,null,!0),this.parse(t),this.$x=this.$x||t.x||{},this[g]=!0}var M=m.prototype;return M.parse=function(t){this.$d=function(t){var e=t.date,r=t.utc;if(null===e)return new Date(NaN);if(_.u(e))return new Date;if(e instanceof Date)return new Date(e);if("string"==typeof e&&!/Z$/i.test(e)){var n=e.match(l);if(n){var s=n[2]-1||0,i=(n[7]||"0").substring(0,3);return r?new Date(Date.UTC(n[1],s,n[3]||1,n[4]||0,n[5]||0,n[6]||0,i)):new Date(n[1],s,n[3]||1,n[4]||0,n[5]||0,n[6]||0,i)}}return new Date(e)}(t),this.init()},M.init=function(){var t=this.$d;this.$y=t.getFullYear(),this.$M=t.getMonth(),this.$D=t.getDate(),this.$W=t.getDay(),this.$H=t.getHours(),this.$m=t.getMinutes(),this.$s=t.getSeconds(),this.$ms=t.getMilliseconds()},M.$utils=function(){return _},M.isValid=function(){return!(this.$d.toString()===d)},M.isSame=function(t,e){var r=S(t);return this.startOf(e)<=r&&r<=this.endOf(e)},M.isAfter=function(t,e){return S(t)({readMore:!1}),computed:{posts(){this.readMore=!1;let t=this.$site.pages.filter(t=>t.frontmatter.news).sort((t,e)=>new Date(e.frontmatter.date)-new Date(t.frontmatter.date)).map(t=>(t.frontmatter.dateFormatted=s()(t.frontmatter.date).format("MMMM D, YYYY"),t));return this.limit>0&&this.limit=e?t:""+Array(e+1-n.length).join(r)+t},p={s:M,z:function(t){var e=-t.utcOffset(),r=Math.abs(e),n=Math.floor(r/60),s=r%60;return(e<=0?"+":"-")+M(n,2,"0")+":"+M(s,2,"0")},m:function t(e,r){if(e.date()1)return t(a[0])}else{var u=e.name;D[u]=e,s=u}return!n&&s&&(v=s),s||!n&&v},S=function(t,e){if(w(t))return t.clone();var r="object"==typeof e?e:{};return r.date=t,r.args=arguments,new O(r)},_=p;_.l=y,_.i=w,_.w=function(t,e){return S(t,{locale:e.$L,utc:e.$u,x:e.$x,$offset:e.$offset})};var O=function(){function m(t){this.$L=y(t.locale,null,!0),this.parse(t),this.$x=this.$x||t.x||{},this[g]=!0}var M=m.prototype;return M.parse=function(t){this.$d=function(t){var e=t.date,r=t.utc;if(null===e)return new Date(NaN);if(_.u(e))return new Date;if(e instanceof Date)return new Date(e);if("string"==typeof e&&!/Z$/i.test(e)){var n=e.match(l);if(n){var s=n[2]-1||0,i=(n[7]||"0").substring(0,3);return r?new Date(Date.UTC(n[1],s,n[3]||1,n[4]||0,n[5]||0,n[6]||0,i)):new Date(n[1],s,n[3]||1,n[4]||0,n[5]||0,n[6]||0,i)}}return new Date(e)}(t),this.init()},M.init=function(){var t=this.$d;this.$y=t.getFullYear(),this.$M=t.getMonth(),this.$D=t.getDate(),this.$W=t.getDay(),this.$H=t.getHours(),this.$m=t.getMinutes(),this.$s=t.getSeconds(),this.$ms=t.getMilliseconds()},M.$utils=function(){return _},M.isValid=function(){return!(this.$d.toString()===d)},M.isSame=function(t,e){var r=S(t);return this.startOf(e)<=r&&r<=this.endOf(e)},M.isAfter=function(t,e){return S(t)({readMore:!1}),computed:{posts(){this.readMore=!1;let t=this.$site.pages.filter(t=>t.frontmatter.news).sort((t,e)=>new Date(e.frontmatter.date)-new Date(t.frontmatter.date)).map(t=>(t.frontmatter.dateFormatted=s()(t.frontmatter.date).format("MMMM D, YYYY"),t));return this.limit>0&&this.limit= 10.x).\nIt can also been used for mobile app development with the "),s("a",{attrs:{href:"https://ionicframework.com/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Ionic Framework"),s("OutboundLink")],1),t._v(", for example.")]),t._v(" "),s("p",[t._v("The easiest way to try out the client is using one of the "),s("a",{attrs:{href:"https://github.com/Open-EO/openeo-js-client/tree/v2.0.0/examples",target:"_blank",rel:"noopener noreferrer"}},[t._v("examples"),s("OutboundLink")],1),t._v(".\nAlternatively, you can create an HTML file and include the client with the following HTML "),s("code",[t._v("script")]),t._v(" tags:")]),t._v(" "),s("div",{staticClass:"language-html extra-class"},[s("pre",{pre:!0,attrs:{class:"language-html"}},[s("code",[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("src")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("https://cdn.jsdelivr.net/npm/axios@0.21/dist/axios.min.js"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}}),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("src")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("https://cdn.jsdelivr.net/npm/@openeo/js-client@2/openeo.min.js"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}}),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),s("p",[t._v("This gives you a minified version for production environments. If you'd like a better development experience, use the following code:")]),t._v(" "),s("div",{staticClass:"language-html extra-class"},[s("pre",{pre:!0,attrs:{class:"language-html"}},[s("code",[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("src")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("https://cdn.jsdelivr.net/npm/axios@0.21/dist/axios.js"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}}),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("src")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("https://cdn.jsdelivr.net/npm/@openeo/js-client@2/openeo.js"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}}),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),s("p",[t._v("If you are working on a Node.js application or you are using a Node.js-based build tool for web development (e.g. Webpack), you can install the client via "),s("a",{attrs:{href:"https://npmjs.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("npm"),s("OutboundLink")],1),t._v(" by using the following command:")]),t._v(" "),s("div",{staticClass:"language-shell script extra-class"},[s("pre",{pre:!0,attrs:{class:"language-shell"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("npm")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("install")]),t._v(" @openeo/js-client\n")])])]),s("p",[t._v("Afterwards you can load the library. Depending on whether you are directly working in Node.js or are just using a Node.js build tool, the import can be different. Please inform yourself which import is suited for your project.")]),t._v(" "),s("p",[t._v("This is usually used directly in Node.js:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" OpenEO "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@openeo/js-client'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("This may be used in build tools such as Webpack:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" OpenEO "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@openeo/js-client'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Now that the installation was successfully finished, we can now connect to openEO compliant back-ends.\nIn the following chapters we quickly walk through the main features of the JavaScript client.")]),t._v(" "),s("p",[t._v("If you have trouble installing the client, feel free to "),s("RouterLink",{attrs:{to:"/contact.html"}},[t._v("contact us")]),t._v(" or leave an issue at the "),s("a",{attrs:{href:"https://github.com/Open-EO/openeo-js-client/issues",target:"_blank",rel:"noopener noreferrer"}},[t._v("GitHub project"),s("OutboundLink")],1),t._v(".")],1),t._v(" "),s("h2",{attrs:{id:"exploring-a-back-end"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#exploring-a-back-end"}},[t._v("#")]),t._v(" Exploring a back-end")]),t._v(" "),s("p",[t._v("If you do not know an openEO back-end that you want to connect to yet, you can have a look at the "),s("a",{attrs:{href:"https://hub.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("openEO Hub"),s("OutboundLink")],1),t._v(", to find all known back-ends with information on their capabilities.")]),t._v(" "),s("p",[t._v("For this tutorial we will use the openEO instance of Google Earth Engine, which is available at "),s("code",[t._v("https://earthengine.openeo.org")]),t._v(".\nNote that the code snippets in this guide works the same way for the other back-ends listed in the openEO Hub. Just the collection identifier and band names might differ.")]),t._v(" "),s("p",[t._v("First we need to establish a connection to the back-end.")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" con "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" OpenEO"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("connect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://earthengine.openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),s("p",[t._v("The JavaScript client uses "),s("a",{attrs:{href:"https://medium.com/jspoint/javascript-promises-and-async-await-as-fast-as-possible-d7c8c8ff0abc",target:"_blank",rel:"noopener noreferrer"}},[t._v("Promises (async/await)"),s("OutboundLink")],1),t._v(". So there are two ways to express the code above:")]),t._v(" "),s("p",[t._v("Promises:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("OpenEO"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("connect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://earthengine.openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("con")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Success")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("catch")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("error")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Error")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("async/await:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("try")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" con "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" OpenEO"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("connect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://earthengine.openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Success")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("error"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Error")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[t._v("To simplify the code here, we use async/await in all examples and don't catch errors. So we assume you run the code in an async function and also in a try/catch block.")])]),t._v(" "),s("p",[t._v("After establishing the connection to the back-end, it can be explored using the "),s("a",{attrs:{href:"https://open-eo.github.io/openeo-js-client/latest/Connection.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("Connection object"),s("OutboundLink")],1),t._v(" returned. The basic service's metadata (capabilities) can be accessed via")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" info "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("capabilities")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("This allows to request a couple of "),s("a",{attrs:{href:"https://open-eo.github.io/openeo-js-client/latest/Capabilities.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("different information"),s("OutboundLink")],1),t._v(", like API version, description, related links or the billing plans. You can print some of these information to the console as follows:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"API Version: "')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" info"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("apiVersion")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Description: "')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" info"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("description")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Billing plans:"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\ninfo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("listPlans")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("plan")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("plan"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("name"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(": ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("plan"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("url"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Related links:"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\ninfo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("links")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("link")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("link"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("title"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(": ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("link"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("href"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"collections"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#collections"}},[t._v("#")]),t._v(" Collections")]),t._v(" "),s("p",[t._v("Collections represent the basic data the back-end provides (e.g. Sentinel 2 collection).\nCollections are used as input data for job executions ("),s("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#eo-data-collections"}},[t._v("more info on collections")]),t._v(").\nWith the following code snippet you can print all 400+ available collection names and their summary.")],1),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Available Collections:"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" response "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("listCollections")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nresponse"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("collections"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("collection")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("collection"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("id"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(": ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("collection"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("summary"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("To get detailed information about a single collection, you can pass any of the collection IDs requested earlier to "),s("code",[t._v("describeCollection")]),t._v(" and get a full object of "),s("a",{attrs:{href:"https://github.com/radiantearth/stac-spec/tree/v1.0.0/collection-spec/collection-spec.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("STAC compliant Collection metadata"),s("OutboundLink")],1),t._v(" back.\nIn this example we request information about the Sentinel-2 Level 1C data from Google:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("describeCollection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"COPERNICUS/S2"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("The collections descriptions returned by "),s("code",[t._v("listCollections")]),t._v(" are usually not complete. To get the full set of metadata you should always use "),s("code",[t._v("describeCollection")]),t._v(".")]),t._v(" "),s("h3",{attrs:{id:"processes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#processes"}},[t._v("#")]),t._v(" Processes")]),t._v(" "),s("p",[t._v("Processes in openEO are small tasks that can be applied on (EO) data.\nThe input of a process might be the output of another process, so that several connected processes form a new (user-defined) process itself.\nTherefore, a process resembles the smallest unit of task descriptions in openEO ("),s("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#processes"}},[t._v("more details on processes")]),t._v(").\nWith the following code snippet you can print all available process IDs and their summaries.")],1),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Available Collections:"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" response "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("listProcesses")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nresponse"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("processes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("process")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("id"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(": ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("summary"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("In contrast to the collections, the process descriptions returned by "),s("code",[t._v("listProcesses")]),t._v(" are complete.\nThere's no need to call "),s("code",[t._v("describeProcess")]),t._v(" to get the full set of metadata.\n"),s("code",[t._v("describeProcess")]),t._v(" is just a convenience function to get a single process from "),s("code",[t._v("listProcesses")]),t._v(".\nIn this example we request the process specification for the "),s("code",[t._v("apply")]),t._v(" process:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("describeProcess")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"apply"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("For a graphical overview of the openEO processes, there is an "),s("RouterLink",{attrs:{to:"/documentation/1.0/processes.html"}},[t._v("online documentation")]),t._v(" for general process descriptions and the "),s("a",{attrs:{href:"https://hub.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("openEO Hub"),s("OutboundLink")],1),t._v(" for back-end specific process descriptions.")],1),t._v(" "),s("h2",{attrs:{id:"authentication"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#authentication"}},[t._v("#")]),t._v(" Authentication")]),t._v(" "),s("p",[t._v("In the code snippets above, authentication is usually not necessary, since we only fetch general information about the back-end.\nTo run your own jobs at the back-end or to access job results, you need to authenticate at the back-end.")]),t._v(" "),s("p",[t._v("Depending on the back-end, there might be two different approaches to authenticate.\nYou need to inform yourself at your back-end provider of choice, which authentication approach you have to carry out.\nYou can also have a look at the "),s("a",{attrs:{href:"https://hub.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("openEO Hub"),s("OutboundLink")],1),t._v(" to see the available authentication types of the back-ends.")]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("Recommendation")]),t._v(" "),s("p",[t._v("The Google Earth Engine implementation for openEO only supports Basic authentication, but generally the preferred authentication method is "),s("a",{attrs:{href:"#openid-connect-authentication"}},[t._v("OpenID Connect")]),t._v(" due to better security mechanisms implemented in the OpenID Connect protocol.")])]),t._v(" "),s("h3",{attrs:{id:"basic-authentication"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#basic-authentication"}},[t._v("#")]),t._v(" Basic Authentication")]),t._v(" "),s("p",[t._v("The Basic authentication method is a common way of authenticate HTTP requests given username and password.")]),t._v(" "),s("p",[t._v("The following code snippet shows how to log in via Basic authentication:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("authenticateBasic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"username"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"password"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),s("p",[t._v("You can get username and password here: "),s("a",{attrs:{href:"https://github.com/Open-EO/openeo-earthengine-driver#demo",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/Open-EO/openeo-earthengine-driver#demo"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("After successfully calling the "),s("code",[t._v("authenticateBasic")]),t._v(" method, you are logged into the back-end with your account.\nThis means, that every call that comes after that via the "),s("code",[t._v("con")]),t._v(" variable is executed by your user account.")]),t._v(" "),s("h3",{attrs:{id:"openid-connect-authentication"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#openid-connect-authentication"}},[t._v("#")]),t._v(" OpenID Connect Authentication")]),t._v(" "),s("div",{staticClass:"custom-block warning"},[s("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),s("p",[t._v("For Google Earth Engine, only "),s("a",{attrs:{href:"#basic-authentication"}},[t._v("Basic Authentication")]),t._v(" is supported at the moment.")])]),t._v(" "),s("p",[t._v("The OIDC ("),s("a",{attrs:{href:"https://openid.net/connect/",target:"_blank",rel:"noopener noreferrer"}},[t._v("OpenID Connect"),s("OutboundLink")],1),t._v(") authentication can be used to authenticate via an external service given a client ID.")]),t._v(" "),s("div",{staticClass:"custom-block warning"},[s("p",{staticClass:"custom-block-title"},[t._v("Important")]),t._v(" "),s("p",[t._v("If you have included the library using HTML "),s("code",[t._v("script")]),t._v(" tags, then you need to include the following OIDC client before the openEO client:")]),t._v(" "),s("div",{staticClass:"language-html extra-class"},[s("pre",{pre:!0,attrs:{class:"language-html"}},[s("code",[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("src")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("https://cdn.jsdelivr.net/npm/oidc-client@1/lib/oidc-client.min.js"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}}),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),s("p",[t._v("No further action is required, if you have installed the client via npm.")])]),t._v(" "),s("p",[t._v("As OpenID Connect authentication is a bit more complex and depends on the environment your are using it in, please refer to the "),s("a",{attrs:{href:"https://open-eo.github.io/openeo-js-client/latest/OidcProvider.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("JavaScript client documentation"),s("OutboundLink")],1),t._v(" for more information.")]),t._v(" "),s("h2",{attrs:{id:"creating-a-user-defined-process"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-user-defined-process"}},[t._v("#")]),t._v(" Creating a (user-defined) process")]),t._v(" "),s("p",[t._v("Now that we know how to discover the back-end and how to authenticate, lets continue by creating a new batch job to process some data.\nFirst we need to create a user-defined process and for that a process builder is the easiest method.")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" builder "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildProcess")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("With the builder, a "),s("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#spatial-datacubes"}},[t._v("datacube")]),t._v(" can be initialized by selecting a collection from the back-end with the process "),s("code",[t._v("load_collection")]),t._v(":")],1),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" datacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("load_collection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"COPERNICUS/S1_GRD"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("west")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.06")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("south")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.06")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("east")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.65")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("north")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.35")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-03-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-04-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VH"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v('This results in a datacube containing the "COPERNICUS/S1_GRD" data restricted to the given spatial extent, the given temporal extend and the given bands .')]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),s("p",[t._v("You can also filter the datacube at a later stage by using the following filter methods:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("datacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("filter_bbox")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("west")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.06")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("south")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.06")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("east")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.65")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("north")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.35")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\ndatacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("filter_temporal")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-03-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-04-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\ndatacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("filter_bands")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VH"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Still, it is recommended to always use the filters in "),s("code",[t._v("load_collection")]),t._v(" to avoid loading too much data upfront.")])]),t._v(" "),s("p",[t._v("Having the input data ready, we want to apply a process on the datacube, which returns a datacube with the process applied:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("min")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("min")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\ndatacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("reduce_dimension")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"t"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("The datacube is now reduced by the time dimension named "),s("code",[t._v("t")]),t._v(', by taking the minimum value of the timeseries values.\nNow the datacube has no time dimension left.\nOther so called "reducer" processes exist, e.g. for computing maximum and mean values.')]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),s("p",[t._v("Everything applied to the datacube at this point is neither executed locally on your machine nor executed on the back-end.\nIt just defines the input data and process chain the back-end needs to apply when it sends the datacube to the back-end and executes it there.\nHow this can be done is the topic of the next chapter.")])]),t._v(" "),s("p",[t._v("After applying all processes you want to execute, we need to tell the back-end to export the datacube, for example as GeoTiff:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" result "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("save_result")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"GTiff"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"batch-job-management"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#batch-job-management"}},[t._v("#")]),t._v(" Batch Job Management")]),t._v(" "),s("p",[t._v("After you finished working on your (user-defined) process, we can now send it to the back-end and start the execution.\nIn openEO, an execution of a (user-defined) process (here defined using the process builder) is called a "),s("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#data-processing-modes"}},[t._v("(batch) job")]),t._v(".\nTherefore, we need to create a job at the back-end using our datacube, giving it the title "),s("code",[t._v("Example Title")]),t._v(".")],1),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" job "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createJob")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("result"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Example Title"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("The "),s("code",[t._v("createJob")]),t._v(" method sends all necessary information to the back-end and creates a new job, which gets returned.\nAfter this, the job is just created, but has not started the execution at the back-end yet.\nIt needs to be queued for processing explicitly:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("startJob")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Now the execution of the job can be monitored by requesting the job status and the log files every once in a while (30 seconds in this example):")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" stopFn "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("monitorJob")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" logs")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("status"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n logs"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("log")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("log"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("level"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(": ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("log"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("message"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("30")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("The monitoring stops automatically once the job has finished, was canceled or errored out.\nBut with the return value of the "),s("code",[t._v("monitorJob")]),t._v(" function, you can also stop monitoring the job manually:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stopFn")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("When the job is finished, calling "),s("code",[t._v("listResults")]),t._v(" gets you the URLs to the results.")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" urls "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("listResults")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),s("p",[t._v("This only works if the job execution has finished.\nWe recommend to use "),s("code",[t._v("listResults")]),t._v(" in combination with "),s("code",[t._v("monitorJob")]),t._v(", for example as follows:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" stopFn "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("monitorJob")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" logs")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("status "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"finished"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" urls "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("listResults")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n urls"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("url")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("Download result from: ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("url"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("href"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),s("p",[t._v("There's also the method "),s("code",[t._v("downloadResults")]),t._v(" to download the results directly.\nUnfortunately, you can only download files from a Node.js environment where file access to your local drive is possible.\nIn a Browser environment, it is also an option to download the STAC Item or Collection for the results using the "),s("code",[t._v("getResultsAsStac")]),t._v(" method and point a "),s("a",{attrs:{href:"https://stacindex.org/ecosystem?category=Client",target:"_blank",rel:"noopener noreferrer"}},[t._v("STAC client"),s("OutboundLink")],1),t._v(" to it for downloading.")])]),t._v(" "),s("p",[t._v("Now you know the general workflow of job executions.")]),t._v(" "),s("h2",{attrs:{id:"full-example"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#full-example"}},[t._v("#")]),t._v(" Full Example")]),t._v(" "),s("p",[t._v("In this chapter we will show a full example of an earth observation use case using the JavaScript client in a Node.js environment and the Google Earth Engine back-end.\nInstead of batch job processing, we compute the image synchronously. Synchronous processing means the result is directly returned in the response, which usually works only for smaller amounts of data.")]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("Use Case")]),t._v(" "),s("p",[t._v("We want to produce a monthly RGB composite of Sentinel 1 backscatter data over the area of Vienna, Austria for three\nmonths in 2017. This can be used for classification and crop monitoring.")])]),t._v(" "),s("p",[t._v("In the following code example, we use inline code comments to describe what we are doing.")]),t._v(" "),s("div",{staticClass:"custom-block warning"},[s("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),s("p",[t._v("The username and password in the example above work at the time of writing, but may be invalid at the time you read this. Please "),s("RouterLink",{attrs:{to:"/contact.html"}},[t._v("contact us")]),t._v(" for credentials.")],1)]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Make the client available to the Node.js script")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Also include the Formula library for simple math expressions")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" OpenEO"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" Formula "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@openeo/js-client'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("example")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Connect to the back-end")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" con "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" OpenEO"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("connect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://earthengine.openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Authenticate ourselves via Basic authentication")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("authenticateBasic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"group11"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"test123"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create a process builder")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" builder "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildProcess")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// We are now loading the Sentinel-1 data over the Area of Interest")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" datacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("load_collection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"COPERNICUS/S1_GRD"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("west")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.06")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("south")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.06")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("east")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.65")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("north")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.35")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-03-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-06-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Since we are creating a monthly RGB composite, we need three separated time ranges (March aas R, April as G and May as G).")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Therefore, we split the datacube into three datacubes using a temporal filter.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" march "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("filter_temporal")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-03-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-04-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" april "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("filter_temporal")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-04-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-05-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" may "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("filter_temporal")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-05-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-06-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// We aggregate the timeseries values into a single image by reducing the time dimension using a mean reducer.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("mean")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("mean")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n march "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("reduce_dimension")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("march"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" mean"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"t"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n april "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("reduce_dimension")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("april"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" mean"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"t"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n may "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("reduce_dimension")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("may"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" mean"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"t"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Now the three images will be combined into the temporal composite.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// We rename the bands to R, G and B as otherwise the bands are overlapping and the merge process would fail.")]),t._v("\n march "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("rename_labels")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("march"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bands"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"R"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n april "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("rename_labels")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("april"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bands"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"G"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n may "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("rename_labels")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("may"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bands"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n datacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("merge_cubes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("march"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" april"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n datacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("merge_cubes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" may"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// To make the values match the RGB values from 0 to 255 in a PNG file, we need to scale them.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// We can simplify expressing math formulas using the openEO Formula parser.")]),t._v("\n datacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("builder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("apply")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Formula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"linear_scale_range(x, -20, -5, 0, 255)"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Finally, save the result as PNG file.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v('// In the options we specify which band should be used for "red", "green" and "blue" color.')]),t._v("\n datacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("save_result")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"PNG"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("red")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"R"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("green")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"G"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("blue")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Now send the processing instructions to the back-end for (synchronous) execution and save the file as result.png")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("downloadResult")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"result.png"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Run the example, write errors to the console.")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("example")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("catch")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("error")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("error")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("error"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Now the resulting PNG file of the RGB backscatter composite is stored as "),s("code",[t._v("result.png")]),t._v(" in the node.JS working directory and should look as follows:")]),t._v(" "),s("p",[s("img",{attrs:{src:a(193),alt:"RGB composite"}})]),t._v(" "),s("h2",{attrs:{id:"user-defined-functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#user-defined-functions"}},[t._v("#")]),t._v(" User Defined Functions")]),t._v(" "),s("p",[t._v("If your use case can not be accomplished with the "),s("RouterLink",{attrs:{to:"/documentation/1.0/processes.html"}},[t._v("default processes")]),t._v(" of openEO, you can define a "),s("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#user-defined-function-udf"}},[t._v("user defined function")]),t._v(".\nUnfortunately, you can only create Python and R functions at the moment.\nTherefore, this guide doesn't get into detail.\nFor more information check out the Python or R tutorials on UDFs.")],1),t._v(" "),s("h2",{attrs:{id:"additional-information"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#additional-information"}},[t._v("#")]),t._v(" Additional Information")]),t._v(" "),s("ul",[s("li",[s("a",{attrs:{href:"https://github.com/Open-EO/openeo-js-client/tree/master/examples",target:"_blank",rel:"noopener noreferrer"}},[t._v("Examples"),s("OutboundLink")],1)]),t._v(" "),s("li",[s("a",{attrs:{href:"https://open-eo.github.io/openeo-js-client/latest/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Documentation"),s("OutboundLink")],1)]),t._v(" "),s("li",[s("a",{attrs:{href:"https://github.com/Open-EO/openeo-js-client",target:"_blank",rel:"noopener noreferrer"}},[t._v("Repository"),s("OutboundLink")],1)])])])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[46],{193:function(t,s,a){t.exports=a.p+"assets/img/getting-started-result-example.7820ee84.jpg"},528:function(t,s,a){"use strict";a.r(s);var n=a(4),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"javascript-client"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#javascript-client"}},[t._v("#")]),t._v(" JavaScript Client")]),t._v(" "),s("h2",{attrs:{id:"installation"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[t._v("#")]),t._v(" Installation")]),t._v(" "),s("p",[t._v("The openEO JavaScript Client can be used in all modern browsers (excludes Internet Explorer) and all maintained Node.js versions (>= 10.x).\nIt can also been used for mobile app development with the "),s("a",{attrs:{href:"https://ionicframework.com/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Ionic Framework"),s("OutboundLink")],1),t._v(", for example.")]),t._v(" "),s("p",[t._v("The easiest way to try out the client is using one of the "),s("a",{attrs:{href:"https://github.com/Open-EO/openeo-js-client/tree/v2.0.0/examples",target:"_blank",rel:"noopener noreferrer"}},[t._v("examples"),s("OutboundLink")],1),t._v(".\nAlternatively, you can create an HTML file and include the client with the following HTML "),s("code",[t._v("script")]),t._v(" tags:")]),t._v(" "),s("div",{staticClass:"language-html extra-class"},[s("pre",{pre:!0,attrs:{class:"language-html"}},[s("code",[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("src")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("https://cdn.jsdelivr.net/npm/axios@0.21/dist/axios.min.js"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}}),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("src")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("https://cdn.jsdelivr.net/npm/@openeo/js-client@2/openeo.min.js"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}}),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),s("p",[t._v("This gives you a minified version for production environments. If you'd like a better development experience, use the following code:")]),t._v(" "),s("div",{staticClass:"language-html extra-class"},[s("pre",{pre:!0,attrs:{class:"language-html"}},[s("code",[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("src")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("https://cdn.jsdelivr.net/npm/axios@0.21/dist/axios.js"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}}),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("src")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("https://cdn.jsdelivr.net/npm/@openeo/js-client@2/openeo.js"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}}),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),s("p",[t._v("If you are working on a Node.js application or you are using a Node.js-based build tool for web development (e.g. Webpack), you can install the client via "),s("a",{attrs:{href:"https://npmjs.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("npm"),s("OutboundLink")],1),t._v(" by using the following command:")]),t._v(" "),s("div",{staticClass:"language-shell script extra-class"},[s("pre",{pre:!0,attrs:{class:"language-shell"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("npm")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("install")]),t._v(" @openeo/js-client\n")])])]),s("p",[t._v("Afterwards you can load the library. Depending on whether you are directly working in Node.js or are just using a Node.js build tool, the import can be different. Please inform yourself which import is suited for your project.")]),t._v(" "),s("p",[t._v("This is usually used directly in Node.js:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" OpenEO "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@openeo/js-client'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("This may be used in build tools such as Webpack:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" OpenEO "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@openeo/js-client'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Now that the installation was successfully finished, we can now connect to openEO compliant back-ends.\nIn the following chapters we quickly walk through the main features of the JavaScript client.")]),t._v(" "),s("p",[t._v("If you have trouble installing the client, feel free to "),s("RouterLink",{attrs:{to:"/contact.html"}},[t._v("contact us")]),t._v(" or leave an issue at the "),s("a",{attrs:{href:"https://github.com/Open-EO/openeo-js-client/issues",target:"_blank",rel:"noopener noreferrer"}},[t._v("GitHub project"),s("OutboundLink")],1),t._v(".")],1),t._v(" "),s("h2",{attrs:{id:"exploring-a-back-end"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#exploring-a-back-end"}},[t._v("#")]),t._v(" Exploring a back-end")]),t._v(" "),s("p",[t._v("If you do not know an openEO back-end that you want to connect to yet, you can have a look at the "),s("a",{attrs:{href:"https://hub.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("openEO Hub"),s("OutboundLink")],1),t._v(", to find all known back-ends with information on their capabilities.")]),t._v(" "),s("p",[t._v("For this tutorial we will use the openEO instance of Google Earth Engine, which is available at "),s("code",[t._v("https://earthengine.openeo.org")]),t._v(".\nNote that the code snippets in this guide works the same way for the other back-ends listed in the openEO Hub. Just the collection identifier and band names might differ.")]),t._v(" "),s("p",[t._v("First we need to establish a connection to the back-end.")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" con "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" OpenEO"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("connect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://earthengine.openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),s("p",[t._v("The JavaScript client uses "),s("a",{attrs:{href:"https://medium.com/jspoint/javascript-promises-and-async-await-as-fast-as-possible-d7c8c8ff0abc",target:"_blank",rel:"noopener noreferrer"}},[t._v("Promises (async/await)"),s("OutboundLink")],1),t._v(". So there are two ways to express the code above:")]),t._v(" "),s("p",[t._v("Promises:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("OpenEO"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("connect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://earthengine.openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("con")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Success")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("catch")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("error")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Error")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("async/await:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("try")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" con "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" OpenEO"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("connect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://earthengine.openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Success")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("error"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Error")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[t._v("To simplify the code here, we use async/await in all examples and don't catch errors. So we assume you run the code in an async function and also in a try/catch block.")])]),t._v(" "),s("p",[t._v("After establishing the connection to the back-end, it can be explored using the "),s("a",{attrs:{href:"https://open-eo.github.io/openeo-js-client/latest/Connection.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("Connection object"),s("OutboundLink")],1),t._v(" returned. The basic service's metadata (capabilities) can be accessed via")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" info "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("capabilities")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("This allows to request a couple of "),s("a",{attrs:{href:"https://open-eo.github.io/openeo-js-client/latest/Capabilities.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("different information"),s("OutboundLink")],1),t._v(", like API version, description, related links or the billing plans. You can print some of these information to the console as follows:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"API Version: "')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" info"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("apiVersion")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Description: "')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" info"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("description")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Billing plans:"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\ninfo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("listPlans")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("plan")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("plan"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("name"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(": ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("plan"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("url"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Related links:"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\ninfo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("links")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("link")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("link"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("title"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(": ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("link"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("href"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"collections"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#collections"}},[t._v("#")]),t._v(" Collections")]),t._v(" "),s("p",[t._v("Collections represent the basic data the back-end provides (e.g. Sentinel 2 collection).\nCollections are used as input data for job executions ("),s("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#eo-data-collections"}},[t._v("more info on collections")]),t._v(").\nWith the following code snippet you can print all 400+ available collection names and their summary.")],1),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Available Collections:"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" response "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("listCollections")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nresponse"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("collections"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("collection")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("collection"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("id"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(": ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("collection"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("summary"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("To get detailed information about a single collection, you can pass any of the collection IDs requested earlier to "),s("code",[t._v("describeCollection")]),t._v(" and get a full object of "),s("a",{attrs:{href:"https://github.com/radiantearth/stac-spec/tree/v1.0.0/collection-spec/collection-spec.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("STAC compliant Collection metadata"),s("OutboundLink")],1),t._v(" back.\nIn this example we request information about the Sentinel-2 Level 1C data from Google:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("describeCollection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"COPERNICUS/S2"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("The collections descriptions returned by "),s("code",[t._v("listCollections")]),t._v(" are usually not complete. To get the full set of metadata you should always use "),s("code",[t._v("describeCollection")]),t._v(".")]),t._v(" "),s("h3",{attrs:{id:"processes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#processes"}},[t._v("#")]),t._v(" Processes")]),t._v(" "),s("p",[t._v("Processes in openEO are small tasks that can be applied on (EO) data.\nThe input of a process might be the output of another process, so that several connected processes form a new (user-defined) process itself.\nTherefore, a process resembles the smallest unit of task descriptions in openEO ("),s("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#processes"}},[t._v("more details on processes")]),t._v(").\nWith the following code snippet you can print all available process IDs and their summaries.")],1),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Available Collections:"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" response "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("listProcesses")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nresponse"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("processes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("process")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("id"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(": ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("summary"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("In contrast to the collections, the process descriptions returned by "),s("code",[t._v("listProcesses")]),t._v(" are complete.\nThere's no need to call "),s("code",[t._v("describeProcess")]),t._v(" to get the full set of metadata.\n"),s("code",[t._v("describeProcess")]),t._v(" is just a convenience function to get a single process from "),s("code",[t._v("listProcesses")]),t._v(".\nIn this example we request the process specification for the "),s("code",[t._v("apply")]),t._v(" process:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("describeProcess")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"apply"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("For a graphical overview of the openEO processes, there is an "),s("RouterLink",{attrs:{to:"/documentation/1.0/processes.html"}},[t._v("online documentation")]),t._v(" for general process descriptions and the "),s("a",{attrs:{href:"https://hub.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("openEO Hub"),s("OutboundLink")],1),t._v(" for back-end specific process descriptions.")],1),t._v(" "),s("h2",{attrs:{id:"authentication"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#authentication"}},[t._v("#")]),t._v(" Authentication")]),t._v(" "),s("p",[t._v("In the code snippets above, authentication is usually not necessary, since we only fetch general information about the back-end.\nTo run your own jobs at the back-end or to access job results, you need to authenticate at the back-end.")]),t._v(" "),s("p",[t._v("Depending on the back-end, there might be two different approaches to authenticate.\nYou need to inform yourself at your back-end provider of choice, which authentication approach you have to carry out.\nYou can also have a look at the "),s("a",{attrs:{href:"https://hub.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("openEO Hub"),s("OutboundLink")],1),t._v(" to see the available authentication types of the back-ends.")]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("Recommendation")]),t._v(" "),s("p",[t._v("The Google Earth Engine implementation for openEO only supports Basic authentication, but generally the preferred authentication method is "),s("a",{attrs:{href:"#openid-connect-authentication"}},[t._v("OpenID Connect")]),t._v(" due to better security mechanisms implemented in the OpenID Connect protocol.")])]),t._v(" "),s("h3",{attrs:{id:"basic-authentication"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#basic-authentication"}},[t._v("#")]),t._v(" Basic Authentication")]),t._v(" "),s("p",[t._v("The Basic authentication method is a common way of authenticate HTTP requests given username and password.")]),t._v(" "),s("p",[t._v("The following code snippet shows how to log in via Basic authentication:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("authenticateBasic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"username"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"password"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),s("p",[t._v("You can get username and password here: "),s("a",{attrs:{href:"https://github.com/Open-EO/openeo-earthengine-driver#demo",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/Open-EO/openeo-earthengine-driver#demo"),s("OutboundLink")],1)])]),t._v(" "),s("p",[t._v("After successfully calling the "),s("code",[t._v("authenticateBasic")]),t._v(" method, you are logged into the back-end with your account.\nThis means, that every call that comes after that via the "),s("code",[t._v("con")]),t._v(" variable is executed by your user account.")]),t._v(" "),s("h3",{attrs:{id:"openid-connect-authentication"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#openid-connect-authentication"}},[t._v("#")]),t._v(" OpenID Connect Authentication")]),t._v(" "),s("div",{staticClass:"custom-block warning"},[s("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),s("p",[t._v("For Google Earth Engine, only "),s("a",{attrs:{href:"#basic-authentication"}},[t._v("Basic Authentication")]),t._v(" is supported at the moment.")])]),t._v(" "),s("p",[t._v("The OIDC ("),s("a",{attrs:{href:"https://openid.net/connect/",target:"_blank",rel:"noopener noreferrer"}},[t._v("OpenID Connect"),s("OutboundLink")],1),t._v(") authentication can be used to authenticate via an external service given a client ID.")]),t._v(" "),s("div",{staticClass:"custom-block warning"},[s("p",{staticClass:"custom-block-title"},[t._v("Important")]),t._v(" "),s("p",[t._v("If you have included the library using HTML "),s("code",[t._v("script")]),t._v(" tags, then you need to include the following OIDC client before the openEO client:")]),t._v(" "),s("div",{staticClass:"language-html extra-class"},[s("pre",{pre:!0,attrs:{class:"language-html"}},[s("code",[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("src")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("https://cdn.jsdelivr.net/npm/oidc-client@1/lib/oidc-client.min.js"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}}),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),s("p",[t._v("No further action is required, if you have installed the client via npm.")])]),t._v(" "),s("p",[t._v("As OpenID Connect authentication is a bit more complex and depends on the environment your are using it in, please refer to the "),s("a",{attrs:{href:"https://open-eo.github.io/openeo-js-client/latest/OidcProvider.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("JavaScript client documentation"),s("OutboundLink")],1),t._v(" for more information.")]),t._v(" "),s("h2",{attrs:{id:"creating-a-user-defined-process"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-user-defined-process"}},[t._v("#")]),t._v(" Creating a (user-defined) process")]),t._v(" "),s("p",[t._v("Now that we know how to discover the back-end and how to authenticate, lets continue by creating a new batch job to process some data.\nFirst we need to create a user-defined process and for that a process builder is the easiest method.")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" builder "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildProcess")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("With the builder, a "),s("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#spatial-datacubes"}},[t._v("datacube")]),t._v(" can be initialized by selecting a collection from the back-end with the process "),s("code",[t._v("load_collection")]),t._v(":")],1),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" datacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("load_collection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"COPERNICUS/S1_GRD"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("west")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.06")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("south")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.06")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("east")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.65")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("north")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.35")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-03-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-04-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VH"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v('This results in a datacube containing the "COPERNICUS/S1_GRD" data restricted to the given spatial extent, the given temporal extend and the given bands .')]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),s("p",[t._v("You can also filter the datacube at a later stage by using the following filter methods:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("datacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("filter_bbox")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("west")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.06")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("south")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.06")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("east")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.65")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("north")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.35")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\ndatacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("filter_temporal")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-03-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-04-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\ndatacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("filter_bands")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VH"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Still, it is recommended to always use the filters in "),s("code",[t._v("load_collection")]),t._v(" to avoid loading too much data upfront.")])]),t._v(" "),s("p",[t._v("Having the input data ready, we want to apply a process on the datacube, which returns a datacube with the process applied:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("min")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("min")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\ndatacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("reduce_dimension")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"t"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("The datacube is now reduced by the time dimension named "),s("code",[t._v("t")]),t._v(', by taking the minimum value of the timeseries values.\nNow the datacube has no time dimension left.\nOther so called "reducer" processes exist, e.g. for computing maximum and mean values.')]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),s("p",[t._v("Everything applied to the datacube at this point is neither executed locally on your machine nor executed on the back-end.\nIt just defines the input data and process chain the back-end needs to apply when it sends the datacube to the back-end and executes it there.\nHow this can be done is the topic of the next chapter.")])]),t._v(" "),s("p",[t._v("After applying all processes you want to execute, we need to tell the back-end to export the datacube, for example as GeoTiff:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" result "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("save_result")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"GTiff"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"batch-job-management"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#batch-job-management"}},[t._v("#")]),t._v(" Batch Job Management")]),t._v(" "),s("p",[t._v("After you finished working on your (user-defined) process, we can now send it to the back-end and start the execution.\nIn openEO, an execution of a (user-defined) process (here defined using the process builder) is called a "),s("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#data-processing-modes"}},[t._v("(batch) job")]),t._v(".\nTherefore, we need to create a job at the back-end using our datacube, giving it the title "),s("code",[t._v("Example Title")]),t._v(".")],1),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" job "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createJob")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("result"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Example Title"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("The "),s("code",[t._v("createJob")]),t._v(" method sends all necessary information to the back-end and creates a new job, which gets returned.\nAfter this, the job is just created, but has not started the execution at the back-end yet.\nIt needs to be queued for processing explicitly:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("startJob")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Now the execution of the job can be monitored by requesting the job status and the log files every once in a while (30 seconds in this example):")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" stopFn "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("monitorJob")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" logs")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("status"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n logs"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("log")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("log"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("level"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(": ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("log"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("message"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("30")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("The monitoring stops automatically once the job has finished, was canceled or errored out.\nBut with the return value of the "),s("code",[t._v("monitorJob")]),t._v(" function, you can also stop monitoring the job manually:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stopFn")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("When the job is finished, calling "),s("code",[t._v("listResults")]),t._v(" gets you the URLs to the results.")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" urls "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("listResults")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),s("p",[t._v("This only works if the job execution has finished.\nWe recommend to use "),s("code",[t._v("listResults")]),t._v(" in combination with "),s("code",[t._v("monitorJob")]),t._v(", for example as follows:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" stopFn "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("monitorJob")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" logs")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("status "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"finished"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" urls "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("listResults")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n urls"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("url")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("Download result from: ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("url"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("href"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),s("p",[t._v("There's also the method "),s("code",[t._v("downloadResults")]),t._v(" to download the results directly.\nUnfortunately, you can only download files from a Node.js environment where file access to your local drive is possible.\nIn a Browser environment, it is also an option to download the STAC Item or Collection for the results using the "),s("code",[t._v("getResultsAsStac")]),t._v(" method and point a "),s("a",{attrs:{href:"https://stacindex.org/ecosystem?category=Client",target:"_blank",rel:"noopener noreferrer"}},[t._v("STAC client"),s("OutboundLink")],1),t._v(" to it for downloading.")])]),t._v(" "),s("p",[t._v("Now you know the general workflow of job executions.")]),t._v(" "),s("h2",{attrs:{id:"full-example"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#full-example"}},[t._v("#")]),t._v(" Full Example")]),t._v(" "),s("p",[t._v("In this chapter we will show a full example of an earth observation use case using the JavaScript client in a Node.js environment and the Google Earth Engine back-end.\nInstead of batch job processing, we compute the image synchronously. Synchronous processing means the result is directly returned in the response, which usually works only for smaller amounts of data.")]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("Use Case")]),t._v(" "),s("p",[t._v("We want to produce a monthly RGB composite of Sentinel 1 backscatter data over the area of Vienna, Austria for three\nmonths in 2017. This can be used for classification and crop monitoring.")])]),t._v(" "),s("p",[t._v("In the following code example, we use inline code comments to describe what we are doing.")]),t._v(" "),s("div",{staticClass:"custom-block warning"},[s("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),s("p",[t._v("The username and password in the example above work at the time of writing, but may be invalid at the time you read this. Please "),s("RouterLink",{attrs:{to:"/contact.html"}},[t._v("contact us")]),t._v(" for credentials.")],1)]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Make the client available to the Node.js script")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Also include the Formula library for simple math expressions")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" OpenEO"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" Formula "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@openeo/js-client'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("example")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Connect to the back-end")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" con "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" OpenEO"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("connect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://earthengine.openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Authenticate ourselves via Basic authentication")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("authenticateBasic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"group11"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"test123"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create a process builder")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" builder "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildProcess")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// We are now loading the Sentinel-1 data over the Area of Interest")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" datacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("load_collection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"COPERNICUS/S1_GRD"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("west")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.06")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("south")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.06")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("east")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.65")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("north")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.35")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-03-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-06-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Since we are creating a monthly RGB composite, we need three separated time ranges (March aas R, April as G and May as G).")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Therefore, we split the datacube into three datacubes using a temporal filter.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" march "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("filter_temporal")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-03-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-04-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" april "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("filter_temporal")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-04-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-05-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" may "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("filter_temporal")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-05-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-06-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// We aggregate the timeseries values into a single image by reducing the time dimension using a mean reducer.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("mean")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("mean")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n march "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("reduce_dimension")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("march"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" mean"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"t"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n april "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("reduce_dimension")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("april"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" mean"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"t"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n may "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("reduce_dimension")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("may"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" mean"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"t"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Now the three images will be combined into the temporal composite.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// We rename the bands to R, G and B as otherwise the bands are overlapping and the merge process would fail.")]),t._v("\n march "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("rename_labels")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("march"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bands"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"R"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n april "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("rename_labels")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("april"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bands"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"G"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n may "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("rename_labels")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("may"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bands"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n datacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("merge_cubes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("march"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" april"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n datacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("merge_cubes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" may"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// To make the values match the RGB values from 0 to 255 in a PNG file, we need to scale them.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// We can simplify expressing math formulas using the openEO Formula parser.")]),t._v("\n datacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("builder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("apply")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Formula")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"linear_scale_range(x, -20, -5, 0, 255)"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Finally, save the result as PNG file.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v('// In the options we specify which band should be used for "red", "green" and "blue" color.')]),t._v("\n datacube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("save_result")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"PNG"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("red")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"R"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("green")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"G"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("blue")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Now send the processing instructions to the back-end for (synchronous) execution and save the file as result.png")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("downloadResult")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("datacube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"result.png"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Run the example, write errors to the console.")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("example")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("catch")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("error")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("error")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("error"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Now the resulting PNG file of the RGB backscatter composite is stored as "),s("code",[t._v("result.png")]),t._v(" in the node.JS working directory and should look as follows:")]),t._v(" "),s("p",[s("img",{attrs:{src:a(193),alt:"RGB composite"}})]),t._v(" "),s("h2",{attrs:{id:"user-defined-functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#user-defined-functions"}},[t._v("#")]),t._v(" User Defined Functions")]),t._v(" "),s("p",[t._v("If your use case can not be accomplished with the "),s("RouterLink",{attrs:{to:"/documentation/1.0/processes.html"}},[t._v("default processes")]),t._v(" of openEO, you can define a "),s("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#user-defined-function-udf"}},[t._v("user defined function")]),t._v(".\nUnfortunately, you can only create Python and R functions at the moment.\nTherefore, this guide doesn't get into detail.\nFor more information check out the Python or R tutorials on UDFs.")],1),t._v(" "),s("h2",{attrs:{id:"additional-information"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#additional-information"}},[t._v("#")]),t._v(" Additional Information")]),t._v(" "),s("ul",[s("li",[s("a",{attrs:{href:"https://github.com/Open-EO/openeo-js-client/tree/master/examples",target:"_blank",rel:"noopener noreferrer"}},[t._v("Examples"),s("OutboundLink")],1)]),t._v(" "),s("li",[s("a",{attrs:{href:"https://open-eo.github.io/openeo-js-client/latest/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Documentation"),s("OutboundLink")],1)]),t._v(" "),s("li",[s("a",{attrs:{href:"https://github.com/Open-EO/openeo-js-client",target:"_blank",rel:"noopener noreferrer"}},[t._v("Repository"),s("OutboundLink")],1)])])])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/assets/js/48.ad1a88b6.js b/assets/js/48.44794e44.js similarity index 99% rename from assets/js/48.ad1a88b6.js rename to assets/js/48.44794e44.js index 8fe3fde05..2d8b6054a 100644 --- a/assets/js/48.ad1a88b6.js +++ b/assets/js/48.44794e44.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[48],{193:function(t,e,a){t.exports=a.p+"assets/img/getting-started-result-example.7820ee84.jpg"},533:function(t,e,a){"use strict";a.r(e);var s=a(4),n=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"r-client"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#r-client"}},[t._v("#")]),t._v(" R Client")]),t._v(" "),e("h2",{attrs:{id:"useful-links"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#useful-links"}},[t._v("#")]),t._v(" Useful links")]),t._v(" "),e("ul",[e("li",[e("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/index.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("Documentation"),e("OutboundLink")],1)]),t._v(" "),e("li",[e("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/articles/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Vignettes"),e("OutboundLink")],1)]),t._v(" "),e("li",[e("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client",target:"_blank",rel:"noopener noreferrer"}},[t._v("Code Repository"),e("OutboundLink")],1)]),t._v(" "),e("li",[t._v("for function documentation, use R's "),e("code",[t._v("?")]),t._v(" function or see the "),e("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/index.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("online documentation"),e("OutboundLink")],1)])]),t._v(" "),e("h2",{attrs:{id:"installation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[t._v("#")]),t._v(" Installation")]),t._v(" "),e("p",[t._v("Before you install the R client module into your R environment, please make sure that you have at least R version 3.6. Older versions might also work, but were not tested.")]),t._v(" "),e("p",[t._v("Stable releases can be installed from CRAN:")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("install.packages"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"openeo"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Installing the development version")]),t._v(" "),e("p",[t._v("If you want to install the development version, you can install from GitHub. It may contain more features, but may also be unstable.")]),t._v(" "),e("p",[t._v("You need to have the package 'devtools' installed. If it is not installed use "),e("code",[t._v('install.packages("devtools")')]),t._v(".")]),t._v(" "),e("p",[t._v("Now you can use "),e("code",[t._v("install_github")]),t._v(" from the devtools package to install the development version:")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("devtools"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("::")]),t._v("install_github"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("repo"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Open-EO/openeo-r-client"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" dependencies"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("TRUE")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" ref"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"develop"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("If this gives you an error, something went wrong with the installation so please check the requirements again.")])]),t._v(" "),e("p",[t._v("If you have troubles installing the package, feel free to "),e("RouterLink",{attrs:{to:"/contact.html"}},[t._v("contact us")]),t._v(" or leave an issue at the "),e("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client/issues",target:"_blank",rel:"noopener noreferrer"}},[t._v("GitHub project"),e("OutboundLink")],1),t._v(".")],1),t._v(" "),e("p",[t._v("Now that the installation was successfully finished, we can load the package and connect to openEO compliant back-ends.\nIn the following chapters we quickly walk through the main features of the R client.")]),t._v(" "),e("h2",{attrs:{id:"exploring-a-back-end"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#exploring-a-back-end"}},[t._v("#")]),t._v(" Exploring a back-end")]),t._v(" "),e("p",[t._v("If you do not know an openEO back-end that you want to connect to yet, you can have a look at the "),e("a",{attrs:{href:"https://hub.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("openEO Hub"),e("OutboundLink")],1),t._v(", to find all known back-ends with information on their capabilities.")]),t._v(" "),e("p",[t._v("For this tutorial we will use the openEO instance of Google Earth Engine, which is available at "),e("code",[t._v("https://earthengine.openeo.org")]),t._v(".\nNote that the code snippets in this guide work the same way for the other back-ends listed in the openEO Hub. Just the collection identifier and band names might differ.")]),t._v(" "),e("p",[t._v("First we need to establish a connection to the back-end.")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("library"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("openeo"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ngee "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" connect"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("host "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://earthengine.openeo.org"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("The object stored as variable "),e("code",[t._v("gee")]),t._v(" is a connection and resembles the "),e("code",[t._v("OpenEOClient")]),t._v(" - an object, that bundles all information and functions to interact with the openEO back-end. It can be used explicitly in all of the functions to determine which connection has to be used (usually parameter "),e("code",[t._v("con")]),t._v("). If only one connection is active, then you can omit the parameter, because the last active connection is always stored in a package environment and used if no specific connection was present (see "),e("code",[t._v("?active_connection")]),t._v(" in the package documentation).")]),t._v(" "),e("p",[t._v("The capabilities of the back-end and the collections are generally publicly available, unless the data collections are proprietary and licensing issues prevent the back-end provider from publishing the collection. For the publicly available information you do not need to have an account on the back-end for reading them.")]),t._v(" "),e("h3",{attrs:{id:"collections"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#collections"}},[t._v("#")]),t._v(" Collections")]),t._v(" "),e("p",[t._v("Collections represent the basic data the back-end provides (e.g. Sentinel 1 collection) and are therefore often used as input data for job executions ("),e("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#eo-data-collections"}},[t._v("more info on collections")]),t._v(").\nWith the following code snippet you can get all available collection names and their description. The collection list and its entries have their own implementations of the "),e("code",[t._v("print")]),t._v(" function. The collection list object is coerced into a "),e("code",[t._v("data.frame")]),t._v(" only for printing purposes and the collection for the collection some key information are printed.")],1),t._v(" "),e("p",[t._v("To get the collection list can be indexed by the collections ID to get the more details about the overview information. With the "),e("code",[t._v("describe_collection")]),t._v(" function you can get an even more detailed information about the collection.")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# get the collection list")]),t._v("\ncollections "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list_collections"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# print an overview of the available collections (printed as data.frame or tibble)")]),t._v("\nprint"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("collections"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# to print more of the reduced overview metadata")]),t._v("\nprint"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("collections"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("`COPERNICUS"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v("S2`"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v('# Dictionary of the full metadata of the "COPERNICUS/S2" collection (dict)')]),t._v("\ns2 "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" describe_collection"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"COPERNICUS/S2"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# or use the collection entry from the list, e.g. collections$`COPERNICUS/S2`")]),t._v("\nprint"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("s2"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("In general all metadata objects are based on lists, so you can use "),e("code",[t._v("str()")]),t._v(" to get the structure of the list and address fields by the "),e("code",[t._v("$")]),t._v(" operator.")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("If the package is used with RStudio the metadata can also be nicely rendered as a web page in the viewer panel by running "),e("code",[t._v('collection_viewer(x="COPERNICUS/S2")')]),t._v(".")])]),t._v(" "),e("h3",{attrs:{id:"processes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#processes"}},[t._v("#")]),t._v(" Processes")]),t._v(" "),e("p",[t._v("Processes in openEO are tasks that can be applied to (EO) data.\nThe input of a process might be the output of another process, so that several connected processes form a new (user-defined) process itself.\nTherefore, a process resembles the smallest unit of task descriptions in openEO ("),e("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#processes"}},[t._v("more details on processes")]),t._v(").\nThe following code snippet shows how to get the available processes.")],1),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# List of available openEO processes with full metadata")]),t._v("\nprocesses "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list_processes"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# List of available openEO processes by identifiers (string)")]),t._v("\nprint"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("names"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("processes"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v('# print metadata of the process with ID "load_collection"')]),t._v("\nprint"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("processes"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("load_collection"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("The "),e("code",[t._v("list_processes()")]),t._v(" method returns a list of process metadata objects that the back-end provides.\nEach process list entry is a more complex list object (called 'ProcessInfo') and contains the process identifier and additional metadata about the process, such as expected arguments and return types.")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("As for the collection, processes can also be rendered as a web page in the viewer panel, if RStudio is used. In order to open the viewer use "),e("code",[t._v("process_viewer()")]),t._v(" with either a particular process ("),e("code",[t._v('process_viewer("load_collection")')]),t._v(") or you can pass on all processes ("),e("code",[t._v("process_viewer(processes)")]),t._v("). When all processes are chosen, there is also a search bar and a category tree.")])]),t._v(" "),e("p",[t._v("For other graphical overviews of the openEO processes, there is an "),e("RouterLink",{attrs:{to:"/documentation/1.0/processes.html"}},[t._v("online documentation")]),t._v(" for general process descriptions and the "),e("a",{attrs:{href:"https://hub.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("openEO Hub"),e("OutboundLink")],1),t._v(" for back-end specific process descriptions.")],1),t._v(" "),e("h2",{attrs:{id:"authentication"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#authentication"}},[t._v("#")]),t._v(" Authentication")]),t._v(" "),e("p",[t._v("In the code snippets above, authentication is usually not necessary, since we only fetch general information about the back-end.\nTo run your own jobs at the back-end or to access job results, you need to authenticate at the back-end.")]),t._v(" "),e("p",[t._v("Depending on the back-end, there might be two different approaches to authenticate.\nYou need to inform yourself at your back-end provider of choice, which authentication approach you have to carry out and how to obtain login credentials for yourself and your 'openeo' installation in R.")]),t._v(" "),e("p",[t._v("You can also have a look at the "),e("a",{attrs:{href:"https://hub.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("openEO Hub"),e("OutboundLink")],1),t._v(" to see the available authentication types of the back-ends.\nFor Google Earth Engine, only "),e("a",{attrs:{href:"#basic-authentication"}},[t._v("Basic Authentication")]),t._v(" is supported at the moment.")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Recommendation")]),t._v(" "),e("p",[t._v("The Google Earth Engine implementation for openEO only supports Basic authentication, but generally the preferred authentication method is "),e("a",{attrs:{href:"#openid-connect-authentication"}},[t._v("OpenID Connect")]),t._v(" due to better security mechanisms implemented in the OpenID Connect protocol.")])]),t._v(" "),e("h3",{attrs:{id:"basic-authentication"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#basic-authentication"}},[t._v("#")]),t._v(" Basic Authentication")]),t._v(" "),e("p",[t._v("The Basic authentication method is a common way of authenticate HTTP requests given username and password.")]),t._v(" "),e("p",[t._v("The following code snippet shows how to log in via Basic authentication:")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("login"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("login_type"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"basic"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n user"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"user"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n password"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"password"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("You can get username and password here: "),e("a",{attrs:{href:"https://github.com/Open-EO/openeo-earthengine-driver#demo",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/Open-EO/openeo-earthengine-driver#demo"),e("OutboundLink")],1)])]),t._v(" "),e("p",[t._v("After successfully calling the "),e("code",[t._v("login")]),t._v(' method with the "basic" login type, you are logged into the back-end with your account.\nThis means, that every call that comes after that via the connection variable is executed by your user account.')]),t._v(" "),e("h3",{attrs:{id:"openid-connect-authentication"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#openid-connect-authentication"}},[t._v("#")]),t._v(" OpenID Connect Authentication")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("For Google Earth Engine, only "),e("a",{attrs:{href:"#basic-authentication"}},[t._v("Basic Authentication")]),t._v(" is supported at the moment.")])]),t._v(" "),e("p",[t._v("The OIDC ("),e("a",{attrs:{href:"https://openid.net/connect/",target:"_blank",rel:"noopener noreferrer"}},[t._v("OpenID Connect"),e("OutboundLink")],1),t._v(") authentication can be used to authenticate via an external service.")]),t._v(" "),e("p",[t._v("The following code snippet shows how to log in via OIDC authentication if the back-end supports the simplified authentication method:")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("login"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("The following code snippet shows how to log in via OIDC authentication if the simplified authentication method doesn't work and you need to provide a client ID and secret:")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# get supported OIDC providers which the back-end supports")]),t._v("\noidc_providers "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list_oidc_providers"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\nlogin"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("provider "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" oidc_providers"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("some_provider"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n config "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n client_id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"..."')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n secret "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"..."')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("Calling this method opens your system web browser, with which you can authenticate yourself on the back-end authentication system.\nAfter that the website will give you the instructions to go back to the R client, where your connection has logged your account in.\nThis means, that every call that comes after that via the connection variable is executed by your user account.")]),t._v(" "),e("h2",{attrs:{id:"creating-a-user-defined-process"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-user-defined-process"}},[t._v("#")]),t._v(" Creating a (user-defined) process")]),t._v(" "),e("p",[t._v("Now that we know how to discover the back-end and how to authenticate, lets continue by creating a new batch job to process some data.")]),t._v(" "),e("p",[t._v("First we need to create a process builder object that carries all the available predefined openEO processes of the connected back-end as attached R functions with the parameters stated in the process metadata.")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("p "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" processes"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("The functions of the builder return process nodes, which represent a particular result in the workflow. As one of the first steps we need to select the source data collection.")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("datacube "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("load_collection"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n id "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"COPERNICUS/S1_GRD"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n spatial_extent"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("west "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.06")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" south "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.06")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" east "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.65")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" north "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.35")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n temporal_extent"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-03-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-04-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n bands"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VH"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("This results in a process node that represents a "),e("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#spatial-datacubes"}},[e("code",[t._v("datacube")])]),t._v(' and contains the "COPERNICUS/S1_GRD" data restricted to the given spatial extent, the given temporal extent and the given bands .')],1),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Sample Data Retrieval")]),t._v(" "),e("p",[t._v("In order to get a better understanding about the processing mechanisms and the data structures used in openEO Platform, it helps to check the actual data from time to time.\nThe function "),e("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/reference/get_sample.html",target:"_blank",rel:"noopener noreferrer"}},[e("code",[t._v("get_sample")]),e("OutboundLink")],1),t._v(" aids the user in downloading data for a very small spatial extent. It is automatically loaded into R so that you can directly inspect it with "),e("code",[t._v("stars")]),t._v('.\nRead the vignette on "'),e("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/articles/sample_data.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("Sample Data Retrieval"),e("OutboundLink")],1),t._v('" for more details.')])]),t._v(" "),e("p",[t._v("Having the input data ready, we want to apply a process on the datacube.\nTherefore, we can call the process directly on the datacube object, which then returns a datacube with the process applied.")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("min_reducer "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("context"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" \n return"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("min"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\nreduced "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("reduce_dimension"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" datacube"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" reducer "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" min_reducer"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" dimension"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"t"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("The datacube is now reduced by the time dimension named "),e("code",[t._v("t")]),t._v(', by taking the minimum value of the timeseries values. Now the datacube has no time dimension left. Other so called "reducer" processes exist, e.g. for computing maximum and mean values.')]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),e("p",[t._v("Everything applied to the datacube at this point is neither executed locally on your machine nor executed on the back-end.\nIt just defines the input data and process chain the back-end needs to apply when it sends the datacube to the back-end and executes it there.\nHow this can be done is the topic of the next chapter.")])]),t._v(" "),e("p",[t._v("After applying all processes you want to execute, we need to tell the back-end to export the datacube, for example as GeoTiff:")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("formats "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list_file_formats"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\nresult "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("save_result"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" reduced"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" format "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" formats"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("output"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("`GTIFF"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v("ZIP`"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("The first line retrieves the back-ends offered input and output formats. The second line creates the result node, which stores the data as a zipped GeoTiff.")]),t._v(" "),e("h2",{attrs:{id:"batch-job-management"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#batch-job-management"}},[t._v("#")]),t._v(" Batch Job Management")]),t._v(" "),e("p",[t._v("After you have finished working on your (user-defined) process, we can now send it to the back-end and start the execution.\nIn openEO, an execution of a (user-defined) process is called a "),e("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#data-processing-modes"}},[t._v("(batch) job")]),t._v(".\nTherefore, we need to create a job at the back-end using our datacube, giving it the title "),e("code",[t._v("Example Title")]),t._v(".")],1),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" create_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("graph"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("result"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("title "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Example Title"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("The "),e("code",[t._v("create_job")]),t._v(" method sends all necessary information to the back-end and creates a new job, which gets returned.\nAfter this, the job is just created, but has not started the execution at the back-end yet.\nIt needs to be queued for processing explicitly:")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("start_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("After the job was executed, status updates can be fetched by using the "),e("code",[t._v("list_jobs()")]),t._v(" function. This function returns a list of job descriptions, which can be indexed with the jobs ID to limit the search results. But remember that only "),e("code",[t._v("list_jobs()")]),t._v(" refreshes this list. So, to monitor a job you have to iteratively call the job ("),e("code",[t._v("describe_job()")]),t._v(") or the job list "),e("code",[t._v("list_jobs()")]),t._v(".")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("jobs "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list_jobs"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\njobs "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# printed as a tibble or data.frame, but the object is a list")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# or use the job id (in this example 'cZ2ND0Z5nhBFNQFq') as index to get a particular job overview")]),t._v("\njobs"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("cZ2ND0Z5nhBFNQFq\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# alternatively request detailed information about the job")]),t._v("\ndescribe_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("When the job is finished, calling "),e("code",[t._v("download_results()")]),t._v(" will download the results of a job. Using "),e("code",[t._v("list_results()")]),t._v(" will return an overview about the created files and their download link or it states the error message, in case of an error.")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# list the processed results")]),t._v("\nlist_results"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# download all the files into a folder on the file system")]),t._v("\ndownload_results"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" folder "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"/some/folder/on/filesystem"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),e("p",[t._v("The printing behavior and the actual data structure might differ!")])]),t._v(" "),e("p",[t._v("Now you know the general workflow of job executions.")]),t._v(" "),e("h2",{attrs:{id:"full-example"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#full-example"}},[t._v("#")]),t._v(" Full Example")]),t._v(" "),e("p",[t._v("In this chapter we will show a full example of an earth observation use case using the R client and the Google Earth Engine back-end.\nInstead of batch job processing, we compute the image synchronously. Synchronous processing means the result is directly returned in the response, which usually works only for smaller amounts of data.")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Use Case")]),t._v(" "),e("p",[t._v("We want to produce a monthly RGB composite of Sentinel 1 backscatter data over the area of Vienna, Austria for three\nmonths in 2017. This can be used for classification and crop monitoring.")])]),t._v(" "),e("p",[t._v("In the following code example, we use inline code comments to describe what we are doing.")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("The username and password in the example above work at the time of writing, but may be invalid at the time you read this. Please "),e("RouterLink",{attrs:{to:"/contact.html"}},[t._v("contact us")]),t._v(" for credentials.")],1)]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("library"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("openeo"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nlibrary"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("tibble"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\nuser "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"group7"')]),t._v("\npwd "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"test123"')]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# connect to the back-end and login either via explicit call of login, or use your credentials in the connect function")]),t._v("\ngee "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" connect"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("host "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://earthengine.openeo.org"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("user "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" user"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("password "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" pwd"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("login_type "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"basic"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# get the process collection to use the predefined processes of the back-end")]),t._v("\np "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" processes"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# get the collection list to get easier access to the collection ids, via auto completion")]),t._v("\ncollections "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list_collections"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# get the formats")]),t._v("\nformats "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list_file_formats"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# load the initial data collection and limit the amount of data loaded")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# note: for the collection id and later the format you can also use the its character value")]),t._v("\ndata "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("load_collection"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("id "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" collections"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("`COPERNICUS"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v("S1_GRD`"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n spatial_extent "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("west"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.06")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" \n south"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.06")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n east"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.65")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n north"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.35")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n temporal_extent "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-03-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-06-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n bands "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# create three monthly sub data sets, which will be merged back into a single data cube later")]),t._v("\nmarch "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("filter_temporal"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n extent "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-03-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-04-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\napril "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("filter_temporal"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n extent "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-04-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-05-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\nmay "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("filter_temporal"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n extent "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-05-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-06-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# The aggregation function for the following temporal reducer")]),t._v("\nagg_fun_mean "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" context"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n mean"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\nmarch_reduced "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("reduce_dimension"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" march"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n reducer "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" agg_fun_mean"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n dimension "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"t"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\napril_reduced "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("reduce_dimension"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" april"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n reducer "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" agg_fun_mean"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n dimension "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"t"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\nmay_reduced "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("reduce_dimension"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" may"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n reducer "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" agg_fun_mean"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n dimension "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"t"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Each band is currently called VV. We need to rename at least the label of one dimension, ")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# because otherwise identity of the data cubes is assumed. The bands dimension consists ")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# only of one label, so we can rename this to be able to merge those data cubes.")]),t._v("\nmarch_renamed "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("rename_labels"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" march_reduced"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n dimension "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bands"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n target "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"R"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n source "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\napril_renamed "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("rename_labels"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" april_reduced"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n dimension "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bands"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n target "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"G"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n source "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\nmay_renamed "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("rename_labels"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" may_reduced"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n dimension "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bands"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n target "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n source "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# combine the individual data cubes into one")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# this is done one by one, since the dimensionalities have to match between each of the data cubes")]),t._v("\nmerge_1 "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("merge_cubes"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cube1 "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" march_renamed"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("cube2 "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" april_renamed"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nmerge_2 "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("merge_cubes"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cube1 "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" merge_1"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" cube2 "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" may_renamed"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# rescale the the back scatter measurements into 8Bit integer to view the results as PNG")]),t._v("\nrescaled "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("apply"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" merge_2"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n process "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("context"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("linear_scale_range"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("x"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" inputMin "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("inputMax "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" outputMin "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" outputMax "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("255")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# export shall be format PNG")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# look at the format description")]),t._v("\nformats"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("output"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("PNG\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# store the results using the format and set the create options")]),t._v("\nresult "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("save_result"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" rescaled"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("format "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" formats"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("output"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("PNG"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" options "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("red"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"R"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("green"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"G"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("blue"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# create a job")]),t._v("\njob "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" create_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("graph "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" result"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" title "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"S1 Example R"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" description "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Getting Started example on openeo.org for R-client"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# then start the processing of the job and turn on logging (messages that are captured on the back-end during the process execution)")]),t._v("\nstart_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" log "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("TRUE")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("Now the resulting PNG file of the RGB backscatter composite is stored as a PNG file in the current working directory. It looks like this:")]),t._v(" "),e("p",[e("img",{attrs:{src:a(193),alt:"RGB composite"}})]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("The "),e("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client/blob/master/examples/S1-example.R",target:"_blank",rel:"noopener noreferrer"}},[t._v("source code"),e("OutboundLink")],1),t._v(" of the example can also be found on the R client repository on Github.")])]),t._v(" "),e("h2",{attrs:{id:"user-defined-functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#user-defined-functions"}},[t._v("#")]),t._v(" User Defined Functions")]),t._v(" "),e("p",[t._v("If your use case can not be accomplished with the "),e("RouterLink",{attrs:{to:"/documentation/1.0/processes.html"}},[t._v("default processes")]),t._v(" of openEO, you can define a "),e("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#user-defined-function-udf"}},[t._v("user defined function")]),t._v(".")],1),t._v(" "),e("p",[t._v("In general the processing workflow works by uploading the Python or R script into the users file directory on the back-end and reference the script via its URL or by its relational name (e.g. "),e("code",[t._v("/scripts/script1.R")]),t._v(") in the function "),e("code",[t._v("run_udf")]),t._v(". The latter function is a predefined openEO process that the back-end might provide, if UDFs are supported.")]),t._v(" "),e("p",[t._v("Find out more about UDFs in the respective "),e("a",{attrs:{href:"https://github.com/Open-EO/openeo-udf",target:"_blank",rel:"noopener noreferrer"}},[t._v("Python UDF"),e("OutboundLink")],1),t._v(" and "),e("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-udf",target:"_blank",rel:"noopener noreferrer"}},[t._v("R UDF"),e("OutboundLink")],1),t._v(" repositories with their documentation and examples.")])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[48],{193:function(t,e,a){t.exports=a.p+"assets/img/getting-started-result-example.7820ee84.jpg"},534:function(t,e,a){"use strict";a.r(e);var s=a(4),n=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"r-client"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#r-client"}},[t._v("#")]),t._v(" R Client")]),t._v(" "),e("h2",{attrs:{id:"useful-links"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#useful-links"}},[t._v("#")]),t._v(" Useful links")]),t._v(" "),e("ul",[e("li",[e("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/index.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("Documentation"),e("OutboundLink")],1)]),t._v(" "),e("li",[e("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/articles/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Vignettes"),e("OutboundLink")],1)]),t._v(" "),e("li",[e("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client",target:"_blank",rel:"noopener noreferrer"}},[t._v("Code Repository"),e("OutboundLink")],1)]),t._v(" "),e("li",[t._v("for function documentation, use R's "),e("code",[t._v("?")]),t._v(" function or see the "),e("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/index.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("online documentation"),e("OutboundLink")],1)])]),t._v(" "),e("h2",{attrs:{id:"installation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[t._v("#")]),t._v(" Installation")]),t._v(" "),e("p",[t._v("Before you install the R client module into your R environment, please make sure that you have at least R version 3.6. Older versions might also work, but were not tested.")]),t._v(" "),e("p",[t._v("Stable releases can be installed from CRAN:")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("install.packages"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"openeo"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Installing the development version")]),t._v(" "),e("p",[t._v("If you want to install the development version, you can install from GitHub. It may contain more features, but may also be unstable.")]),t._v(" "),e("p",[t._v("You need to have the package 'devtools' installed. If it is not installed use "),e("code",[t._v('install.packages("devtools")')]),t._v(".")]),t._v(" "),e("p",[t._v("Now you can use "),e("code",[t._v("install_github")]),t._v(" from the devtools package to install the development version:")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("devtools"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("::")]),t._v("install_github"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("repo"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Open-EO/openeo-r-client"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" dependencies"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("TRUE")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" ref"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"develop"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("If this gives you an error, something went wrong with the installation so please check the requirements again.")])]),t._v(" "),e("p",[t._v("If you have troubles installing the package, feel free to "),e("RouterLink",{attrs:{to:"/contact.html"}},[t._v("contact us")]),t._v(" or leave an issue at the "),e("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client/issues",target:"_blank",rel:"noopener noreferrer"}},[t._v("GitHub project"),e("OutboundLink")],1),t._v(".")],1),t._v(" "),e("p",[t._v("Now that the installation was successfully finished, we can load the package and connect to openEO compliant back-ends.\nIn the following chapters we quickly walk through the main features of the R client.")]),t._v(" "),e("h2",{attrs:{id:"exploring-a-back-end"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#exploring-a-back-end"}},[t._v("#")]),t._v(" Exploring a back-end")]),t._v(" "),e("p",[t._v("If you do not know an openEO back-end that you want to connect to yet, you can have a look at the "),e("a",{attrs:{href:"https://hub.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("openEO Hub"),e("OutboundLink")],1),t._v(", to find all known back-ends with information on their capabilities.")]),t._v(" "),e("p",[t._v("For this tutorial we will use the openEO instance of Google Earth Engine, which is available at "),e("code",[t._v("https://earthengine.openeo.org")]),t._v(".\nNote that the code snippets in this guide work the same way for the other back-ends listed in the openEO Hub. Just the collection identifier and band names might differ.")]),t._v(" "),e("p",[t._v("First we need to establish a connection to the back-end.")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("library"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("openeo"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ngee "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" connect"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("host "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://earthengine.openeo.org"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("The object stored as variable "),e("code",[t._v("gee")]),t._v(" is a connection and resembles the "),e("code",[t._v("OpenEOClient")]),t._v(" - an object, that bundles all information and functions to interact with the openEO back-end. It can be used explicitly in all of the functions to determine which connection has to be used (usually parameter "),e("code",[t._v("con")]),t._v("). If only one connection is active, then you can omit the parameter, because the last active connection is always stored in a package environment and used if no specific connection was present (see "),e("code",[t._v("?active_connection")]),t._v(" in the package documentation).")]),t._v(" "),e("p",[t._v("The capabilities of the back-end and the collections are generally publicly available, unless the data collections are proprietary and licensing issues prevent the back-end provider from publishing the collection. For the publicly available information you do not need to have an account on the back-end for reading them.")]),t._v(" "),e("h3",{attrs:{id:"collections"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#collections"}},[t._v("#")]),t._v(" Collections")]),t._v(" "),e("p",[t._v("Collections represent the basic data the back-end provides (e.g. Sentinel 1 collection) and are therefore often used as input data for job executions ("),e("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#eo-data-collections"}},[t._v("more info on collections")]),t._v(").\nWith the following code snippet you can get all available collection names and their description. The collection list and its entries have their own implementations of the "),e("code",[t._v("print")]),t._v(" function. The collection list object is coerced into a "),e("code",[t._v("data.frame")]),t._v(" only for printing purposes and the collection for the collection some key information are printed.")],1),t._v(" "),e("p",[t._v("To get the collection list can be indexed by the collections ID to get the more details about the overview information. With the "),e("code",[t._v("describe_collection")]),t._v(" function you can get an even more detailed information about the collection.")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# get the collection list")]),t._v("\ncollections "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list_collections"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# print an overview of the available collections (printed as data.frame or tibble)")]),t._v("\nprint"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("collections"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# to print more of the reduced overview metadata")]),t._v("\nprint"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("collections"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("`COPERNICUS"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v("S2`"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v('# Dictionary of the full metadata of the "COPERNICUS/S2" collection (dict)')]),t._v("\ns2 "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" describe_collection"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"COPERNICUS/S2"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# or use the collection entry from the list, e.g. collections$`COPERNICUS/S2`")]),t._v("\nprint"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("s2"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("In general all metadata objects are based on lists, so you can use "),e("code",[t._v("str()")]),t._v(" to get the structure of the list and address fields by the "),e("code",[t._v("$")]),t._v(" operator.")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("If the package is used with RStudio the metadata can also be nicely rendered as a web page in the viewer panel by running "),e("code",[t._v('collection_viewer(x="COPERNICUS/S2")')]),t._v(".")])]),t._v(" "),e("h3",{attrs:{id:"processes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#processes"}},[t._v("#")]),t._v(" Processes")]),t._v(" "),e("p",[t._v("Processes in openEO are tasks that can be applied to (EO) data.\nThe input of a process might be the output of another process, so that several connected processes form a new (user-defined) process itself.\nTherefore, a process resembles the smallest unit of task descriptions in openEO ("),e("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#processes"}},[t._v("more details on processes")]),t._v(").\nThe following code snippet shows how to get the available processes.")],1),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# List of available openEO processes with full metadata")]),t._v("\nprocesses "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list_processes"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# List of available openEO processes by identifiers (string)")]),t._v("\nprint"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("names"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("processes"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v('# print metadata of the process with ID "load_collection"')]),t._v("\nprint"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("processes"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("load_collection"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("The "),e("code",[t._v("list_processes()")]),t._v(" method returns a list of process metadata objects that the back-end provides.\nEach process list entry is a more complex list object (called 'ProcessInfo') and contains the process identifier and additional metadata about the process, such as expected arguments and return types.")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("As for the collection, processes can also be rendered as a web page in the viewer panel, if RStudio is used. In order to open the viewer use "),e("code",[t._v("process_viewer()")]),t._v(" with either a particular process ("),e("code",[t._v('process_viewer("load_collection")')]),t._v(") or you can pass on all processes ("),e("code",[t._v("process_viewer(processes)")]),t._v("). When all processes are chosen, there is also a search bar and a category tree.")])]),t._v(" "),e("p",[t._v("For other graphical overviews of the openEO processes, there is an "),e("RouterLink",{attrs:{to:"/documentation/1.0/processes.html"}},[t._v("online documentation")]),t._v(" for general process descriptions and the "),e("a",{attrs:{href:"https://hub.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("openEO Hub"),e("OutboundLink")],1),t._v(" for back-end specific process descriptions.")],1),t._v(" "),e("h2",{attrs:{id:"authentication"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#authentication"}},[t._v("#")]),t._v(" Authentication")]),t._v(" "),e("p",[t._v("In the code snippets above, authentication is usually not necessary, since we only fetch general information about the back-end.\nTo run your own jobs at the back-end or to access job results, you need to authenticate at the back-end.")]),t._v(" "),e("p",[t._v("Depending on the back-end, there might be two different approaches to authenticate.\nYou need to inform yourself at your back-end provider of choice, which authentication approach you have to carry out and how to obtain login credentials for yourself and your 'openeo' installation in R.")]),t._v(" "),e("p",[t._v("You can also have a look at the "),e("a",{attrs:{href:"https://hub.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("openEO Hub"),e("OutboundLink")],1),t._v(" to see the available authentication types of the back-ends.\nFor Google Earth Engine, only "),e("a",{attrs:{href:"#basic-authentication"}},[t._v("Basic Authentication")]),t._v(" is supported at the moment.")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Recommendation")]),t._v(" "),e("p",[t._v("The Google Earth Engine implementation for openEO only supports Basic authentication, but generally the preferred authentication method is "),e("a",{attrs:{href:"#openid-connect-authentication"}},[t._v("OpenID Connect")]),t._v(" due to better security mechanisms implemented in the OpenID Connect protocol.")])]),t._v(" "),e("h3",{attrs:{id:"basic-authentication"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#basic-authentication"}},[t._v("#")]),t._v(" Basic Authentication")]),t._v(" "),e("p",[t._v("The Basic authentication method is a common way of authenticate HTTP requests given username and password.")]),t._v(" "),e("p",[t._v("The following code snippet shows how to log in via Basic authentication:")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("login"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("login_type"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"basic"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n user"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"user"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n password"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"password"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("You can get username and password here: "),e("a",{attrs:{href:"https://github.com/Open-EO/openeo-earthengine-driver#demo",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/Open-EO/openeo-earthengine-driver#demo"),e("OutboundLink")],1)])]),t._v(" "),e("p",[t._v("After successfully calling the "),e("code",[t._v("login")]),t._v(' method with the "basic" login type, you are logged into the back-end with your account.\nThis means, that every call that comes after that via the connection variable is executed by your user account.')]),t._v(" "),e("h3",{attrs:{id:"openid-connect-authentication"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#openid-connect-authentication"}},[t._v("#")]),t._v(" OpenID Connect Authentication")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("For Google Earth Engine, only "),e("a",{attrs:{href:"#basic-authentication"}},[t._v("Basic Authentication")]),t._v(" is supported at the moment.")])]),t._v(" "),e("p",[t._v("The OIDC ("),e("a",{attrs:{href:"https://openid.net/connect/",target:"_blank",rel:"noopener noreferrer"}},[t._v("OpenID Connect"),e("OutboundLink")],1),t._v(") authentication can be used to authenticate via an external service.")]),t._v(" "),e("p",[t._v("The following code snippet shows how to log in via OIDC authentication if the back-end supports the simplified authentication method:")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("login"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("The following code snippet shows how to log in via OIDC authentication if the simplified authentication method doesn't work and you need to provide a client ID and secret:")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# get supported OIDC providers which the back-end supports")]),t._v("\noidc_providers "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list_oidc_providers"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\nlogin"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("provider "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" oidc_providers"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("some_provider"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n config "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n client_id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"..."')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n secret "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"..."')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("Calling this method opens your system web browser, with which you can authenticate yourself on the back-end authentication system.\nAfter that the website will give you the instructions to go back to the R client, where your connection has logged your account in.\nThis means, that every call that comes after that via the connection variable is executed by your user account.")]),t._v(" "),e("h2",{attrs:{id:"creating-a-user-defined-process"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-user-defined-process"}},[t._v("#")]),t._v(" Creating a (user-defined) process")]),t._v(" "),e("p",[t._v("Now that we know how to discover the back-end and how to authenticate, lets continue by creating a new batch job to process some data.")]),t._v(" "),e("p",[t._v("First we need to create a process builder object that carries all the available predefined openEO processes of the connected back-end as attached R functions with the parameters stated in the process metadata.")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("p "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" processes"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("The functions of the builder return process nodes, which represent a particular result in the workflow. As one of the first steps we need to select the source data collection.")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("datacube "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("load_collection"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n id "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"COPERNICUS/S1_GRD"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n spatial_extent"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("west "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.06")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" south "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.06")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" east "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.65")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" north "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.35")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n temporal_extent"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-03-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-04-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n bands"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VH"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("This results in a process node that represents a "),e("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#spatial-datacubes"}},[e("code",[t._v("datacube")])]),t._v(' and contains the "COPERNICUS/S1_GRD" data restricted to the given spatial extent, the given temporal extent and the given bands .')],1),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Sample Data Retrieval")]),t._v(" "),e("p",[t._v("In order to get a better understanding about the processing mechanisms and the data structures used in openEO Platform, it helps to check the actual data from time to time.\nThe function "),e("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/reference/get_sample.html",target:"_blank",rel:"noopener noreferrer"}},[e("code",[t._v("get_sample")]),e("OutboundLink")],1),t._v(" aids the user in downloading data for a very small spatial extent. It is automatically loaded into R so that you can directly inspect it with "),e("code",[t._v("stars")]),t._v('.\nRead the vignette on "'),e("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/articles/sample_data.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("Sample Data Retrieval"),e("OutboundLink")],1),t._v('" for more details.')])]),t._v(" "),e("p",[t._v("Having the input data ready, we want to apply a process on the datacube.\nTherefore, we can call the process directly on the datacube object, which then returns a datacube with the process applied.")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("min_reducer "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("context"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" \n return"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("min"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\nreduced "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("reduce_dimension"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" datacube"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" reducer "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" min_reducer"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" dimension"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"t"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("The datacube is now reduced by the time dimension named "),e("code",[t._v("t")]),t._v(', by taking the minimum value of the timeseries values. Now the datacube has no time dimension left. Other so called "reducer" processes exist, e.g. for computing maximum and mean values.')]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),e("p",[t._v("Everything applied to the datacube at this point is neither executed locally on your machine nor executed on the back-end.\nIt just defines the input data and process chain the back-end needs to apply when it sends the datacube to the back-end and executes it there.\nHow this can be done is the topic of the next chapter.")])]),t._v(" "),e("p",[t._v("After applying all processes you want to execute, we need to tell the back-end to export the datacube, for example as GeoTiff:")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("formats "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list_file_formats"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\nresult "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("save_result"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" reduced"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" format "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" formats"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("output"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("`GTIFF"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v("ZIP`"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("The first line retrieves the back-ends offered input and output formats. The second line creates the result node, which stores the data as a zipped GeoTiff.")]),t._v(" "),e("h2",{attrs:{id:"batch-job-management"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#batch-job-management"}},[t._v("#")]),t._v(" Batch Job Management")]),t._v(" "),e("p",[t._v("After you have finished working on your (user-defined) process, we can now send it to the back-end and start the execution.\nIn openEO, an execution of a (user-defined) process is called a "),e("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#data-processing-modes"}},[t._v("(batch) job")]),t._v(".\nTherefore, we need to create a job at the back-end using our datacube, giving it the title "),e("code",[t._v("Example Title")]),t._v(".")],1),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" create_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("graph"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("result"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("title "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Example Title"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("The "),e("code",[t._v("create_job")]),t._v(" method sends all necessary information to the back-end and creates a new job, which gets returned.\nAfter this, the job is just created, but has not started the execution at the back-end yet.\nIt needs to be queued for processing explicitly:")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("start_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("After the job was executed, status updates can be fetched by using the "),e("code",[t._v("list_jobs()")]),t._v(" function. This function returns a list of job descriptions, which can be indexed with the jobs ID to limit the search results. But remember that only "),e("code",[t._v("list_jobs()")]),t._v(" refreshes this list. So, to monitor a job you have to iteratively call the job ("),e("code",[t._v("describe_job()")]),t._v(") or the job list "),e("code",[t._v("list_jobs()")]),t._v(".")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("jobs "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list_jobs"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\njobs "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# printed as a tibble or data.frame, but the object is a list")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# or use the job id (in this example 'cZ2ND0Z5nhBFNQFq') as index to get a particular job overview")]),t._v("\njobs"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("cZ2ND0Z5nhBFNQFq\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# alternatively request detailed information about the job")]),t._v("\ndescribe_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("When the job is finished, calling "),e("code",[t._v("download_results()")]),t._v(" will download the results of a job. Using "),e("code",[t._v("list_results()")]),t._v(" will return an overview about the created files and their download link or it states the error message, in case of an error.")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# list the processed results")]),t._v("\nlist_results"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# download all the files into a folder on the file system")]),t._v("\ndownload_results"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" folder "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"/some/folder/on/filesystem"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),e("p",[t._v("The printing behavior and the actual data structure might differ!")])]),t._v(" "),e("p",[t._v("Now you know the general workflow of job executions.")]),t._v(" "),e("h2",{attrs:{id:"full-example"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#full-example"}},[t._v("#")]),t._v(" Full Example")]),t._v(" "),e("p",[t._v("In this chapter we will show a full example of an earth observation use case using the R client and the Google Earth Engine back-end.\nInstead of batch job processing, we compute the image synchronously. Synchronous processing means the result is directly returned in the response, which usually works only for smaller amounts of data.")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Use Case")]),t._v(" "),e("p",[t._v("We want to produce a monthly RGB composite of Sentinel 1 backscatter data over the area of Vienna, Austria for three\nmonths in 2017. This can be used for classification and crop monitoring.")])]),t._v(" "),e("p",[t._v("In the following code example, we use inline code comments to describe what we are doing.")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("The username and password in the example above work at the time of writing, but may be invalid at the time you read this. Please "),e("RouterLink",{attrs:{to:"/contact.html"}},[t._v("contact us")]),t._v(" for credentials.")],1)]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("library"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("openeo"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nlibrary"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("tibble"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\nuser "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"group7"')]),t._v("\npwd "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"test123"')]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# connect to the back-end and login either via explicit call of login, or use your credentials in the connect function")]),t._v("\ngee "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" connect"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("host "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://earthengine.openeo.org"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("user "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" user"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("password "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" pwd"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("login_type "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"basic"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# get the process collection to use the predefined processes of the back-end")]),t._v("\np "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" processes"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# get the collection list to get easier access to the collection ids, via auto completion")]),t._v("\ncollections "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list_collections"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# get the formats")]),t._v("\nformats "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list_file_formats"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# load the initial data collection and limit the amount of data loaded")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# note: for the collection id and later the format you can also use the its character value")]),t._v("\ndata "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("load_collection"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("id "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" collections"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("`COPERNICUS"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v("S1_GRD`"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n spatial_extent "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("west"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.06")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" \n south"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.06")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n east"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.65")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n north"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.35")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n temporal_extent "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-03-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-06-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n bands "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# create three monthly sub data sets, which will be merged back into a single data cube later")]),t._v("\nmarch "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("filter_temporal"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n extent "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-03-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-04-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\napril "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("filter_temporal"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n extent "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-04-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-05-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\nmay "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("filter_temporal"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n extent "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-05-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-06-01"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# The aggregation function for the following temporal reducer")]),t._v("\nagg_fun_mean "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" context"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n mean"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\nmarch_reduced "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("reduce_dimension"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" march"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n reducer "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" agg_fun_mean"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n dimension "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"t"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\napril_reduced "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("reduce_dimension"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" april"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n reducer "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" agg_fun_mean"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n dimension "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"t"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\nmay_reduced "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("reduce_dimension"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" may"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n reducer "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" agg_fun_mean"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n dimension "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"t"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Each band is currently called VV. We need to rename at least the label of one dimension, ")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# because otherwise identity of the data cubes is assumed. The bands dimension consists ")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# only of one label, so we can rename this to be able to merge those data cubes.")]),t._v("\nmarch_renamed "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("rename_labels"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" march_reduced"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n dimension "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bands"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n target "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"R"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n source "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\napril_renamed "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("rename_labels"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" april_reduced"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n dimension "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bands"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n target "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"G"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n source "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\nmay_renamed "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("rename_labels"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" may_reduced"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n dimension "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bands"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n target "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n source "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"VV"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# combine the individual data cubes into one")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# this is done one by one, since the dimensionalities have to match between each of the data cubes")]),t._v("\nmerge_1 "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("merge_cubes"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cube1 "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" march_renamed"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("cube2 "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" april_renamed"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nmerge_2 "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("merge_cubes"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cube1 "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" merge_1"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" cube2 "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" may_renamed"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# rescale the the back scatter measurements into 8Bit integer to view the results as PNG")]),t._v("\nrescaled "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("apply"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" merge_2"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n process "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("context"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("linear_scale_range"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("x"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" inputMin "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("inputMax "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" outputMin "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" outputMax "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("255")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# export shall be format PNG")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# look at the format description")]),t._v("\nformats"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("output"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("PNG\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# store the results using the format and set the create options")]),t._v("\nresult "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("save_result"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" rescaled"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("format "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" formats"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("output"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("PNG"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" options "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("red"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"R"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("green"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"G"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("blue"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# create a job")]),t._v("\njob "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" create_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("graph "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" result"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" title "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"S1 Example R"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" description "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Getting Started example on openeo.org for R-client"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# then start the processing of the job and turn on logging (messages that are captured on the back-end during the process execution)")]),t._v("\nstart_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" log "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("TRUE")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("Now the resulting PNG file of the RGB backscatter composite is stored as a PNG file in the current working directory. It looks like this:")]),t._v(" "),e("p",[e("img",{attrs:{src:a(193),alt:"RGB composite"}})]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("The "),e("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client/blob/master/examples/S1-example.R",target:"_blank",rel:"noopener noreferrer"}},[t._v("source code"),e("OutboundLink")],1),t._v(" of the example can also be found on the R client repository on Github.")])]),t._v(" "),e("h2",{attrs:{id:"user-defined-functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#user-defined-functions"}},[t._v("#")]),t._v(" User Defined Functions")]),t._v(" "),e("p",[t._v("If your use case can not be accomplished with the "),e("RouterLink",{attrs:{to:"/documentation/1.0/processes.html"}},[t._v("default processes")]),t._v(" of openEO, you can define a "),e("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html#user-defined-function-udf"}},[t._v("user defined function")]),t._v(".")],1),t._v(" "),e("p",[t._v("In general the processing workflow works by uploading the Python or R script into the users file directory on the back-end and reference the script via its URL or by its relational name (e.g. "),e("code",[t._v("/scripts/script1.R")]),t._v(") in the function "),e("code",[t._v("run_udf")]),t._v(". The latter function is a predefined openEO process that the back-end might provide, if UDFs are supported.")]),t._v(" "),e("p",[t._v("Find out more about UDFs in the respective "),e("a",{attrs:{href:"https://github.com/Open-EO/openeo-udf",target:"_blank",rel:"noopener noreferrer"}},[t._v("Python UDF"),e("OutboundLink")],1),t._v(" and "),e("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-udf",target:"_blank",rel:"noopener noreferrer"}},[t._v("R UDF"),e("OutboundLink")],1),t._v(" repositories with their documentation and examples.")])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/50.d1e2d680.js b/assets/js/50.16b1b0ec.js similarity index 99% rename from assets/js/50.d1e2d680.js rename to assets/js/50.16b1b0ec.js index 6b6a0af22..75fedbc40 100644 --- a/assets/js/50.d1e2d680.js +++ b/assets/js/50.16b1b0ec.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[50],{337:function(t,s,a){t.exports=a.p+"assets/img/040-pg-example.8a5fae89.png"},546:function(t,s,a){"use strict";a.r(s);var n=a(4),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("p",[t._v("Today, the openEO Consortium "),s("strong",[t._v("released the new version 0.4.0 of the "),s("a",{attrs:{href:"https://open-eo.github.io/openeo-api/",target:"_blank",rel:"noopener noreferrer"}},[t._v("openEO API"),s("OutboundLink")],1)]),t._v(". The following blog post will give a short overview over the most notable changes and additions to the API specification.")]),t._v(" "),s("h2",{attrs:{id:"new-process-catalogue-and-process-graph-changes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#new-process-catalogue-and-process-graph-changes"}},[t._v("#")]),t._v(" New process catalogue and process graph changes")]),t._v(" "),s("p",[t._v("The focus of this release was the definition of a "),s("a",{attrs:{href:"http://processes.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[t._v("full process catalogue"),s("OutboundLink")],1),t._v(", which is now in implementation by the back-ends. We defined a set of over 100 processes, which can soon be used for remote sensing and related tasks. For this, we had to introduce a new encoding for the process graphs, which now allows parallelism, callbacks and more.")]),t._v(" "),s("p",[t._v("The following image shows visually how a user could derive minimum EVI measurements over pixel time series of Sentinel 2 imagery:")]),t._v(" "),s("p",[s("img",{attrs:{src:a(337),alt:"Algorithm to process an EVI"}})]),t._v(" "),s("p",[t._v("Once implemented, we plan that the following Python client code could be used to generate the process graph to send it to a back-end:")]),t._v(" "),s("div",{staticClass:"language-python extra-class"},[s("pre",{pre:!0,attrs:{class:"language-python"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" openeo\nsession "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" openeo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("connect"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://example.openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ns2_radio "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" session"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("imagecollection"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" spatial_extent "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"west"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"east"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.6")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"north"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.6")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"south"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("47.2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" temporal_extent "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2018-01-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2018-02-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nblue "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" s2_radio"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("band"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'B02'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nred "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" s2_radio"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("band"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'B04'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nnir "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" s2_radio"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("band"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'B08'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nevi_cube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2.5")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("nir "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" red"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("nir "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("6.0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" red "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("7.5")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" blue"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1.0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nresult "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" evi_cube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token builtin"}},[t._v("reduce")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"temporal"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"min"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("save_result"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"GTiff"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("p",[t._v("In JavaScript it is planned to work as follows:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("eviReducer")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("b"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" data")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" blue "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("at")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" red "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("at")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" nir "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("at")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" b"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("product")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2.5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n b"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("divide")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n b"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("subtract")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("nir"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" red"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n b"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("sum")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" nir"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" b"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("product")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("6")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" red"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" b"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("product")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("7.5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" blue"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" connection "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" OpenEO"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("connect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://example.openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" builder "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" connection"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildProcessGraph")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" result "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("loadCollection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("west")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("east")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.6")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("north")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.6")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("south")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("47.2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2018-01-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2018-02-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("filterBands")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B02"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B04"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B08"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("reduce")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"spectral"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" eviReducer"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("reduce")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"temporal"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("b"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" data")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("min")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("saveResult")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"GTiff"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Similarly, it would work in the R client. You can also check the "),s("a",{attrs:{href:"https://open-eo.github.io/openeo-api/processgraphs/#example",target:"_blank",rel:"noopener noreferrer"}},[t._v("process graph documentation"),s("OutboundLink")],1),t._v(" if you'd like to know how this algorithm looks as a process graph.")]),t._v(" "),s("h2",{attrs:{id:"other-improvements"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#other-improvements"}},[t._v("#")]),t._v(" Other improvements")]),t._v(" "),s("p",[t._v("We also updated our Data Discovery to be compatible with "),s("a",{attrs:{href:"https://medium.com/radiant-earth-insights/stac-extensions-and-0-6-2-release-b0cf34272ed7",target:"_blank",rel:"noopener noreferrer"}},[t._v("the most recent version of STAC, v0.6.2"),s("OutboundLink")],1),t._v(". In the last months, openEO contributed several extensions to the STAC specification such as "),s("a",{attrs:{href:"https://github.com/radiantearth/stac-spec/blob/master/extensions/sar/README.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("an extension to describe Synthetic-Aperture Radar (SAR) data"),s("OutboundLink")],1),t._v(" or "),s("a",{attrs:{href:"https://github.com/radiantearth/stac-spec/blob/master/extensions/datacube/README.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("an extension to describe Data Cubes"),s("OutboundLink")],1),t._v(".")]),t._v(" "),s("p",[t._v("Despite the process and data discovery, we generally improved the discovery of openEO back-ends. For example, the API now also allows clients to automatically detect supported API versions at the back-end, so that users don't need to keep track of that and can always connect to the same URL without worrying about compatibility between clients and back-ends. Our approach to "),s("a",{attrs:{href:"https://github.com/Open-EO/openeo-udf",target:"_blank",rel:"noopener noreferrer"}},[t._v("user-defined functions (UDFs)"),s("OutboundLink")],1),t._v(" was also better integrated withing the API. UDF runtimes can be discovered now and well-defined processes allow executing UDFs. Many more improvements were incorporated into the API specification based on feedback from the review meeting, discussions with users and implementations (see the "),s("a",{attrs:{href:"https://open-eo.github.io/openeo-api/changelog/",target:"_blank",rel:"noopener noreferrer"}},[t._v("full changelog"),s("OutboundLink")],1),t._v(").")]),t._v(" "),s("h2",{attrs:{id:"next-steps"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#next-steps"}},[t._v("#")]),t._v(" Next steps")]),t._v(" "),s("p",[t._v("This is the API version, which is targeted towards getting the first more universally usable version of the openEO clients and back-ends released. We will work hard now to implement the back-ends and clients to comply with the new API version and will follow up with a new blog post once this is achieved. Afterwards, all interested parties can use clients and back-ends to get a first solid impression of the project. In the meantime, it is already possible to make experiments with the back-ends and clients working on the API version 0.3.1. Please "),s("a",{attrs:{href:"http://openeo.org/contact/",target:"_blank",rel:"noopener noreferrer"}},[t._v("contact us"),s("OutboundLink")],1),t._v(" to get more information about it. Having said that, the new version is not the last one and we will continue to improve the API, client and back-ends. So any feedback is highly appreciated and can be sent our way via GitHub issues in the corresponding "),s("a",{attrs:{href:"https://github.com/open-eo",target:"_blank",rel:"noopener noreferrer"}},[t._v("GitHub repositories"),s("OutboundLink")],1),t._v(" or via any of the other "),s("a",{attrs:{href:"http://openeo.org/contact/",target:"_blank",rel:"noopener noreferrer"}},[t._v("contact options"),s("OutboundLink")],1),t._v(".")])])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[50],{337:function(t,s,a){t.exports=a.p+"assets/img/040-pg-example.8a5fae89.png"},548:function(t,s,a){"use strict";a.r(s);var n=a(4),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("p",[t._v("Today, the openEO Consortium "),s("strong",[t._v("released the new version 0.4.0 of the "),s("a",{attrs:{href:"https://open-eo.github.io/openeo-api/",target:"_blank",rel:"noopener noreferrer"}},[t._v("openEO API"),s("OutboundLink")],1)]),t._v(". The following blog post will give a short overview over the most notable changes and additions to the API specification.")]),t._v(" "),s("h2",{attrs:{id:"new-process-catalogue-and-process-graph-changes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#new-process-catalogue-and-process-graph-changes"}},[t._v("#")]),t._v(" New process catalogue and process graph changes")]),t._v(" "),s("p",[t._v("The focus of this release was the definition of a "),s("a",{attrs:{href:"http://processes.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[t._v("full process catalogue"),s("OutboundLink")],1),t._v(", which is now in implementation by the back-ends. We defined a set of over 100 processes, which can soon be used for remote sensing and related tasks. For this, we had to introduce a new encoding for the process graphs, which now allows parallelism, callbacks and more.")]),t._v(" "),s("p",[t._v("The following image shows visually how a user could derive minimum EVI measurements over pixel time series of Sentinel 2 imagery:")]),t._v(" "),s("p",[s("img",{attrs:{src:a(337),alt:"Algorithm to process an EVI"}})]),t._v(" "),s("p",[t._v("Once implemented, we plan that the following Python client code could be used to generate the process graph to send it to a back-end:")]),t._v(" "),s("div",{staticClass:"language-python extra-class"},[s("pre",{pre:!0,attrs:{class:"language-python"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" openeo\nsession "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" openeo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("connect"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://example.openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ns2_radio "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" session"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("imagecollection"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" spatial_extent "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"west"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"east"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.6")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"north"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.6")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"south"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("47.2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" temporal_extent "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2018-01-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2018-02-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nblue "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" s2_radio"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("band"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'B02'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nred "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" s2_radio"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("band"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'B04'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nnir "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" s2_radio"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("band"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'B08'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nevi_cube "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2.5")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("nir "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" red"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("nir "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("6.0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" red "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("7.5")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" blue"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1.0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nresult "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" evi_cube"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token builtin"}},[t._v("reduce")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"temporal"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"min"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("save_result"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"GTiff"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("p",[t._v("In JavaScript it is planned to work as follows:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("eviReducer")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("b"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" data")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" blue "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("at")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" red "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("at")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" nir "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("at")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" b"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("product")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2.5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n b"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("divide")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n b"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("subtract")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("nir"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" red"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n b"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("sum")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" nir"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" b"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("product")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("6")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" red"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" b"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("product")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("7.5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" blue"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" connection "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" OpenEO"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("connect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://example.openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" builder "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" connection"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildProcessGraph")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" result "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" builder"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("loadCollection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("west")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("east")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.6")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("north")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("48.6")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("south")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("47.2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2018-01-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2018-02-01"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("filterBands")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B02"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B04"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B08"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("reduce")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"spectral"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" eviReducer"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("reduce")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"temporal"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("b"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" data")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("min")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("saveResult")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"GTiff"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Similarly, it would work in the R client. You can also check the "),s("a",{attrs:{href:"https://open-eo.github.io/openeo-api/processgraphs/#example",target:"_blank",rel:"noopener noreferrer"}},[t._v("process graph documentation"),s("OutboundLink")],1),t._v(" if you'd like to know how this algorithm looks as a process graph.")]),t._v(" "),s("h2",{attrs:{id:"other-improvements"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#other-improvements"}},[t._v("#")]),t._v(" Other improvements")]),t._v(" "),s("p",[t._v("We also updated our Data Discovery to be compatible with "),s("a",{attrs:{href:"https://medium.com/radiant-earth-insights/stac-extensions-and-0-6-2-release-b0cf34272ed7",target:"_blank",rel:"noopener noreferrer"}},[t._v("the most recent version of STAC, v0.6.2"),s("OutboundLink")],1),t._v(". In the last months, openEO contributed several extensions to the STAC specification such as "),s("a",{attrs:{href:"https://github.com/radiantearth/stac-spec/blob/master/extensions/sar/README.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("an extension to describe Synthetic-Aperture Radar (SAR) data"),s("OutboundLink")],1),t._v(" or "),s("a",{attrs:{href:"https://github.com/radiantearth/stac-spec/blob/master/extensions/datacube/README.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("an extension to describe Data Cubes"),s("OutboundLink")],1),t._v(".")]),t._v(" "),s("p",[t._v("Despite the process and data discovery, we generally improved the discovery of openEO back-ends. For example, the API now also allows clients to automatically detect supported API versions at the back-end, so that users don't need to keep track of that and can always connect to the same URL without worrying about compatibility between clients and back-ends. Our approach to "),s("a",{attrs:{href:"https://github.com/Open-EO/openeo-udf",target:"_blank",rel:"noopener noreferrer"}},[t._v("user-defined functions (UDFs)"),s("OutboundLink")],1),t._v(" was also better integrated withing the API. UDF runtimes can be discovered now and well-defined processes allow executing UDFs. Many more improvements were incorporated into the API specification based on feedback from the review meeting, discussions with users and implementations (see the "),s("a",{attrs:{href:"https://open-eo.github.io/openeo-api/changelog/",target:"_blank",rel:"noopener noreferrer"}},[t._v("full changelog"),s("OutboundLink")],1),t._v(").")]),t._v(" "),s("h2",{attrs:{id:"next-steps"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#next-steps"}},[t._v("#")]),t._v(" Next steps")]),t._v(" "),s("p",[t._v("This is the API version, which is targeted towards getting the first more universally usable version of the openEO clients and back-ends released. We will work hard now to implement the back-ends and clients to comply with the new API version and will follow up with a new blog post once this is achieved. Afterwards, all interested parties can use clients and back-ends to get a first solid impression of the project. In the meantime, it is already possible to make experiments with the back-ends and clients working on the API version 0.3.1. Please "),s("a",{attrs:{href:"http://openeo.org/contact/",target:"_blank",rel:"noopener noreferrer"}},[t._v("contact us"),s("OutboundLink")],1),t._v(" to get more information about it. Having said that, the new version is not the last one and we will continue to improve the API, client and back-ends. So any feedback is highly appreciated and can be sent our way via GitHub issues in the corresponding "),s("a",{attrs:{href:"https://github.com/open-eo",target:"_blank",rel:"noopener noreferrer"}},[t._v("GitHub repositories"),s("OutboundLink")],1),t._v(" or via any of the other "),s("a",{attrs:{href:"http://openeo.org/contact/",target:"_blank",rel:"noopener noreferrer"}},[t._v("contact options"),s("OutboundLink")],1),t._v(".")])])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/assets/js/51.ed7fc11b.js b/assets/js/51.0d7ccc2d.js similarity index 99% rename from assets/js/51.ed7fc11b.js rename to assets/js/51.0d7ccc2d.js index 7b74be21e..9fe00faae 100644 --- a/assets/js/51.ed7fc11b.js +++ b/assets/js/51.0d7ccc2d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[51],{338:function(t,e,s){t.exports=s.p+"assets/img/r-client-vis.7bf4d9c7.png"},554:function(t,e,s){"use strict";s.r(e);var a=s(4),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("p",[t._v("Today, we released a new version 1.2.0 of the openEO R Client, which features a couple of "),e("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client/releases/tag/v1.2.0",target:"_blank",rel:"noopener noreferrer"}},[t._v("improvements and bug fixes"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("p",[t._v("You can get it through CRAN: "),e("a",{attrs:{href:"https://cran.r-project.org/package=openeo",target:"_blank",rel:"noopener noreferrer"}},[t._v("openeo"),e("OutboundLink")],1),t._v("\nThis means you can install or update the R client with the following command:")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("install.packages"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"openeo"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("If you have trouble installing or working with the package, feel free to leave an issue in the "),e("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client/issues",target:"_blank",rel:"noopener noreferrer"}},[t._v("GitHub issue tracker"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("p",[t._v("We would like to highlight some of the changes:")]),t._v(" "),e("ul",[e("li",[e("p",[e("code",[t._v("get_sample")]),t._v(": We've introduced a method to retrieve sample data that can be used to experiment with a small subset of the data locally. A vignette shows how to use it: "),e("a",{attrs:{href:"https://cran.r-project.org/web/packages/openeo/vignettes/sample_data.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("Sample Data Retrieval"),e("OutboundLink")],1)])]),t._v(" "),e("li",[e("p",[t._v("Many functions such as "),e("code",[t._v("list_collections")]),t._v(" , "),e("code",[t._v("describe_collection")]),t._v(", "),e("code",[t._v("list_processes")]),t._v(" now return visual components in environments that support it (Jupyter, RMarkdown, knitr). Here's an example of the collection list, which includes searching capabilities:\n"),e("img",{attrs:{src:s(338),alt:""}})])]),t._v(" "),e("li",[e("p",[t._v("The metadata filter in "),e("code",[t._v("load_collection")]),t._v(" was made much easier to use. "),e("strong",[t._v("You may need to adapt your code!")]),t._v("\nThe new method to filter by cloud cover looks very clean and is less cumbersome to write. It is as simple as this: "),e("code",[t._v('properties = list("eo:cloud_cover" = function(x) x <= 50)')]),t._v("\nBeforehand, the same filter had to be specified as such:")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("properties "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"eo:cloud_cover"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"process_graph"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"cc"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"process_id"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"lte"')]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"arguments"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"x"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"from_parameter"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"value"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"y"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"result"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("TRUE")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])])]),t._v(" "),e("li",[e("p",[t._v("The login procedure was greatly simplified for back-ends that support this new behavior. For example, on openEO Platform you can now login simply by calling the login method as such "),e("code",[t._v("login()")]),t._v(" instead of passing a client ID and secret tom "),e("code",[t._v("connect()")]),t._v(" or "),e("code",[t._v("login()")]),t._v(". It is still possible, but not required any more. It will then interactively guide you through the login procedure. It is now also supported to login in environments that are remotely hosted (e.g. RStudio Cloud, Jupyter).")])]),t._v(" "),e("li",[e("p",[t._v("Getting the JSON representation of a process is now simplified. The new recommended way is "),e("code",[t._v('toJSON(as(result, "Process"))')]),t._v(" where "),e("code",[t._v("result")]),t._v(" is the last node of your process, which usually is "),e("code",[t._v("save_result")]),t._v(".")])]),t._v(" "),e("li",[e("p",[t._v("Directly load data into "),e("a",{attrs:{href:"https://r-spatial.github.io/stars/",target:"_blank",rel:"noopener noreferrer"}},[e("code",[t._v("stars")]),e("OutboundLink")],1),t._v(" if you set "),e("code",[t._v("as_stars=TRUE")]),t._v(" in "),e("code",[t._v("compute_result")])])])])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[51],{338:function(t,e,s){t.exports=s.p+"assets/img/r-client-vis.7bf4d9c7.png"},555:function(t,e,s){"use strict";s.r(e);var a=s(4),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("p",[t._v("Today, we released a new version 1.2.0 of the openEO R Client, which features a couple of "),e("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client/releases/tag/v1.2.0",target:"_blank",rel:"noopener noreferrer"}},[t._v("improvements and bug fixes"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("p",[t._v("You can get it through CRAN: "),e("a",{attrs:{href:"https://cran.r-project.org/package=openeo",target:"_blank",rel:"noopener noreferrer"}},[t._v("openeo"),e("OutboundLink")],1),t._v("\nThis means you can install or update the R client with the following command:")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("install.packages"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"openeo"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("If you have trouble installing or working with the package, feel free to leave an issue in the "),e("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client/issues",target:"_blank",rel:"noopener noreferrer"}},[t._v("GitHub issue tracker"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("p",[t._v("We would like to highlight some of the changes:")]),t._v(" "),e("ul",[e("li",[e("p",[e("code",[t._v("get_sample")]),t._v(": We've introduced a method to retrieve sample data that can be used to experiment with a small subset of the data locally. A vignette shows how to use it: "),e("a",{attrs:{href:"https://cran.r-project.org/web/packages/openeo/vignettes/sample_data.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("Sample Data Retrieval"),e("OutboundLink")],1)])]),t._v(" "),e("li",[e("p",[t._v("Many functions such as "),e("code",[t._v("list_collections")]),t._v(" , "),e("code",[t._v("describe_collection")]),t._v(", "),e("code",[t._v("list_processes")]),t._v(" now return visual components in environments that support it (Jupyter, RMarkdown, knitr). Here's an example of the collection list, which includes searching capabilities:\n"),e("img",{attrs:{src:s(338),alt:""}})])]),t._v(" "),e("li",[e("p",[t._v("The metadata filter in "),e("code",[t._v("load_collection")]),t._v(" was made much easier to use. "),e("strong",[t._v("You may need to adapt your code!")]),t._v("\nThe new method to filter by cloud cover looks very clean and is less cumbersome to write. It is as simple as this: "),e("code",[t._v('properties = list("eo:cloud_cover" = function(x) x <= 50)')]),t._v("\nBeforehand, the same filter had to be specified as such:")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("properties "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"eo:cloud_cover"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"process_graph"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"cc"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"process_id"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"lte"')]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"arguments"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"x"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" list"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"from_parameter"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"value"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"y"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" p\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"result"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("TRUE")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])])]),t._v(" "),e("li",[e("p",[t._v("The login procedure was greatly simplified for back-ends that support this new behavior. For example, on openEO Platform you can now login simply by calling the login method as such "),e("code",[t._v("login()")]),t._v(" instead of passing a client ID and secret tom "),e("code",[t._v("connect()")]),t._v(" or "),e("code",[t._v("login()")]),t._v(". It is still possible, but not required any more. It will then interactively guide you through the login procedure. It is now also supported to login in environments that are remotely hosted (e.g. RStudio Cloud, Jupyter).")])]),t._v(" "),e("li",[e("p",[t._v("Getting the JSON representation of a process is now simplified. The new recommended way is "),e("code",[t._v('toJSON(as(result, "Process"))')]),t._v(" where "),e("code",[t._v("result")]),t._v(" is the last node of your process, which usually is "),e("code",[t._v("save_result")]),t._v(".")])]),t._v(" "),e("li",[e("p",[t._v("Directly load data into "),e("a",{attrs:{href:"https://r-spatial.github.io/stars/",target:"_blank",rel:"noopener noreferrer"}},[e("code",[t._v("stars")]),e("OutboundLink")],1),t._v(" if you set "),e("code",[t._v("as_stars=TRUE")]),t._v(" in "),e("code",[t._v("compute_result")])])])])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/58.96257999.js b/assets/js/58.b15d29d6.js similarity index 97% rename from assets/js/58.96257999.js rename to assets/js/58.b15d29d6.js index 5ebdf5ba8..524143b3f 100644 --- a/assets/js/58.96257999.js +++ b/assets/js/58.b15d29d6.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[58],{496:function(e,t,n){"use strict";n.r(t);var o=n(4),a=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"introduction"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#introduction"}},[e._v("#")]),e._v(" Introduction")]),e._v(" "),t("p",[t("em",[e._v("This is the openEO Developer Documentation for API versions 0.4.x.")])]),e._v(" "),t("p",[e._v("The openEO API defines a "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/api/reference.html"}},[e._v("HTTP API")]),e._v(" that lets cloud back-ends with large Earth observation datasets communicate with front end analysis applications in an interoperable way.")],1),e._v(" "),t("p",[e._v("As an overview, the openEO API specifies how to")]),e._v(" "),t("ul",[t("li",[e._v("discover which Earth observation data and processes are available at cloud back-ends,")]),e._v(" "),t("li",[e._v("execute (chained) processes on back-ends,")]),e._v(" "),t("li",[e._v("run "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/backends/udfs.html"}},[e._v("user-defined functions")]),e._v(" (UDFs) on back-ends where UDFs can be exposed to the data in different ways,")],1),e._v(" "),t("li",[e._v("download (intermediate) results, and")]),e._v(" "),t("li",[e._v("manage user content including billing.")])]),e._v(" "),t("p",[e._v("The API is defined as an "),t("a",{attrs:{href:"https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenAPI 3.0"),t("OutboundLink")],1),e._v(" JSON file.")]),e._v(" "),t("h2",{attrs:{id:"additional-information"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#additional-information"}},[e._v("#")]),e._v(" Additional information")]),e._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/documentation/code-of-conduct.html"}},[e._v("Code of Conduct")])],1),e._v(" "),t("li",[t("RouterLink",{attrs:{to:"/documentation/software-guidelines.html"}},[e._v("Software Development Guidelines")])],1)])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[58],{497:function(e,t,n){"use strict";n.r(t);var o=n(4),a=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"introduction"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#introduction"}},[e._v("#")]),e._v(" Introduction")]),e._v(" "),t("p",[t("em",[e._v("This is the openEO Developer Documentation for API versions 0.4.x.")])]),e._v(" "),t("p",[e._v("The openEO API defines a "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/api/reference.html"}},[e._v("HTTP API")]),e._v(" that lets cloud back-ends with large Earth observation datasets communicate with front end analysis applications in an interoperable way.")],1),e._v(" "),t("p",[e._v("As an overview, the openEO API specifies how to")]),e._v(" "),t("ul",[t("li",[e._v("discover which Earth observation data and processes are available at cloud back-ends,")]),e._v(" "),t("li",[e._v("execute (chained) processes on back-ends,")]),e._v(" "),t("li",[e._v("run "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/backends/udfs.html"}},[e._v("user-defined functions")]),e._v(" (UDFs) on back-ends where UDFs can be exposed to the data in different ways,")],1),e._v(" "),t("li",[e._v("download (intermediate) results, and")]),e._v(" "),t("li",[e._v("manage user content including billing.")])]),e._v(" "),t("p",[e._v("The API is defined as an "),t("a",{attrs:{href:"https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenAPI 3.0"),t("OutboundLink")],1),e._v(" JSON file.")]),e._v(" "),t("h2",{attrs:{id:"additional-information"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#additional-information"}},[e._v("#")]),e._v(" Additional information")]),e._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/documentation/code-of-conduct.html"}},[e._v("Code of Conduct")])],1),e._v(" "),t("li",[t("RouterLink",{attrs:{to:"/documentation/software-guidelines.html"}},[e._v("Software Development Guidelines")])],1)])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/60.597380b5.js b/assets/js/60.53f362ae.js similarity index 99% rename from assets/js/60.597380b5.js rename to assets/js/60.53f362ae.js index d5cc9cce0..2b6c195aa 100644 --- a/assets/js/60.597380b5.js +++ b/assets/js/60.53f362ae.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[60],{497:function(e,t,r){"use strict";r.r(t);var s=r(4),o=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"status-and-error-handling"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#status-and-error-handling"}},[e._v("#")]),e._v(" Status and error handling")]),e._v(" "),t("p",[e._v("The success of requests MUST be indicated using "),t("a",{attrs:{href:"https://tools.ietf.org/html/rfc7231#section-6",target:"_blank",rel:"noopener noreferrer"}},[e._v("HTTP status codes"),t("OutboundLink")],1),e._v(" according to "),t("a",{attrs:{href:"https://tools.ietf.org/html/rfc7231",target:"_blank",rel:"noopener noreferrer"}},[e._v("RFC 7231"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("If the API responds with a status code between 100 and 399 the back-end indicates that the request has been handled successfully.")]),e._v(" "),t("p",[e._v("In general an error is communicated with a status code between 400 and 599. Client errors are defined as a client passing invalid data to the service and the service "),t("em",[e._v("correctly")]),e._v(' rejecting that data. Examples include invalid credentials, incorrect parameters, unknown versions, or similar. These are generally "4xx" HTTP error codes and are the result of a client passing incorrect or invalid data. Client errors do '),t("em",[e._v("not")]),e._v(" contribute to overall API availability.")]),e._v(" "),t("p",[e._v('Server errors are defined as the server failing to correctly return in response to a valid client request. These are generally "5xx" HTTP error codes. Server errors '),t("em",[e._v("do")]),e._v(" contribute to the overall API availability. Calls that fail due to rate limiting or quota failures MUST NOT count as server errors.")]),e._v(" "),t("h2",{attrs:{id:"json-error-object"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#json-error-object"}},[e._v("#")]),e._v(" JSON error object")]),e._v(" "),t("p",[e._v("A JSON error object SHOULD be sent with all responses that have a status code between 400 and 599.")]),e._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"id"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"936DA01F-9ABD-4D9D-80C7-02AF85C822A8"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"code"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"SampleError"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"message"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"A sample error message."')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"url"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"http://www.openeo.org/docs/errors/SampleError"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("Sending "),t("code",[e._v("code")]),e._v(" and "),t("code",[e._v("message")]),e._v(" is REQUIRED.")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("A back-end MAY add a free-form "),t("code",[e._v("id")]),e._v(" (unique identifier) to the error response to be able to log and track errors with further non-disclosable details.")])]),e._v(" "),t("li",[t("p",[e._v("The "),t("code",[e._v("code")]),e._v(" is either one of the standardized textual openEO error codes below or a proprietary error code.")])]),e._v(" "),t("li",[t("p",[e._v("The "),t("code",[e._v("message")]),e._v(' explains the reason the server is rejecting the request. For "4xx" error codes the message explains how the client needs to modify the request.')]),e._v(" "),t("p",[e._v("By default the message MUST be sent in English language. Content Negotiation is used to localize the error messages: If an "),t("code",[e._v("Accept-Language")]),e._v(" header is sent by the client and a translation is available, the message should be translated accordingly and the "),t("code",[e._v("Content-Language")]),e._v(' header must be present in the response. See "'),t("a",{attrs:{href:"http://apiux.com/2013/04/25/how-to-localize-your-api/",target:"_blank",rel:"noopener noreferrer"}},[e._v("How to localize your API"),t("OutboundLink")],1),e._v('" for more information.')])]),e._v(" "),t("li",[t("p",[t("code",[e._v("url")]),e._v(" is an OPTIONAL attribute and contains a link to a resource that is explaining the error and potential solutions in-depth.")])])]),e._v(" "),t("h2",{attrs:{id:"standardized-status-codes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#standardized-status-codes"}},[e._v("#")]),e._v(" Standardized status codes")]),e._v(" "),t("p",[e._v("The openEO API usually uses the following HTTP status codes for successful requests:")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("200 OK")]),e._v(":\nIndicates a successful request "),t("strong",[e._v("with")]),e._v(" a response body being sent.")]),e._v(" "),t("li",[t("strong",[e._v("201 Created")]),e._v("\nIndicates a successful request that successfully created a new resource. Sends a "),t("code",[e._v("Location")]),e._v(" header to the newly created resource "),t("strong",[e._v("without")]),e._v(" a response body.")]),e._v(" "),t("li",[t("strong",[e._v("202 Accepted")]),e._v("\nIndicates a successful request that successfully queued the creation of a new resource, but it has not been created yet. The response is sent "),t("strong",[e._v("without")]),e._v(" a response body.")]),e._v(" "),t("li",[t("strong",[e._v("204 No Content")]),e._v(":\nIndicates a successful request "),t("strong",[e._v("without")]),e._v(" a response body being sent.")])]),e._v(" "),t("p",[e._v("The openEO API often uses the following HTTP status codes for failed requests:")]),e._v(" "),t("ul",[t("li",[t("p",[t("strong",[e._v("400 Bad Request")]),e._v(":\nThe back-end responds with this error code whenever the error has its origin on client side and no other HTTP status code in the 400 range is suitable.")])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("401 Unauthorized")]),e._v(":\nThe client did not provide any authentication details for a resource requiring authentication or the provided authentication details are not correct.")])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("403 Forbidden")]),e._v(":\nThe client did provided correct authentication details, but the privileges/permissions of the provided credentials do not allow to request the resource.")])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("404 Not Found")]),e._v(":\nThe resource specified by the path does not exist, i.e. one of the resources belonging to the specified identifiers are not available at the back-end.\n"),t("em",[e._v("Note:")]),e._v(" Unsupported endpoints MUST use HTTP status code 501.")])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("500 Internal Server Error")]),e._v(":\nThe error has its origin on server side and no other status code in the 500 range is suitable.")])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("501 Not Implemented")]),e._v(":\nAn endpoint is specified in the openEO API, but is not supported.")])])]),e._v(" "),t("p",[e._v("If a HTTP status code in the 400 range is returned, the client SHOULD NOT repeat the request without modifications. For HTTP status code in the 500 range, the client MAY repeat the same request later.")]),e._v(" "),t("p",[e._v("All HTTP status codes defined in RFC 7231 in the 400 and 500 ranges can be used as openEO error code in addition to the most used status codes mentioned here. Responding with openEO error codes 400 and 500 SHOULD be avoided in favor of any more specific standardized or proprietary openEO error code.")]),e._v(" "),t("h2",{attrs:{id:"openeo-error-codes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#openeo-error-codes"}},[e._v("#")]),e._v(" openEO error codes")]),e._v(" "),t("p",[e._v("The following table of error codes is "),t("strong",[e._v("incomplete")]),e._v(". These error codes will evolve over time. If you are missing any common error, please contribute it by adding an "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/issues/new",target:"_blank",rel:"noopener noreferrer"}},[e._v("issue"),t("OutboundLink")],1),e._v(", creating a pull request or get in contact in our "),t("a",{attrs:{href:"https://openeo-chat.eodc.eu/channel/public",target:"_blank",rel:"noopener noreferrer"}},[e._v("chat room"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("ErrorCodes")],1)}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[60],{496:function(e,t,r){"use strict";r.r(t);var s=r(4),o=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"status-and-error-handling"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#status-and-error-handling"}},[e._v("#")]),e._v(" Status and error handling")]),e._v(" "),t("p",[e._v("The success of requests MUST be indicated using "),t("a",{attrs:{href:"https://tools.ietf.org/html/rfc7231#section-6",target:"_blank",rel:"noopener noreferrer"}},[e._v("HTTP status codes"),t("OutboundLink")],1),e._v(" according to "),t("a",{attrs:{href:"https://tools.ietf.org/html/rfc7231",target:"_blank",rel:"noopener noreferrer"}},[e._v("RFC 7231"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("If the API responds with a status code between 100 and 399 the back-end indicates that the request has been handled successfully.")]),e._v(" "),t("p",[e._v("In general an error is communicated with a status code between 400 and 599. Client errors are defined as a client passing invalid data to the service and the service "),t("em",[e._v("correctly")]),e._v(' rejecting that data. Examples include invalid credentials, incorrect parameters, unknown versions, or similar. These are generally "4xx" HTTP error codes and are the result of a client passing incorrect or invalid data. Client errors do '),t("em",[e._v("not")]),e._v(" contribute to overall API availability.")]),e._v(" "),t("p",[e._v('Server errors are defined as the server failing to correctly return in response to a valid client request. These are generally "5xx" HTTP error codes. Server errors '),t("em",[e._v("do")]),e._v(" contribute to the overall API availability. Calls that fail due to rate limiting or quota failures MUST NOT count as server errors.")]),e._v(" "),t("h2",{attrs:{id:"json-error-object"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#json-error-object"}},[e._v("#")]),e._v(" JSON error object")]),e._v(" "),t("p",[e._v("A JSON error object SHOULD be sent with all responses that have a status code between 400 and 599.")]),e._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"id"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"936DA01F-9ABD-4D9D-80C7-02AF85C822A8"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"code"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"SampleError"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"message"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"A sample error message."')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"url"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"http://www.openeo.org/docs/errors/SampleError"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("Sending "),t("code",[e._v("code")]),e._v(" and "),t("code",[e._v("message")]),e._v(" is REQUIRED.")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("A back-end MAY add a free-form "),t("code",[e._v("id")]),e._v(" (unique identifier) to the error response to be able to log and track errors with further non-disclosable details.")])]),e._v(" "),t("li",[t("p",[e._v("The "),t("code",[e._v("code")]),e._v(" is either one of the standardized textual openEO error codes below or a proprietary error code.")])]),e._v(" "),t("li",[t("p",[e._v("The "),t("code",[e._v("message")]),e._v(' explains the reason the server is rejecting the request. For "4xx" error codes the message explains how the client needs to modify the request.')]),e._v(" "),t("p",[e._v("By default the message MUST be sent in English language. Content Negotiation is used to localize the error messages: If an "),t("code",[e._v("Accept-Language")]),e._v(" header is sent by the client and a translation is available, the message should be translated accordingly and the "),t("code",[e._v("Content-Language")]),e._v(' header must be present in the response. See "'),t("a",{attrs:{href:"http://apiux.com/2013/04/25/how-to-localize-your-api/",target:"_blank",rel:"noopener noreferrer"}},[e._v("How to localize your API"),t("OutboundLink")],1),e._v('" for more information.')])]),e._v(" "),t("li",[t("p",[t("code",[e._v("url")]),e._v(" is an OPTIONAL attribute and contains a link to a resource that is explaining the error and potential solutions in-depth.")])])]),e._v(" "),t("h2",{attrs:{id:"standardized-status-codes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#standardized-status-codes"}},[e._v("#")]),e._v(" Standardized status codes")]),e._v(" "),t("p",[e._v("The openEO API usually uses the following HTTP status codes for successful requests:")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("200 OK")]),e._v(":\nIndicates a successful request "),t("strong",[e._v("with")]),e._v(" a response body being sent.")]),e._v(" "),t("li",[t("strong",[e._v("201 Created")]),e._v("\nIndicates a successful request that successfully created a new resource. Sends a "),t("code",[e._v("Location")]),e._v(" header to the newly created resource "),t("strong",[e._v("without")]),e._v(" a response body.")]),e._v(" "),t("li",[t("strong",[e._v("202 Accepted")]),e._v("\nIndicates a successful request that successfully queued the creation of a new resource, but it has not been created yet. The response is sent "),t("strong",[e._v("without")]),e._v(" a response body.")]),e._v(" "),t("li",[t("strong",[e._v("204 No Content")]),e._v(":\nIndicates a successful request "),t("strong",[e._v("without")]),e._v(" a response body being sent.")])]),e._v(" "),t("p",[e._v("The openEO API often uses the following HTTP status codes for failed requests:")]),e._v(" "),t("ul",[t("li",[t("p",[t("strong",[e._v("400 Bad Request")]),e._v(":\nThe back-end responds with this error code whenever the error has its origin on client side and no other HTTP status code in the 400 range is suitable.")])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("401 Unauthorized")]),e._v(":\nThe client did not provide any authentication details for a resource requiring authentication or the provided authentication details are not correct.")])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("403 Forbidden")]),e._v(":\nThe client did provided correct authentication details, but the privileges/permissions of the provided credentials do not allow to request the resource.")])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("404 Not Found")]),e._v(":\nThe resource specified by the path does not exist, i.e. one of the resources belonging to the specified identifiers are not available at the back-end.\n"),t("em",[e._v("Note:")]),e._v(" Unsupported endpoints MUST use HTTP status code 501.")])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("500 Internal Server Error")]),e._v(":\nThe error has its origin on server side and no other status code in the 500 range is suitable.")])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("501 Not Implemented")]),e._v(":\nAn endpoint is specified in the openEO API, but is not supported.")])])]),e._v(" "),t("p",[e._v("If a HTTP status code in the 400 range is returned, the client SHOULD NOT repeat the request without modifications. For HTTP status code in the 500 range, the client MAY repeat the same request later.")]),e._v(" "),t("p",[e._v("All HTTP status codes defined in RFC 7231 in the 400 and 500 ranges can be used as openEO error code in addition to the most used status codes mentioned here. Responding with openEO error codes 400 and 500 SHOULD be avoided in favor of any more specific standardized or proprietary openEO error code.")]),e._v(" "),t("h2",{attrs:{id:"openeo-error-codes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#openeo-error-codes"}},[e._v("#")]),e._v(" openEO error codes")]),e._v(" "),t("p",[e._v("The following table of error codes is "),t("strong",[e._v("incomplete")]),e._v(". These error codes will evolve over time. If you are missing any common error, please contribute it by adding an "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/issues/new",target:"_blank",rel:"noopener noreferrer"}},[e._v("issue"),t("OutboundLink")],1),e._v(", creating a pull request or get in contact in our "),t("a",{attrs:{href:"https://openeo-chat.eodc.eu/channel/public",target:"_blank",rel:"noopener noreferrer"}},[e._v("chat room"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("ErrorCodes")],1)}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/64.796cc93f.js b/assets/js/64.75e72158.js similarity index 98% rename from assets/js/64.796cc93f.js rename to assets/js/64.75e72158.js index 9693fc427..982760539 100644 --- a/assets/js/64.796cc93f.js +++ b/assets/js/64.75e72158.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[64],{502:function(e,t,r){"use strict";r.r(t);var a=r(4),n=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"getting-started-for-client-developers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getting-started-for-client-developers"}},[e._v("#")]),e._v(" Getting started for client developers")]),e._v(" "),t("p",[e._v("For easy access to openEO back-ends it is essential to provide client libraries for users in their well-known programming languages or working environments. This can be either a "),t("em",[e._v("client library")]),e._v(" for a specific programming language that hides the technical details of the openEO API or an application with a user interface, e.g. a GIS software plugin or a web-based tool. All software written for openEO should follow the "),t("RouterLink",{attrs:{to:"/documentation/software-guidelines.html"}},[e._v("software development guidelines")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"client-library-developers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#client-library-developers"}},[e._v("#")]),e._v(" Client library developers")]),e._v(" "),t("p",[e._v("If your preferred programming language is not part of the "),t("RouterLink",{attrs:{to:"/software.html#clients"}},[e._v("available client libraries")]),e._v(" you may consider writing your own client library. Our client libraries are basically translating the openEO API into native concepts of the programming languages. Working with openEO should feel like being a "),t("a",{attrs:{href:"https://en.wikipedia.org/wiki/First-class_citizen",target:"_blank",rel:"noopener noreferrer"}},[e._v("first-class citizen"),t("OutboundLink")],1),e._v(" of the programming language.")],1),e._v(" "),t("p",[e._v("Get started by reading the "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/clients/library-guidelines.html"}},[e._v("guidelines to develop client libraries")]),e._v(", which have been written to ensure the client libraries provide a consistent feel and behavior across programming languages. You certainly need to understand the "),t("RouterLink",{attrs:{to:"/documentation/0.4/glossary.html"}},[e._v("glossary")]),e._v(" and the concepts behind "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/api/"}},[e._v("processes")]),e._v(" and "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/api/"}},[e._v("process graphs")]),e._v(". This helps you understand the "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/api/reference.html"}},[e._v("API specification")]),e._v(" and related documents.")],1),e._v(" "),t("p",[e._v("If you do not want to start from scratch, you could try to generate a client library stub from the "),t("a",{attrs:{href:"https://www.openapis.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenAPI 3.0"),t("OutboundLink")],1),e._v("-based "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/api/reference.html"}},[e._v("API specification")]),e._v(" with the "),t("a",{attrs:{href:"https://github.com/OpenAPITools/openapi-generator",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenAPI Generator"),t("OutboundLink")],1),e._v(". Make sure the generated code complies to the client library guidelines mentioned above.")],1),e._v(" "),t("h2",{attrs:{id:"applications-and-software-plugins"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#applications-and-software-plugins"}},[e._v("#")]),e._v(" Applications and Software plugins")]),e._v(" "),t("p",[e._v("Standalone applications and software plugins written in a certain programming language could use the "),t("RouterLink",{attrs:{to:"/software.html#clients"}},[e._v("existing client libraries")]),e._v(" to facilitate access to openEO back-ends. Web applications potentially could use the "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-js-client",target:"_blank",rel:"noopener noreferrer"}},[e._v("JavaScript client"),t("OutboundLink")],1),e._v(" to access openEO back-ends. Back-Ends may also provide standardized web interfaces such as OGC WMS or OGC WCS to access processed EO data.")],1)])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[64],{503:function(e,t,r){"use strict";r.r(t);var a=r(4),n=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"getting-started-for-client-developers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getting-started-for-client-developers"}},[e._v("#")]),e._v(" Getting started for client developers")]),e._v(" "),t("p",[e._v("For easy access to openEO back-ends it is essential to provide client libraries for users in their well-known programming languages or working environments. This can be either a "),t("em",[e._v("client library")]),e._v(" for a specific programming language that hides the technical details of the openEO API or an application with a user interface, e.g. a GIS software plugin or a web-based tool. All software written for openEO should follow the "),t("RouterLink",{attrs:{to:"/documentation/software-guidelines.html"}},[e._v("software development guidelines")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"client-library-developers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#client-library-developers"}},[e._v("#")]),e._v(" Client library developers")]),e._v(" "),t("p",[e._v("If your preferred programming language is not part of the "),t("RouterLink",{attrs:{to:"/software.html#clients"}},[e._v("available client libraries")]),e._v(" you may consider writing your own client library. Our client libraries are basically translating the openEO API into native concepts of the programming languages. Working with openEO should feel like being a "),t("a",{attrs:{href:"https://en.wikipedia.org/wiki/First-class_citizen",target:"_blank",rel:"noopener noreferrer"}},[e._v("first-class citizen"),t("OutboundLink")],1),e._v(" of the programming language.")],1),e._v(" "),t("p",[e._v("Get started by reading the "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/clients/library-guidelines.html"}},[e._v("guidelines to develop client libraries")]),e._v(", which have been written to ensure the client libraries provide a consistent feel and behavior across programming languages. You certainly need to understand the "),t("RouterLink",{attrs:{to:"/documentation/0.4/glossary.html"}},[e._v("glossary")]),e._v(" and the concepts behind "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/api/"}},[e._v("processes")]),e._v(" and "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/api/"}},[e._v("process graphs")]),e._v(". This helps you understand the "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/api/reference.html"}},[e._v("API specification")]),e._v(" and related documents.")],1),e._v(" "),t("p",[e._v("If you do not want to start from scratch, you could try to generate a client library stub from the "),t("a",{attrs:{href:"https://www.openapis.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenAPI 3.0"),t("OutboundLink")],1),e._v("-based "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/api/reference.html"}},[e._v("API specification")]),e._v(" with the "),t("a",{attrs:{href:"https://github.com/OpenAPITools/openapi-generator",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenAPI Generator"),t("OutboundLink")],1),e._v(". Make sure the generated code complies to the client library guidelines mentioned above.")],1),e._v(" "),t("h2",{attrs:{id:"applications-and-software-plugins"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#applications-and-software-plugins"}},[e._v("#")]),e._v(" Applications and Software plugins")]),e._v(" "),t("p",[e._v("Standalone applications and software plugins written in a certain programming language could use the "),t("RouterLink",{attrs:{to:"/software.html#clients"}},[e._v("existing client libraries")]),e._v(" to facilitate access to openEO back-ends. Web applications potentially could use the "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-js-client",target:"_blank",rel:"noopener noreferrer"}},[e._v("JavaScript client"),t("OutboundLink")],1),e._v(" to access openEO back-ends. Back-Ends may also provide standardized web interfaces such as OGC WMS or OGC WCS to access processed EO data.")],1)])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/65.c4708516.js b/assets/js/65.7ff37e56.js similarity index 99% rename from assets/js/65.c4708516.js rename to assets/js/65.7ff37e56.js index 5f934439e..80520c466 100644 --- a/assets/js/65.c4708516.js +++ b/assets/js/65.7ff37e56.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[65],{503:function(t,s,e){"use strict";e.r(s);var a=e(4),n=Object(a.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"client-library-development-guidelines"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#client-library-development-guidelines"}},[t._v("#")]),t._v(" Client library development guidelines")]),t._v(" "),s("p",[t._v("This is a proposal for workflows that client libraries should support to make the experience with each library similar and users can easily adopt examples and workflows.")]),t._v(" "),s("p",[t._v("For best experience libraries should still embrace best practices common in their environments. This means clients can...")]),t._v(" "),s("ul",[s("li",[t._v("choose which kind of casing they use (see below).")]),t._v(" "),s("li",[t._v("feel free to implement aliases for methods.")])]),t._v(" "),s("h2",{attrs:{id:"conventions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#conventions"}},[t._v("#")]),t._v(" Conventions")]),t._v(" "),s("h3",{attrs:{id:"casing"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#casing"}},[t._v("#")]),t._v(" Casing")]),t._v(" "),s("p",[t._v("Clients can use "),s("code",[t._v("snake_case")]),t._v(", "),s("code",[t._v("camelCase")]),t._v(" or any method used commonly in their environment. For example, the API request to get a list of collections can either be names "),s("code",[t._v("get_collections")]),t._v(" or "),s("code",[t._v("getCollections")]),t._v(". This applies for all names, including scopes, method names and parameters.")]),t._v(" "),s("h3",{attrs:{id:"scopes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scopes"}},[t._v("#")]),t._v(" Scopes")]),t._v(" "),s("p",[t._v('Each method belongs to a scope. To achieve this in object-oriented (OO) programming languages, methods would be part of a class. If programming languages don\'t support scopes, you may need to simulate it somehow to prevent name collisions, e.g. by adding a prefix to the method names (like in the "procedural style" example below). Best practices for this will likely evolve over time.')]),t._v(" "),s("p",[t._v("Example for the "),s("code",[t._v("clientVersion")]),t._v(" method in "),s("code",[t._v("openEO")]),t._v(":")]),t._v(" "),s("ul",[s("li",[t._v("Procedural style: "),s("code",[t._v("openeo_client_version()")])]),t._v(" "),s("li",[t._v("Object-oriented style:"),s("div",{staticClass:"language-java extra-class"},[s("pre",{pre:!0,attrs:{class:"language-java"}},[s("code",[s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),t._v(" obj "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nobj"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("clientVersion")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])]),t._v(" "),s("p",[t._v("If you can't store scope data in an object, you may need to pass these information as argument(s) to the method.")]),t._v(" "),s("p",[t._v("Example:")]),t._v(" "),s("ul",[s("li",[t._v("Procedural style:"),s("div",{staticClass:"language-php extra-class"},[s("pre",{pre:!0,attrs:{class:"language-php"}},[s("code",[s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_connect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"https://openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_capabilities")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[t._v("Object-oriented style:"),s("div",{staticClass:"language-java extra-class"},[s("pre",{pre:!0,attrs:{class:"language-java"}},[s("code",[s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),t._v(" obj "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Connection")]),t._v(" con "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" obj"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("connect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\ncon"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("capabilities")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])]),t._v(" "),s("h3",{attrs:{id:"scope-categories"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scope-categories"}},[t._v("#")]),t._v(" Scope categories")]),t._v(" "),s("p",[t._v("Each scope is assigned to a scope category, of which there are three:")]),t._v(" "),s("ul",[s("li",[s("em",[t._v("Root")]),t._v(" category: Contains only the scope "),s("code",[t._v("openEO")]),t._v(".")]),t._v(" "),s("li",[s("em",[t._v("API")]),t._v(" category: Mostly methods hiding API calls to the back-ends. Methods may be implemented asynchronously. Contains the scopes "),s("code",[t._v("Connection")]),t._v(", "),s("code",[t._v("File")]),t._v(", "),s("code",[t._v("Job")]),t._v(", "),s("code",[t._v("ProcessGraph")]),t._v(", "),s("code",[t._v("Service")]),t._v(".")]),t._v(" "),s("li",[s("em",[t._v("Content")]),t._v(": Mostly methods hiding the complexity of response content. Methods are usually implemented synchronously. Currently contains only the scope "),s("code",[t._v("Capabilities")]),t._v(". Method names should be prefixed if name collisions are likely.")])]),t._v(" "),s("p",[t._v("Method names across ALL the scopes that belong to the "),s("em",[t._v("root")]),t._v(" or "),s("em",[t._v("API")]),t._v(" categories MUST be unique. This is the case because the parameter in "),s("code",[t._v("hasFeature(method_name)")]),t._v(" must be unambiguous.")]),t._v(" "),s("p",[t._v("Method names of scopes in the "),s("em",[t._v("Content")]),t._v(" category may collide with method names of scopes in the "),s("em",[t._v("root")]),t._v("/"),s("em",[t._v("API")]),t._v(" categories and names should be prefixed if collisions of names between different scope categories are to be expected.")]),t._v(" "),s("h3",{attrs:{id:"parameters"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),s("p",[t._v("The parameters usually follow the request schemes in the openAPI specification. The parameters should follow their characteristics, for example regarding the default values.")]),t._v(" "),s("p",[t._v("Some methods have a long list of (optional) parameters. This is easy to implement in languages that support named parameters such as R. For example, creating a job in R with a budget would lead to this method call:")]),t._v(" "),s("div",{staticClass:"language-R extra-class"},[s("pre",{pre:!0,attrs:{class:"language-r"}},[s("code",[t._v("createJob"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("process_graph "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token ellipsis"}},[t._v("...")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" budget "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("123")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("p",[t._v("Other languages that only support non-named parameters (i.e. the order of parameters is fixed) need to fill many parameters with default values, which is not convenient for a user. The example above in PHP would be:")]),t._v(" "),s("div",{staticClass:"language-php extra-class"},[s("pre",{pre:!0,attrs:{class:"language-php"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createJob")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("123")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("p",[t._v("To avoid such method calls client developers should consider to pass either")]),t._v(" "),s("ul",[s("li",[t._v("an instance of a class, which contains all parameters as member variables or")]),t._v(" "),s("li",[t._v("the required parameters directly and the optional parameters as a dictionary (see example below).")])]),t._v(" "),s("p",[t._v("This basically emulates named parameters. The member variables / dictionary keys should use the same names as the parameters. The exemplary method call in PHP could be improved as follows:")]),t._v(" "),s("div",{staticClass:"language-php extra-class"},[s("pre",{pre:!0,attrs:{class:"language-php"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createJob")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("budget "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("123")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("h2",{attrs:{id:"method-mappings"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#method-mappings"}},[t._v("#")]),t._v(" Method mappings")]),t._v(" "),s("p",[s("strong",[t._v("Note:")]),t._v(" Subscriptions and some scopes for response JSON objects are still missing. We are open for proposals.")]),t._v(" "),s("p",[t._v("Parameters with a leading "),s("code",[t._v("?")]),t._v(" are optional.")]),t._v(" "),s("h3",{attrs:{id:"scope-openeo-root-category"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scope-openeo-root-category"}},[t._v("#")]),t._v(" Scope: "),s("code",[t._v("openEO")]),t._v(" (root category)")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Description")]),t._v(" "),s("th",[t._v("Client method")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("Connect to a back-end, includes version discovery ("),s("code",[t._v("GET /well-known/openeo")]),t._v("), requesting capabilities and authentication where required. Returns "),s("code",[t._v("Connection")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("connect(url, ?authType, ?authOptions)")])])]),t._v(" "),s("tr",[s("td",[t._v("Get client library version.")]),t._v(" "),s("td",[s("code",[t._v("clientVersion()")])])])])]),t._v(" "),s("h4",{attrs:{id:"parameters-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),s("ul",[s("li",[s("strong",[t._v("authType")]),t._v(" in "),s("code",[t._v("connect")]),t._v(": "),s("code",[t._v("null")]),t._v(", "),s("code",[t._v("basic")]),t._v(" or "),s("code",[t._v("oidc")]),t._v(" (non-exclusive). Defaults to "),s("code",[t._v("null")]),t._v(" (no authentication).")]),t._v(" "),s("li",[s("strong",[t._v("authOptions")]),t._v(" in "),s("code",[t._v("connect")]),t._v(": May hold additional data for authentication, for example a username and password for "),s("code",[t._v("basic")]),t._v(" authentication.")])]),t._v(" "),s("h3",{attrs:{id:"scope-connection-api-category"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scope-connection-api-category"}},[t._v("#")]),t._v(" Scope: "),s("code",[t._v("Connection")]),t._v(" (API category)")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Description")]),t._v(" "),s("th",[t._v("API Request")]),t._v(" "),s("th",[t._v("Client method")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("Get the capabilities of the back-end. Returns "),s("code",[t._v("Capabilities")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("GET /")])]),t._v(" "),s("td",[s("code",[t._v("capabilities()")])])]),t._v(" "),s("tr",[s("td",[t._v("List the supported output file formats.")]),t._v(" "),s("td",[s("code",[t._v("GET /output_formats")])]),t._v(" "),s("td",[s("code",[t._v("listFileTypes()")])])]),t._v(" "),s("tr",[s("td",[t._v("List the supported secondary service types.")]),t._v(" "),s("td",[s("code",[t._v("GET /service_types")])]),t._v(" "),s("td",[s("code",[t._v("listServiceTypes()")])])]),t._v(" "),s("tr",[s("td",[t._v("List the supported UDF runtimes.")]),t._v(" "),s("td",[s("code",[t._v("GET /udf_runtimes")])]),t._v(" "),s("td",[s("code",[t._v("listUdfRuntimes()")])])]),t._v(" "),s("tr",[s("td",[t._v("List all collections available on the back-end.")]),t._v(" "),s("td",[s("code",[t._v("GET /collections")])]),t._v(" "),s("td",[s("code",[t._v("listCollections()")])])]),t._v(" "),s("tr",[s("td",[t._v("Get information about a single collection.")]),t._v(" "),s("td",[s("code",[t._v("GET /collections/{collection_id}")])]),t._v(" "),s("td",[s("code",[t._v("describeCollection(collection_id)")])])]),t._v(" "),s("tr",[s("td",[t._v("List all processes available on the back-end.")]),t._v(" "),s("td",[s("code",[t._v("GET /processes")])]),t._v(" "),s("td",[s("code",[t._v("listProcesses()")])])]),t._v(" "),s("tr",[s("td",[t._v("Authenticate with OpenID Connect (if not specified in "),s("code",[t._v("connect")]),t._v(").")]),t._v(" "),s("td",[s("code",[t._v("GET /credentials/oidc")])]),t._v(" "),s("td",[s("code",[t._v("authenticateOIDC(?options)")])])]),t._v(" "),s("tr",[s("td",[t._v("Authenticate with HTTP Basic (if not specified in "),s("code",[t._v("connect")]),t._v(").")]),t._v(" "),s("td",[s("code",[t._v("GET /credentials/basic")])]),t._v(" "),s("td",[s("code",[t._v("authenticateBasic(username, password)")])])]),t._v(" "),s("tr",[s("td",[t._v("Get information about the authenticated user.")]),t._v(" "),s("td",[s("code",[t._v("GET /me")])]),t._v(" "),s("td",[s("code",[t._v("describeAccount()")])])]),t._v(" "),s("tr",[s("td",[t._v("Lists all files from a user. Returns a list of "),s("code",[t._v("File")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("GET /files/{user_id}")])]),t._v(" "),s("td",[s("code",[t._v("listFiles(?userId)")])])]),t._v(" "),s("tr",[s("td",[t._v("Opens a (existing or non-existing) file without reading any information. Returns a "),s("code",[t._v("File")]),t._v(".")]),t._v(" "),s("td",[s("em",[t._v("None")])]),t._v(" "),s("td",[s("code",[t._v("openFile(path, ?userId)")])])]),t._v(" "),s("tr",[s("td",[t._v("Validates a process graph.")]),t._v(" "),s("td",[s("code",[t._v("POST /validation")])]),t._v(" "),s("td",[s("code",[t._v("validateProcessGraph(processGraph)")])])]),t._v(" "),s("tr",[s("td",[t._v("Lists all process graphs of the authenticated user. Returns a list of "),s("code",[t._v("ProcessGraph")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("GET /process_graphs")])]),t._v(" "),s("td",[s("code",[t._v("listProcessGraphs()")])])]),t._v(" "),s("tr",[s("td",[t._v("Creates a new stored process graph. Returns a "),s("code",[t._v("ProcessGraph")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("POST /process_graphs")])]),t._v(" "),s("td",[s("code",[t._v("createProcessGraph(processGraph, ?title, ?description)")])])]),t._v(" "),s("tr",[s("td",[t._v("Get all information about a stored process graph. Returns a "),s("code",[t._v("ProcessGraph")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("GET /process_graphs/{process_graph_id}")])]),t._v(" "),s("td",[s("code",[t._v("getProcessGraphById(id)")])])]),t._v(" "),s("tr",[s("td",[t._v("Executes a process graph synchronously.")]),t._v(" "),s("td",[s("code",[t._v("POST /result")])]),t._v(" "),s("td",[s("code",[t._v("computeResult(processGraph, ?plan, ?budget)")])])]),t._v(" "),s("tr",[s("td",[t._v("Lists all jobs of the authenticated user. Returns a list of "),s("code",[t._v("Job")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("GET /jobs")])]),t._v(" "),s("td",[s("code",[t._v("listJobs()")])])]),t._v(" "),s("tr",[s("td",[t._v("Creates a new job. Returns a "),s("code",[t._v("Job")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("POST /jobs")])]),t._v(" "),s("td",[s("code",[t._v("createJob(processGraph, ?title, ?description, ?plan, ?budget, ?additional)")])])]),t._v(" "),s("tr",[s("td",[t._v("Get all information about a job. Returns a "),s("code",[t._v("Job")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("GET /jobs/{job_id}")])]),t._v(" "),s("td",[s("code",[t._v("getJobById(id)")])])]),t._v(" "),s("tr",[s("td",[t._v("Lists all secondary services of the authenticated user. Returns a list of "),s("code",[t._v("Service")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("GET /services")])]),t._v(" "),s("td",[s("code",[t._v("listServices()")])])]),t._v(" "),s("tr",[s("td",[t._v("Creates a new secondary service. Returns a "),s("code",[t._v("Service")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("POST /services")])]),t._v(" "),s("td",[s("code",[t._v("createService(processGraph, type, ?title, ?description, ?enabled, ?parameters, ?plan, ?budget)")])])]),t._v(" "),s("tr",[s("td",[t._v("Get all information about a service. Returns a "),s("code",[t._v("Service")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("GET /services/{service_id}")])]),t._v(" "),s("td",[s("code",[t._v("getServiceById(id)")])])])])]),t._v(" "),s("h4",{attrs:{id:"parameters-3"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),s("ul",[s("li",[s("strong",[t._v("userId")]),t._v(" in "),s("code",[t._v("listFiles")]),t._v(" and "),s("code",[t._v("createFile")]),t._v(": Defaults to the user id of the authenticated user.")]),t._v(" "),s("li",[s("strong",[t._v("options")]),t._v(" in "),s("code",[t._v("authenticateOIDC")]),t._v(": May hold additional data required for OpenID connect authentication.")])]),t._v(" "),s("h3",{attrs:{id:"scope-capabilities-content-category"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scope-capabilities-content-category"}},[t._v("#")]),t._v(" Scope "),s("code",[t._v("Capabilities")]),t._v(" (Content category)")]),t._v(" "),s("p",[t._v("Should be prefixed with "),s("code",[t._v("Capabilities")]),t._v(" if collisions of names between different scope categories are to be expected.")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Description")]),t._v(" "),s("th",[t._v("Field")]),t._v(" "),s("th",[t._v("Client method")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("Get the implemented openEO version.")]),t._v(" "),s("td",[s("code",[t._v("api_version")])]),t._v(" "),s("td",[s("code",[t._v("apiVersion()")])])]),t._v(" "),s("tr",[s("td",[t._v("Get the back-end version.")]),t._v(" "),s("td",[s("code",[t._v("backend_version")])]),t._v(" "),s("td",[s("code",[t._v("backendVersion()")])])]),t._v(" "),s("tr",[s("td",[t._v("Get the name of the back-end.")]),t._v(" "),s("td",[s("code",[t._v("title")])]),t._v(" "),s("td",[s("code",[t._v("title()")])])]),t._v(" "),s("tr",[s("td",[t._v("Get the description of the back-end.")]),t._v(" "),s("td",[s("code",[t._v("description")])]),t._v(" "),s("td",[s("code",[t._v("description()")])])]),t._v(" "),s("tr",[s("td",[t._v("List all supported features / endpoints.")]),t._v(" "),s("td",[s("code",[t._v("endpoints")])]),t._v(" "),s("td",[s("code",[t._v("listFeatures()")])])]),t._v(" "),s("tr",[s("td",[t._v("Check whether a feature / endpoint is supported.")]),t._v(" "),s("td",[s("code",[t._v("endpoints")]),t._v(" > ...")]),t._v(" "),s("td",[s("code",[t._v("hasFeature(methodName)")])])]),t._v(" "),s("tr",[s("td",[t._v("Get the default billing currency.")]),t._v(" "),s("td",[s("code",[t._v("billing")]),t._v(" > "),s("code",[t._v("currency")])]),t._v(" "),s("td",[s("code",[t._v("currency()")])])]),t._v(" "),s("tr",[s("td",[t._v("List all billing plans.")]),t._v(" "),s("td",[s("code",[t._v("billing")]),t._v(" > "),s("code",[t._v("plans")])]),t._v(" "),s("td",[s("code",[t._v("listPlans()")])])])])]),t._v(" "),s("h4",{attrs:{id:"parameters-4"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),s("ul",[s("li",[s("strong",[t._v("methodName")]),t._v(" in "),s("code",[t._v("hasFeature")]),t._v(": The name of a client method in any of the scopes that are part of the "),s("em",[t._v("API")]),t._v(" category. E.g. "),s("code",[t._v('hasFeature("describeAccount")')]),t._v(" checks whether the "),s("code",[t._v("GET /me")]),t._v(" endpoint is contained in the capabilities response's "),s("code",[t._v("endpoints")]),t._v(" object.")])]),t._v(" "),s("h3",{attrs:{id:"scope-file-api-category"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scope-file-api-category"}},[t._v("#")]),t._v(" Scope: "),s("code",[t._v("File")]),t._v(" (API category)")]),t._v(" "),s("p",[t._v("The "),s("code",[t._v("File")]),t._v(" scope internally knows the "),s("code",[t._v("user_id")]),t._v(" and the "),s("code",[t._v("path")]),t._v(".")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Description")]),t._v(" "),s("th",[t._v("API Request")]),t._v(" "),s("th",[t._v("Client method")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("Download a user file.")]),t._v(" "),s("td",[s("code",[t._v("GET /files/{user_id}/{path}")])]),t._v(" "),s("td",[s("code",[t._v("downloadFile(target)")])])]),t._v(" "),s("tr",[s("td",[t._v("Upload a user file.")]),t._v(" "),s("td",[s("code",[t._v("PUT /files/{user_id}/{path}")])]),t._v(" "),s("td",[s("code",[t._v("uploadFile(source)")])])]),t._v(" "),s("tr",[s("td",[t._v("Delete a user file.")]),t._v(" "),s("td",[s("code",[t._v("DELETE /files/{user_id}/{path}")])]),t._v(" "),s("td",[s("code",[t._v("deleteFile()")])])])])]),t._v(" "),s("h4",{attrs:{id:"parameters-5"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),s("ul",[s("li",[s("strong",[t._v("target")]),t._v(" in "),s("code",[t._v("downloadFile")]),t._v(": Path to a local file or folder.")])]),t._v(" "),s("h3",{attrs:{id:"scope-job-api-category"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scope-job-api-category"}},[t._v("#")]),t._v(" Scope: "),s("code",[t._v("Job")]),t._v(" (API category)")]),t._v(" "),s("p",[t._v("The "),s("code",[t._v("Job")]),t._v(" scope internally knows the "),s("code",[t._v("job_id")]),t._v(".")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Description")]),t._v(" "),s("th",[t._v("API Request")]),t._v(" "),s("th",[t._v("Client method")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("Get (and update on client-side) all job information.")]),t._v(" "),s("td",[s("code",[t._v("GET /jobs/{job_id}")])]),t._v(" "),s("td",[s("code",[t._v("describeJob()")])])]),t._v(" "),s("tr",[s("td",[t._v("Modify a job at the back-end.")]),t._v(" "),s("td",[s("code",[t._v("PATCH /jobs/{job_id}")])]),t._v(" "),s("td",[s("code",[t._v("updateJob(?processGraph, ?title, ?description, ?plan, ?budget, ?additional)")])])]),t._v(" "),s("tr",[s("td",[t._v("Delete a job")]),t._v(" "),s("td",[s("code",[t._v("DELETE /jobs/{job_id}")])]),t._v(" "),s("td",[s("code",[t._v("deleteJob()")])])]),t._v(" "),s("tr",[s("td",[t._v("Calculate an time/cost estimate for a job.")]),t._v(" "),s("td",[s("code",[t._v("GET /jobs/{job_id}/estimate")])]),t._v(" "),s("td",[s("code",[t._v("estimateJob()")])])]),t._v(" "),s("tr",[s("td",[t._v("Get log file for job.")]),t._v(" "),s("td",[s("code",[t._v("GET /jobs/{job_id}/logs")])]),t._v(" "),s("td",[s("code",[t._v("debugJob()")])])]),t._v(" "),s("tr",[s("td",[t._v("Start / queue a job for processing.")]),t._v(" "),s("td",[s("code",[t._v("POST /jobs/{job_id}/results")])]),t._v(" "),s("td",[s("code",[t._v("startJob()")])])]),t._v(" "),s("tr",[s("td",[t._v("Stop / cancel job processing.")]),t._v(" "),s("td",[s("code",[t._v("DELETE /jobs/{job_id}/results")])]),t._v(" "),s("td",[s("code",[t._v("stopJob()")])])]),t._v(" "),s("tr",[s("td",[t._v("Get document with download links.")]),t._v(" "),s("td",[s("code",[t._v("GET /jobs/{job_id}/results")])]),t._v(" "),s("td",[s("code",[t._v("listResults()")])])]),t._v(" "),s("tr",[s("td",[t._v("Download job results.")]),t._v(" "),s("td",[s("code",[t._v("GET /jobs/{job_id}/results")]),t._v(" > ...")]),t._v(" "),s("td",[s("code",[t._v("downloadResults(target)")])])])])]),t._v(" "),s("h4",{attrs:{id:"parameters-6"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),s("ul",[s("li",[s("strong",[t._v("target")]),t._v(" in "),s("code",[t._v("downloadResults")]),t._v(": Path to a local folder.")])]),t._v(" "),s("h3",{attrs:{id:"scope-processgraph-api-category"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scope-processgraph-api-category"}},[t._v("#")]),t._v(" Scope: "),s("code",[t._v("ProcessGraph")]),t._v(" (API category)")]),t._v(" "),s("p",[t._v("The "),s("code",[t._v("ProcessGraph")]),t._v(" scope internally knows the "),s("code",[t._v("process_graph_id")]),t._v(".")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Description")]),t._v(" "),s("th",[t._v("API Request")]),t._v(" "),s("th",[t._v("Client method")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("Get (and update on client-side) all information about a stored process graph.")]),t._v(" "),s("td",[s("code",[t._v("GET /process_graphs/{process_graph_id}")])]),t._v(" "),s("td",[s("code",[t._v("describeProcessGraph()")])])]),t._v(" "),s("tr",[s("td",[t._v("Modify a stored process graph at the back-end.")]),t._v(" "),s("td",[s("code",[t._v("PATCH /process_graphs/{process_graph_id}")])]),t._v(" "),s("td",[s("code",[t._v("updateProcessGraph(?processGraph, ?title, ?description)")])])]),t._v(" "),s("tr",[s("td",[t._v("Delete a stored process graph.")]),t._v(" "),s("td",[s("code",[t._v("DELETE /process_graphs/{process_graph_id}")])]),t._v(" "),s("td",[s("code",[t._v("deleteProcessGraph()")])])])])]),t._v(" "),s("h3",{attrs:{id:"scope-service-api-category"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scope-service-api-category"}},[t._v("#")]),t._v(" Scope: "),s("code",[t._v("Service")]),t._v(" (API category)")]),t._v(" "),s("p",[t._v("The "),s("code",[t._v("Service")]),t._v(" scope internally knows the "),s("code",[t._v("service_id")]),t._v(".")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Description")]),t._v(" "),s("th",[t._v("API Request")]),t._v(" "),s("th",[t._v("Client method")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("Get (and update on client-side) all information about a secondary web service.")]),t._v(" "),s("td",[s("code",[t._v("GET /services/{service_id}")])]),t._v(" "),s("td",[s("code",[t._v("describeService()")])])]),t._v(" "),s("tr",[s("td",[t._v("Modify a secondary web service at the back-end.")]),t._v(" "),s("td",[s("code",[t._v("PATCH /services/{service_id}")])]),t._v(" "),s("td",[s("code",[t._v("updateService(?processGraph, ?title, ?description, ?enabled, ?parameters, ?plan, ?budget)")])])]),t._v(" "),s("tr",[s("td",[t._v("Delete a secondary web service.")]),t._v(" "),s("td",[s("code",[t._v("DELETE /services/{service_id}")])]),t._v(" "),s("td",[s("code",[t._v("deleteService()")])])]),t._v(" "),s("tr",[s("td",[t._v("Get log file for web service.")]),t._v(" "),s("td",[s("code",[t._v("GET /services/{service_id}/logs")])]),t._v(" "),s("td",[s("code",[t._v("debugService()")])])])])]),t._v(" "),s("h2",{attrs:{id:"processes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#processes"}},[t._v("#")]),t._v(" Processes")]),t._v(" "),s("p",[t._v("The processes a back-end supports may be offered by the clients as methods in its own scope. The method names should follow the process names, but the conventions listed above can be applied here as well, e.g. converting "),s("code",[t._v("filter_bands")]),t._v(" to "),s("code",[t._v("filterBands")]),t._v(". As parameters have no natural or technical ordering in the JSON objects, clients must come up with a reasonable ordering of parameters if required. This could be inspired by existing clients. The way of building a process graph from processes heavily depends on the technical capabilities of the programming language. Therefore it may differ between the client libraries. Follow the best practices of the programming language, e.g. support method chaining if possible.")]),t._v(" "),s("h2",{attrs:{id:"workflow-example"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#workflow-example"}},[t._v("#")]),t._v(" Workflow example")]),t._v(" "),s("p",[t._v("Some simplified example workflows using different programming styles are listed below. The following steps are executed:")]),t._v(" "),s("ol",[s("li",[t._v("Loading the client library.")]),t._v(" "),s("li",[t._v("Connecting to a back-end and authenticating with username and password via OpenID Connect.")]),t._v(" "),s("li",[t._v("Requesting the capabilities and showing the implemented openEO version of the back-end.")]),t._v(" "),s("li",[t._v('Showing information about the "Sentinel-2A" collection.')]),t._v(" "),s("li",[t._v("Showing information about all processes supported by the back-end.")]),t._v(" "),s("li",[t._v("Building a simple process graph.")]),t._v(" "),s("li",[t._v("Creating a job.")]),t._v(" "),s("li",[t._v("Pushing the job to the processing queue.")]),t._v(" "),s("li",[t._v("After a while, showing the job details, e.g. checking the job status.")]),t._v(" "),s("li",[t._v("Once processing is finished, downloading the job results to the local directory "),s("code",[t._v("/tmp/job_results/")]),t._v(".")])]),t._v(" "),s("p",[t._v("Please note that the examples below do not comply to the latest process specification. They are meant to show the differences in client development, but are no working examples!")]),t._v(" "),s("h3",{attrs:{id:"r-functional-style"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#r-functional-style"}},[t._v("#")]),t._v(" R (functional style)")]),t._v(" "),s("div",{staticClass:"language-r extra-class"},[s("pre",{pre:!0,attrs:{class:"language-r"}},[s("code",[t._v("library"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("openeo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\ncon "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" connect"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"username"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"password"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ncap "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" capabilities"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ncap "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v(" apiVersion"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ncon "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v(" describeCollection"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ncon "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v(" listProcesses"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\nprocessgraph "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"load_collection"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" id "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v(" \n process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"filter_bbox"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" west "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("672000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" south "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5181000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" east "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("652000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" north "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5161000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" crs "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"EPSG:32632"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v("\n process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"filter_temporal"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" extent "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-01-01T00:00:00Z"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-01-31T23:59:59Z"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v("\n process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ndvi"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" nir "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B4"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" red "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B8A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v("\n process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"min_time"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\njob "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v(" createJob"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("processgraph"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\njob "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v(" startJob"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\njob "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v(" describeJob"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\njob "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v(" downloadResults"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"/tmp/job_results/"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("h3",{attrs:{id:"python-mixed-style"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#python-mixed-style"}},[t._v("#")]),t._v(" Python (mixed style)")]),t._v(" "),s("div",{staticClass:"language-python extra-class"},[s("pre",{pre:!0,attrs:{class:"language-python"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" openeo\n\ncon "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" openeo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("connect"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"username"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"password"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ncap "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("capabilities"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("print")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cap"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("api_version"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("print")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("describe_collection"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("print")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("list_processes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\nprocesses "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("get_processes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\npg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" processes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("load_collection"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token builtin"}},[t._v("id")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\npg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" processes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("filter_bbox"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("pg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" west"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("672000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" south"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5181000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" east"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("652000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" north"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5161000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" crs"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"EPSG:32632"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\npg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" processes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("filter_temporal"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("pg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" extent"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-01-01T00:00:00Z"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-01-31T23:59:59Z"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\npg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" processes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("ndvi"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("pg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" nir"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B4"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" red"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B8A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\npg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" processes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("min_time"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("pg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\njob "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("create_job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("pg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("graph"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\njob"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("start_job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("print")]),t._v(" job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("describe_job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\njob"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("download_results"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"/tmp/job_results/"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("h3",{attrs:{id:"java-object-oriented-style"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#java-object-oriented-style"}},[t._v("#")]),t._v(" Java (object oriented style)")]),t._v(" "),s("div",{staticClass:"language-java extra-class"},[s("pre",{pre:!0,attrs:{class:"language-java"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token import"}},[s("span",{pre:!0,attrs:{class:"token namespace"}},[t._v("org"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("openeo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")])]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),t._v(" obj "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Connection")]),t._v(" con "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" obj"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("connect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"username"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"password"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Capabilities")]),t._v(" cap "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("capabilities")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("System")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("out"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("println")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cap"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("apiVersion")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("System")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("out"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("println")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("describeCollection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("System")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("out"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("println")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("listProcesses")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ProcessGraphBuilder")]),t._v(" pgb "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getProcessGraphBuilder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Chain processes...")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ProcessGraph")]),t._v(" processGraph "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" pgb"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildProcessGraph")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Job")]),t._v(" job "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createJob")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("processGraph"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\njob"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("startJob")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("System")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("out"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("println")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("describeJob")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\njob"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("downloadResults")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"/tmp/job_results/"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"php-procedural-style"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#php-procedural-style"}},[t._v("#")]),t._v(" PHP (procedural style)")]),t._v(" "),s("div",{staticClass:"language-php extra-class"},[s("pre",{pre:!0,attrs:{class:"language-php"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("require_once")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"/path/to/openeo.php"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_connect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"http://openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"username"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"password"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$capabilities")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_capabilities")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_api_version")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$capabilites")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_describe_collection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"Sentinel-2A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_list_processes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_process")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"load_collection"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"id"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"Sentinel-2A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_process")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"filter_bbox"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"west"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("672000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"south"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5181000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"east"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("652000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"north"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5161000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"crs"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"EPSG:32632"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_process")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"filter_temporal"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"extent"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"2017-01-01T00:00:00Z"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"2017-01-31T23:59:59Z"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_process")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"ndvi"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"red"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"B4"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"nir"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"B8A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_process")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"min_time"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$job")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_create_job")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_start_job")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$job")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_describe_job")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$job")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_download_results")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$job")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"/tmp/job_results/"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[65],{502:function(t,s,e){"use strict";e.r(s);var a=e(4),n=Object(a.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"client-library-development-guidelines"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#client-library-development-guidelines"}},[t._v("#")]),t._v(" Client library development guidelines")]),t._v(" "),s("p",[t._v("This is a proposal for workflows that client libraries should support to make the experience with each library similar and users can easily adopt examples and workflows.")]),t._v(" "),s("p",[t._v("For best experience libraries should still embrace best practices common in their environments. This means clients can...")]),t._v(" "),s("ul",[s("li",[t._v("choose which kind of casing they use (see below).")]),t._v(" "),s("li",[t._v("feel free to implement aliases for methods.")])]),t._v(" "),s("h2",{attrs:{id:"conventions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#conventions"}},[t._v("#")]),t._v(" Conventions")]),t._v(" "),s("h3",{attrs:{id:"casing"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#casing"}},[t._v("#")]),t._v(" Casing")]),t._v(" "),s("p",[t._v("Clients can use "),s("code",[t._v("snake_case")]),t._v(", "),s("code",[t._v("camelCase")]),t._v(" or any method used commonly in their environment. For example, the API request to get a list of collections can either be names "),s("code",[t._v("get_collections")]),t._v(" or "),s("code",[t._v("getCollections")]),t._v(". This applies for all names, including scopes, method names and parameters.")]),t._v(" "),s("h3",{attrs:{id:"scopes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scopes"}},[t._v("#")]),t._v(" Scopes")]),t._v(" "),s("p",[t._v('Each method belongs to a scope. To achieve this in object-oriented (OO) programming languages, methods would be part of a class. If programming languages don\'t support scopes, you may need to simulate it somehow to prevent name collisions, e.g. by adding a prefix to the method names (like in the "procedural style" example below). Best practices for this will likely evolve over time.')]),t._v(" "),s("p",[t._v("Example for the "),s("code",[t._v("clientVersion")]),t._v(" method in "),s("code",[t._v("openEO")]),t._v(":")]),t._v(" "),s("ul",[s("li",[t._v("Procedural style: "),s("code",[t._v("openeo_client_version()")])]),t._v(" "),s("li",[t._v("Object-oriented style:"),s("div",{staticClass:"language-java extra-class"},[s("pre",{pre:!0,attrs:{class:"language-java"}},[s("code",[s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),t._v(" obj "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nobj"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("clientVersion")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])]),t._v(" "),s("p",[t._v("If you can't store scope data in an object, you may need to pass these information as argument(s) to the method.")]),t._v(" "),s("p",[t._v("Example:")]),t._v(" "),s("ul",[s("li",[t._v("Procedural style:"),s("div",{staticClass:"language-php extra-class"},[s("pre",{pre:!0,attrs:{class:"language-php"}},[s("code",[s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_connect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"https://openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_capabilities")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),s("li",[t._v("Object-oriented style:"),s("div",{staticClass:"language-java extra-class"},[s("pre",{pre:!0,attrs:{class:"language-java"}},[s("code",[s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),t._v(" obj "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Connection")]),t._v(" con "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" obj"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("connect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\ncon"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("capabilities")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])]),t._v(" "),s("h3",{attrs:{id:"scope-categories"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scope-categories"}},[t._v("#")]),t._v(" Scope categories")]),t._v(" "),s("p",[t._v("Each scope is assigned to a scope category, of which there are three:")]),t._v(" "),s("ul",[s("li",[s("em",[t._v("Root")]),t._v(" category: Contains only the scope "),s("code",[t._v("openEO")]),t._v(".")]),t._v(" "),s("li",[s("em",[t._v("API")]),t._v(" category: Mostly methods hiding API calls to the back-ends. Methods may be implemented asynchronously. Contains the scopes "),s("code",[t._v("Connection")]),t._v(", "),s("code",[t._v("File")]),t._v(", "),s("code",[t._v("Job")]),t._v(", "),s("code",[t._v("ProcessGraph")]),t._v(", "),s("code",[t._v("Service")]),t._v(".")]),t._v(" "),s("li",[s("em",[t._v("Content")]),t._v(": Mostly methods hiding the complexity of response content. Methods are usually implemented synchronously. Currently contains only the scope "),s("code",[t._v("Capabilities")]),t._v(". Method names should be prefixed if name collisions are likely.")])]),t._v(" "),s("p",[t._v("Method names across ALL the scopes that belong to the "),s("em",[t._v("root")]),t._v(" or "),s("em",[t._v("API")]),t._v(" categories MUST be unique. This is the case because the parameter in "),s("code",[t._v("hasFeature(method_name)")]),t._v(" must be unambiguous.")]),t._v(" "),s("p",[t._v("Method names of scopes in the "),s("em",[t._v("Content")]),t._v(" category may collide with method names of scopes in the "),s("em",[t._v("root")]),t._v("/"),s("em",[t._v("API")]),t._v(" categories and names should be prefixed if collisions of names between different scope categories are to be expected.")]),t._v(" "),s("h3",{attrs:{id:"parameters"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),s("p",[t._v("The parameters usually follow the request schemes in the openAPI specification. The parameters should follow their characteristics, for example regarding the default values.")]),t._v(" "),s("p",[t._v("Some methods have a long list of (optional) parameters. This is easy to implement in languages that support named parameters such as R. For example, creating a job in R with a budget would lead to this method call:")]),t._v(" "),s("div",{staticClass:"language-R extra-class"},[s("pre",{pre:!0,attrs:{class:"language-r"}},[s("code",[t._v("createJob"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("process_graph "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token ellipsis"}},[t._v("...")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" budget "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("123")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("p",[t._v("Other languages that only support non-named parameters (i.e. the order of parameters is fixed) need to fill many parameters with default values, which is not convenient for a user. The example above in PHP would be:")]),t._v(" "),s("div",{staticClass:"language-php extra-class"},[s("pre",{pre:!0,attrs:{class:"language-php"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createJob")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("123")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("p",[t._v("To avoid such method calls client developers should consider to pass either")]),t._v(" "),s("ul",[s("li",[t._v("an instance of a class, which contains all parameters as member variables or")]),t._v(" "),s("li",[t._v("the required parameters directly and the optional parameters as a dictionary (see example below).")])]),t._v(" "),s("p",[t._v("This basically emulates named parameters. The member variables / dictionary keys should use the same names as the parameters. The exemplary method call in PHP could be improved as follows:")]),t._v(" "),s("div",{staticClass:"language-php extra-class"},[s("pre",{pre:!0,attrs:{class:"language-php"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createJob")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("budget "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("123")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("h2",{attrs:{id:"method-mappings"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#method-mappings"}},[t._v("#")]),t._v(" Method mappings")]),t._v(" "),s("p",[s("strong",[t._v("Note:")]),t._v(" Subscriptions and some scopes for response JSON objects are still missing. We are open for proposals.")]),t._v(" "),s("p",[t._v("Parameters with a leading "),s("code",[t._v("?")]),t._v(" are optional.")]),t._v(" "),s("h3",{attrs:{id:"scope-openeo-root-category"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scope-openeo-root-category"}},[t._v("#")]),t._v(" Scope: "),s("code",[t._v("openEO")]),t._v(" (root category)")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Description")]),t._v(" "),s("th",[t._v("Client method")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("Connect to a back-end, includes version discovery ("),s("code",[t._v("GET /well-known/openeo")]),t._v("), requesting capabilities and authentication where required. Returns "),s("code",[t._v("Connection")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("connect(url, ?authType, ?authOptions)")])])]),t._v(" "),s("tr",[s("td",[t._v("Get client library version.")]),t._v(" "),s("td",[s("code",[t._v("clientVersion()")])])])])]),t._v(" "),s("h4",{attrs:{id:"parameters-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),s("ul",[s("li",[s("strong",[t._v("authType")]),t._v(" in "),s("code",[t._v("connect")]),t._v(": "),s("code",[t._v("null")]),t._v(", "),s("code",[t._v("basic")]),t._v(" or "),s("code",[t._v("oidc")]),t._v(" (non-exclusive). Defaults to "),s("code",[t._v("null")]),t._v(" (no authentication).")]),t._v(" "),s("li",[s("strong",[t._v("authOptions")]),t._v(" in "),s("code",[t._v("connect")]),t._v(": May hold additional data for authentication, for example a username and password for "),s("code",[t._v("basic")]),t._v(" authentication.")])]),t._v(" "),s("h3",{attrs:{id:"scope-connection-api-category"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scope-connection-api-category"}},[t._v("#")]),t._v(" Scope: "),s("code",[t._v("Connection")]),t._v(" (API category)")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Description")]),t._v(" "),s("th",[t._v("API Request")]),t._v(" "),s("th",[t._v("Client method")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("Get the capabilities of the back-end. Returns "),s("code",[t._v("Capabilities")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("GET /")])]),t._v(" "),s("td",[s("code",[t._v("capabilities()")])])]),t._v(" "),s("tr",[s("td",[t._v("List the supported output file formats.")]),t._v(" "),s("td",[s("code",[t._v("GET /output_formats")])]),t._v(" "),s("td",[s("code",[t._v("listFileTypes()")])])]),t._v(" "),s("tr",[s("td",[t._v("List the supported secondary service types.")]),t._v(" "),s("td",[s("code",[t._v("GET /service_types")])]),t._v(" "),s("td",[s("code",[t._v("listServiceTypes()")])])]),t._v(" "),s("tr",[s("td",[t._v("List the supported UDF runtimes.")]),t._v(" "),s("td",[s("code",[t._v("GET /udf_runtimes")])]),t._v(" "),s("td",[s("code",[t._v("listUdfRuntimes()")])])]),t._v(" "),s("tr",[s("td",[t._v("List all collections available on the back-end.")]),t._v(" "),s("td",[s("code",[t._v("GET /collections")])]),t._v(" "),s("td",[s("code",[t._v("listCollections()")])])]),t._v(" "),s("tr",[s("td",[t._v("Get information about a single collection.")]),t._v(" "),s("td",[s("code",[t._v("GET /collections/{collection_id}")])]),t._v(" "),s("td",[s("code",[t._v("describeCollection(collection_id)")])])]),t._v(" "),s("tr",[s("td",[t._v("List all processes available on the back-end.")]),t._v(" "),s("td",[s("code",[t._v("GET /processes")])]),t._v(" "),s("td",[s("code",[t._v("listProcesses()")])])]),t._v(" "),s("tr",[s("td",[t._v("Authenticate with OpenID Connect (if not specified in "),s("code",[t._v("connect")]),t._v(").")]),t._v(" "),s("td",[s("code",[t._v("GET /credentials/oidc")])]),t._v(" "),s("td",[s("code",[t._v("authenticateOIDC(?options)")])])]),t._v(" "),s("tr",[s("td",[t._v("Authenticate with HTTP Basic (if not specified in "),s("code",[t._v("connect")]),t._v(").")]),t._v(" "),s("td",[s("code",[t._v("GET /credentials/basic")])]),t._v(" "),s("td",[s("code",[t._v("authenticateBasic(username, password)")])])]),t._v(" "),s("tr",[s("td",[t._v("Get information about the authenticated user.")]),t._v(" "),s("td",[s("code",[t._v("GET /me")])]),t._v(" "),s("td",[s("code",[t._v("describeAccount()")])])]),t._v(" "),s("tr",[s("td",[t._v("Lists all files from a user. Returns a list of "),s("code",[t._v("File")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("GET /files/{user_id}")])]),t._v(" "),s("td",[s("code",[t._v("listFiles(?userId)")])])]),t._v(" "),s("tr",[s("td",[t._v("Opens a (existing or non-existing) file without reading any information. Returns a "),s("code",[t._v("File")]),t._v(".")]),t._v(" "),s("td",[s("em",[t._v("None")])]),t._v(" "),s("td",[s("code",[t._v("openFile(path, ?userId)")])])]),t._v(" "),s("tr",[s("td",[t._v("Validates a process graph.")]),t._v(" "),s("td",[s("code",[t._v("POST /validation")])]),t._v(" "),s("td",[s("code",[t._v("validateProcessGraph(processGraph)")])])]),t._v(" "),s("tr",[s("td",[t._v("Lists all process graphs of the authenticated user. Returns a list of "),s("code",[t._v("ProcessGraph")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("GET /process_graphs")])]),t._v(" "),s("td",[s("code",[t._v("listProcessGraphs()")])])]),t._v(" "),s("tr",[s("td",[t._v("Creates a new stored process graph. Returns a "),s("code",[t._v("ProcessGraph")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("POST /process_graphs")])]),t._v(" "),s("td",[s("code",[t._v("createProcessGraph(processGraph, ?title, ?description)")])])]),t._v(" "),s("tr",[s("td",[t._v("Get all information about a stored process graph. Returns a "),s("code",[t._v("ProcessGraph")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("GET /process_graphs/{process_graph_id}")])]),t._v(" "),s("td",[s("code",[t._v("getProcessGraphById(id)")])])]),t._v(" "),s("tr",[s("td",[t._v("Executes a process graph synchronously.")]),t._v(" "),s("td",[s("code",[t._v("POST /result")])]),t._v(" "),s("td",[s("code",[t._v("computeResult(processGraph, ?plan, ?budget)")])])]),t._v(" "),s("tr",[s("td",[t._v("Lists all jobs of the authenticated user. Returns a list of "),s("code",[t._v("Job")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("GET /jobs")])]),t._v(" "),s("td",[s("code",[t._v("listJobs()")])])]),t._v(" "),s("tr",[s("td",[t._v("Creates a new job. Returns a "),s("code",[t._v("Job")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("POST /jobs")])]),t._v(" "),s("td",[s("code",[t._v("createJob(processGraph, ?title, ?description, ?plan, ?budget, ?additional)")])])]),t._v(" "),s("tr",[s("td",[t._v("Get all information about a job. Returns a "),s("code",[t._v("Job")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("GET /jobs/{job_id}")])]),t._v(" "),s("td",[s("code",[t._v("getJobById(id)")])])]),t._v(" "),s("tr",[s("td",[t._v("Lists all secondary services of the authenticated user. Returns a list of "),s("code",[t._v("Service")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("GET /services")])]),t._v(" "),s("td",[s("code",[t._v("listServices()")])])]),t._v(" "),s("tr",[s("td",[t._v("Creates a new secondary service. Returns a "),s("code",[t._v("Service")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("POST /services")])]),t._v(" "),s("td",[s("code",[t._v("createService(processGraph, type, ?title, ?description, ?enabled, ?parameters, ?plan, ?budget)")])])]),t._v(" "),s("tr",[s("td",[t._v("Get all information about a service. Returns a "),s("code",[t._v("Service")]),t._v(".")]),t._v(" "),s("td",[s("code",[t._v("GET /services/{service_id}")])]),t._v(" "),s("td",[s("code",[t._v("getServiceById(id)")])])])])]),t._v(" "),s("h4",{attrs:{id:"parameters-3"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),s("ul",[s("li",[s("strong",[t._v("userId")]),t._v(" in "),s("code",[t._v("listFiles")]),t._v(" and "),s("code",[t._v("createFile")]),t._v(": Defaults to the user id of the authenticated user.")]),t._v(" "),s("li",[s("strong",[t._v("options")]),t._v(" in "),s("code",[t._v("authenticateOIDC")]),t._v(": May hold additional data required for OpenID connect authentication.")])]),t._v(" "),s("h3",{attrs:{id:"scope-capabilities-content-category"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scope-capabilities-content-category"}},[t._v("#")]),t._v(" Scope "),s("code",[t._v("Capabilities")]),t._v(" (Content category)")]),t._v(" "),s("p",[t._v("Should be prefixed with "),s("code",[t._v("Capabilities")]),t._v(" if collisions of names between different scope categories are to be expected.")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Description")]),t._v(" "),s("th",[t._v("Field")]),t._v(" "),s("th",[t._v("Client method")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("Get the implemented openEO version.")]),t._v(" "),s("td",[s("code",[t._v("api_version")])]),t._v(" "),s("td",[s("code",[t._v("apiVersion()")])])]),t._v(" "),s("tr",[s("td",[t._v("Get the back-end version.")]),t._v(" "),s("td",[s("code",[t._v("backend_version")])]),t._v(" "),s("td",[s("code",[t._v("backendVersion()")])])]),t._v(" "),s("tr",[s("td",[t._v("Get the name of the back-end.")]),t._v(" "),s("td",[s("code",[t._v("title")])]),t._v(" "),s("td",[s("code",[t._v("title()")])])]),t._v(" "),s("tr",[s("td",[t._v("Get the description of the back-end.")]),t._v(" "),s("td",[s("code",[t._v("description")])]),t._v(" "),s("td",[s("code",[t._v("description()")])])]),t._v(" "),s("tr",[s("td",[t._v("List all supported features / endpoints.")]),t._v(" "),s("td",[s("code",[t._v("endpoints")])]),t._v(" "),s("td",[s("code",[t._v("listFeatures()")])])]),t._v(" "),s("tr",[s("td",[t._v("Check whether a feature / endpoint is supported.")]),t._v(" "),s("td",[s("code",[t._v("endpoints")]),t._v(" > ...")]),t._v(" "),s("td",[s("code",[t._v("hasFeature(methodName)")])])]),t._v(" "),s("tr",[s("td",[t._v("Get the default billing currency.")]),t._v(" "),s("td",[s("code",[t._v("billing")]),t._v(" > "),s("code",[t._v("currency")])]),t._v(" "),s("td",[s("code",[t._v("currency()")])])]),t._v(" "),s("tr",[s("td",[t._v("List all billing plans.")]),t._v(" "),s("td",[s("code",[t._v("billing")]),t._v(" > "),s("code",[t._v("plans")])]),t._v(" "),s("td",[s("code",[t._v("listPlans()")])])])])]),t._v(" "),s("h4",{attrs:{id:"parameters-4"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),s("ul",[s("li",[s("strong",[t._v("methodName")]),t._v(" in "),s("code",[t._v("hasFeature")]),t._v(": The name of a client method in any of the scopes that are part of the "),s("em",[t._v("API")]),t._v(" category. E.g. "),s("code",[t._v('hasFeature("describeAccount")')]),t._v(" checks whether the "),s("code",[t._v("GET /me")]),t._v(" endpoint is contained in the capabilities response's "),s("code",[t._v("endpoints")]),t._v(" object.")])]),t._v(" "),s("h3",{attrs:{id:"scope-file-api-category"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scope-file-api-category"}},[t._v("#")]),t._v(" Scope: "),s("code",[t._v("File")]),t._v(" (API category)")]),t._v(" "),s("p",[t._v("The "),s("code",[t._v("File")]),t._v(" scope internally knows the "),s("code",[t._v("user_id")]),t._v(" and the "),s("code",[t._v("path")]),t._v(".")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Description")]),t._v(" "),s("th",[t._v("API Request")]),t._v(" "),s("th",[t._v("Client method")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("Download a user file.")]),t._v(" "),s("td",[s("code",[t._v("GET /files/{user_id}/{path}")])]),t._v(" "),s("td",[s("code",[t._v("downloadFile(target)")])])]),t._v(" "),s("tr",[s("td",[t._v("Upload a user file.")]),t._v(" "),s("td",[s("code",[t._v("PUT /files/{user_id}/{path}")])]),t._v(" "),s("td",[s("code",[t._v("uploadFile(source)")])])]),t._v(" "),s("tr",[s("td",[t._v("Delete a user file.")]),t._v(" "),s("td",[s("code",[t._v("DELETE /files/{user_id}/{path}")])]),t._v(" "),s("td",[s("code",[t._v("deleteFile()")])])])])]),t._v(" "),s("h4",{attrs:{id:"parameters-5"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),s("ul",[s("li",[s("strong",[t._v("target")]),t._v(" in "),s("code",[t._v("downloadFile")]),t._v(": Path to a local file or folder.")])]),t._v(" "),s("h3",{attrs:{id:"scope-job-api-category"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scope-job-api-category"}},[t._v("#")]),t._v(" Scope: "),s("code",[t._v("Job")]),t._v(" (API category)")]),t._v(" "),s("p",[t._v("The "),s("code",[t._v("Job")]),t._v(" scope internally knows the "),s("code",[t._v("job_id")]),t._v(".")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Description")]),t._v(" "),s("th",[t._v("API Request")]),t._v(" "),s("th",[t._v("Client method")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("Get (and update on client-side) all job information.")]),t._v(" "),s("td",[s("code",[t._v("GET /jobs/{job_id}")])]),t._v(" "),s("td",[s("code",[t._v("describeJob()")])])]),t._v(" "),s("tr",[s("td",[t._v("Modify a job at the back-end.")]),t._v(" "),s("td",[s("code",[t._v("PATCH /jobs/{job_id}")])]),t._v(" "),s("td",[s("code",[t._v("updateJob(?processGraph, ?title, ?description, ?plan, ?budget, ?additional)")])])]),t._v(" "),s("tr",[s("td",[t._v("Delete a job")]),t._v(" "),s("td",[s("code",[t._v("DELETE /jobs/{job_id}")])]),t._v(" "),s("td",[s("code",[t._v("deleteJob()")])])]),t._v(" "),s("tr",[s("td",[t._v("Calculate an time/cost estimate for a job.")]),t._v(" "),s("td",[s("code",[t._v("GET /jobs/{job_id}/estimate")])]),t._v(" "),s("td",[s("code",[t._v("estimateJob()")])])]),t._v(" "),s("tr",[s("td",[t._v("Get log file for job.")]),t._v(" "),s("td",[s("code",[t._v("GET /jobs/{job_id}/logs")])]),t._v(" "),s("td",[s("code",[t._v("debugJob()")])])]),t._v(" "),s("tr",[s("td",[t._v("Start / queue a job for processing.")]),t._v(" "),s("td",[s("code",[t._v("POST /jobs/{job_id}/results")])]),t._v(" "),s("td",[s("code",[t._v("startJob()")])])]),t._v(" "),s("tr",[s("td",[t._v("Stop / cancel job processing.")]),t._v(" "),s("td",[s("code",[t._v("DELETE /jobs/{job_id}/results")])]),t._v(" "),s("td",[s("code",[t._v("stopJob()")])])]),t._v(" "),s("tr",[s("td",[t._v("Get document with download links.")]),t._v(" "),s("td",[s("code",[t._v("GET /jobs/{job_id}/results")])]),t._v(" "),s("td",[s("code",[t._v("listResults()")])])]),t._v(" "),s("tr",[s("td",[t._v("Download job results.")]),t._v(" "),s("td",[s("code",[t._v("GET /jobs/{job_id}/results")]),t._v(" > ...")]),t._v(" "),s("td",[s("code",[t._v("downloadResults(target)")])])])])]),t._v(" "),s("h4",{attrs:{id:"parameters-6"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),s("ul",[s("li",[s("strong",[t._v("target")]),t._v(" in "),s("code",[t._v("downloadResults")]),t._v(": Path to a local folder.")])]),t._v(" "),s("h3",{attrs:{id:"scope-processgraph-api-category"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scope-processgraph-api-category"}},[t._v("#")]),t._v(" Scope: "),s("code",[t._v("ProcessGraph")]),t._v(" (API category)")]),t._v(" "),s("p",[t._v("The "),s("code",[t._v("ProcessGraph")]),t._v(" scope internally knows the "),s("code",[t._v("process_graph_id")]),t._v(".")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Description")]),t._v(" "),s("th",[t._v("API Request")]),t._v(" "),s("th",[t._v("Client method")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("Get (and update on client-side) all information about a stored process graph.")]),t._v(" "),s("td",[s("code",[t._v("GET /process_graphs/{process_graph_id}")])]),t._v(" "),s("td",[s("code",[t._v("describeProcessGraph()")])])]),t._v(" "),s("tr",[s("td",[t._v("Modify a stored process graph at the back-end.")]),t._v(" "),s("td",[s("code",[t._v("PATCH /process_graphs/{process_graph_id}")])]),t._v(" "),s("td",[s("code",[t._v("updateProcessGraph(?processGraph, ?title, ?description)")])])]),t._v(" "),s("tr",[s("td",[t._v("Delete a stored process graph.")]),t._v(" "),s("td",[s("code",[t._v("DELETE /process_graphs/{process_graph_id}")])]),t._v(" "),s("td",[s("code",[t._v("deleteProcessGraph()")])])])])]),t._v(" "),s("h3",{attrs:{id:"scope-service-api-category"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scope-service-api-category"}},[t._v("#")]),t._v(" Scope: "),s("code",[t._v("Service")]),t._v(" (API category)")]),t._v(" "),s("p",[t._v("The "),s("code",[t._v("Service")]),t._v(" scope internally knows the "),s("code",[t._v("service_id")]),t._v(".")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Description")]),t._v(" "),s("th",[t._v("API Request")]),t._v(" "),s("th",[t._v("Client method")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("Get (and update on client-side) all information about a secondary web service.")]),t._v(" "),s("td",[s("code",[t._v("GET /services/{service_id}")])]),t._v(" "),s("td",[s("code",[t._v("describeService()")])])]),t._v(" "),s("tr",[s("td",[t._v("Modify a secondary web service at the back-end.")]),t._v(" "),s("td",[s("code",[t._v("PATCH /services/{service_id}")])]),t._v(" "),s("td",[s("code",[t._v("updateService(?processGraph, ?title, ?description, ?enabled, ?parameters, ?plan, ?budget)")])])]),t._v(" "),s("tr",[s("td",[t._v("Delete a secondary web service.")]),t._v(" "),s("td",[s("code",[t._v("DELETE /services/{service_id}")])]),t._v(" "),s("td",[s("code",[t._v("deleteService()")])])]),t._v(" "),s("tr",[s("td",[t._v("Get log file for web service.")]),t._v(" "),s("td",[s("code",[t._v("GET /services/{service_id}/logs")])]),t._v(" "),s("td",[s("code",[t._v("debugService()")])])])])]),t._v(" "),s("h2",{attrs:{id:"processes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#processes"}},[t._v("#")]),t._v(" Processes")]),t._v(" "),s("p",[t._v("The processes a back-end supports may be offered by the clients as methods in its own scope. The method names should follow the process names, but the conventions listed above can be applied here as well, e.g. converting "),s("code",[t._v("filter_bands")]),t._v(" to "),s("code",[t._v("filterBands")]),t._v(". As parameters have no natural or technical ordering in the JSON objects, clients must come up with a reasonable ordering of parameters if required. This could be inspired by existing clients. The way of building a process graph from processes heavily depends on the technical capabilities of the programming language. Therefore it may differ between the client libraries. Follow the best practices of the programming language, e.g. support method chaining if possible.")]),t._v(" "),s("h2",{attrs:{id:"workflow-example"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#workflow-example"}},[t._v("#")]),t._v(" Workflow example")]),t._v(" "),s("p",[t._v("Some simplified example workflows using different programming styles are listed below. The following steps are executed:")]),t._v(" "),s("ol",[s("li",[t._v("Loading the client library.")]),t._v(" "),s("li",[t._v("Connecting to a back-end and authenticating with username and password via OpenID Connect.")]),t._v(" "),s("li",[t._v("Requesting the capabilities and showing the implemented openEO version of the back-end.")]),t._v(" "),s("li",[t._v('Showing information about the "Sentinel-2A" collection.')]),t._v(" "),s("li",[t._v("Showing information about all processes supported by the back-end.")]),t._v(" "),s("li",[t._v("Building a simple process graph.")]),t._v(" "),s("li",[t._v("Creating a job.")]),t._v(" "),s("li",[t._v("Pushing the job to the processing queue.")]),t._v(" "),s("li",[t._v("After a while, showing the job details, e.g. checking the job status.")]),t._v(" "),s("li",[t._v("Once processing is finished, downloading the job results to the local directory "),s("code",[t._v("/tmp/job_results/")]),t._v(".")])]),t._v(" "),s("p",[t._v("Please note that the examples below do not comply to the latest process specification. They are meant to show the differences in client development, but are no working examples!")]),t._v(" "),s("h3",{attrs:{id:"r-functional-style"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#r-functional-style"}},[t._v("#")]),t._v(" R (functional style)")]),t._v(" "),s("div",{staticClass:"language-r extra-class"},[s("pre",{pre:!0,attrs:{class:"language-r"}},[s("code",[t._v("library"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("openeo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\ncon "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" connect"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"username"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"password"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ncap "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" capabilities"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ncap "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v(" apiVersion"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ncon "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v(" describeCollection"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ncon "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v(" listProcesses"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\nprocessgraph "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"load_collection"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" id "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v(" \n process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"filter_bbox"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" west "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("672000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" south "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5181000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" east "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("652000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" north "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5161000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" crs "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"EPSG:32632"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v("\n process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"filter_temporal"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" extent "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" c"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-01-01T00:00:00Z"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-01-31T23:59:59Z"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v("\n process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ndvi"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" nir "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B4"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" red "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B8A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v("\n process"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"min_time"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\njob "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v(" createJob"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("processgraph"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\njob "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v(" startJob"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\njob "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v(" describeJob"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\njob "),s("span",{pre:!0,attrs:{class:"token percent-operator operator"}},[t._v("%>%")]),t._v(" downloadResults"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"/tmp/job_results/"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("h3",{attrs:{id:"python-mixed-style"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#python-mixed-style"}},[t._v("#")]),t._v(" Python (mixed style)")]),t._v(" "),s("div",{staticClass:"language-python extra-class"},[s("pre",{pre:!0,attrs:{class:"language-python"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" openeo\n\ncon "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" openeo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("connect"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"username"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"password"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ncap "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("capabilities"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("print")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cap"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("api_version"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("print")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("describe_collection"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("print")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("list_processes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\nprocesses "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("get_processes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\npg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" processes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("load_collection"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token builtin"}},[t._v("id")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\npg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" processes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("filter_bbox"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("pg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" west"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("672000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" south"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5181000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" east"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("652000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" north"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5161000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" crs"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"EPSG:32632"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\npg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" processes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("filter_temporal"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("pg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" extent"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-01-01T00:00:00Z"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2017-01-31T23:59:59Z"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\npg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" processes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("ndvi"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("pg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" nir"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B4"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" red"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"B8A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\npg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" processes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("min_time"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("pg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\njob "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("create_job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("pg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("graph"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\njob"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("start_job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("print")]),t._v(" job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("describe_job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\njob"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("download_results"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"/tmp/job_results/"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("h3",{attrs:{id:"java-object-oriented-style"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#java-object-oriented-style"}},[t._v("#")]),t._v(" Java (object oriented style)")]),t._v(" "),s("div",{staticClass:"language-java extra-class"},[s("pre",{pre:!0,attrs:{class:"language-java"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token import"}},[s("span",{pre:!0,attrs:{class:"token namespace"}},[t._v("org"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("openeo"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")])]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),t._v(" obj "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Connection")]),t._v(" con "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" obj"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("connect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"username"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"password"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Capabilities")]),t._v(" cap "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("capabilities")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("System")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("out"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("println")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cap"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("apiVersion")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("System")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("out"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("println")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("describeCollection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("System")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("out"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("println")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("listProcesses")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ProcessGraphBuilder")]),t._v(" pgb "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getProcessGraphBuilder")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Chain processes...")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ProcessGraph")]),t._v(" processGraph "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" pgb"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildProcessGraph")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Job")]),t._v(" job "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createJob")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("processGraph"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\njob"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("startJob")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("System")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("out"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("println")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("describeJob")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\njob"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("downloadResults")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"/tmp/job_results/"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"php-procedural-style"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#php-procedural-style"}},[t._v("#")]),t._v(" PHP (procedural style)")]),t._v(" "),s("div",{staticClass:"language-php extra-class"},[s("pre",{pre:!0,attrs:{class:"language-php"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("require_once")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"/path/to/openeo.php"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_connect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"http://openeo.org"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"username"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"password"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$capabilities")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_capabilities")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_api_version")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$capabilites")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_describe_collection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"Sentinel-2A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_list_processes")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_process")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"load_collection"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"id"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"Sentinel-2A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_process")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"filter_bbox"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"west"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("672000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"south"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5181000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"east"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("652000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"north"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5161000")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"crs"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"EPSG:32632"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_process")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"filter_temporal"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"extent"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"2017-01-01T00:00:00Z"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"2017-01-31T23:59:59Z"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_process")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"ndvi"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"red"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"B4"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"nir"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"B8A"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_process")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"min_time"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$job")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_create_job")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$pg")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_start_job")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$job")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_describe_job")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$job")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_download_results")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$job")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"/tmp/job_results/"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/67.be1c4cca.js b/assets/js/67.da5790f3.js similarity index 99% rename from assets/js/67.be1c4cca.js rename to assets/js/67.da5790f3.js index f59b0ec6e..f794d4c69 100644 --- a/assets/js/67.be1c4cca.js +++ b/assets/js/67.da5790f3.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[67],{505:function(e,t,s){"use strict";s.r(t);var a=s(4),n=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"examples-proof-of-concept"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#examples-proof-of-concept"}},[e._v("#")]),e._v(" Examples (proof of concept)")]),e._v(" "),t("p",[e._v("This page gives a detailed description of the openEO proof of concept use cases. After the proof of concept, this stays in the API to have some basic examples. The proof of concept covered three clearly defined example use cases and how they are translated to sequences of API calls:")]),e._v(" "),t("ol",[t("li",[t("a",{attrs:{href:"#use-case-1"}},[e._v("Deriving minimum NDVI measurements over pixel time series of Sentinel 2 imagery")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#use-case-2"}},[e._v("Create a monthly aggregated Sentinel 1 product from a custom Python script")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#use-case-3"}},[e._v("Compute time series of zonal (regional) statistics of Sentinel 2 imagery over user-specified polygons")])])]),e._v(" "),t("p",[t("strong",[e._v("Note")]),e._v(": "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/api/"}},[e._v("CORS")]),e._v(" and authentication is not included in these examples for simplicity.\nRepeating calls are also not included as it would not make much sense to list the same discovery requests (see Use Case 1, requests 1 to 6) for each use case individually.")],1),e._v(" "),t("h2",{attrs:{id:"use-case-1"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#use-case-1"}},[e._v("#")]),e._v(" Use Case 1")]),e._v(" "),t("p",[e._v("Deriving minimum NDVI measurements over pixel time series of Sentinel 2 imagery.")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/tree/0.4.2/examples/evi",target:"_blank",rel:"noopener noreferrer"}},[e._v("A similar example (computing an EVI) is also available."),t("OutboundLink")],1)]),e._v(" "),t("ol",[t("li",[t("p",[t("strong",[e._v("Requesting the API versions available at the back-end")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[e._v("GET /.well-known/openeo\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Requesting the capabilities of the back-end")])]),e._v(" "),t("p",[t("em",[e._v("Note:")]),e._v(" The actual request path depends on the response of the previous request.")]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[e._v("GET /\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Check which collections are available at the back-end")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("GET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/collections")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Request details about a specific collection")]),e._v(" (e.g. Sentinel 2)")]),e._v(" "),t("p",[t("em",[e._v("Note:")]),e._v(" The actual collection ID in the path depends on the response of the previous request.")]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("GET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/collections/Sentinel-2")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Check that needed processes are available")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("GET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/processes")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Request the supported secondary web service types")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("GET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/service_types")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Create a WMS service")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("POST")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/services")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Content-Type")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("application/json; charset=utf-8")])]),e._v('\n\n{\n "title": "Min. NDVI for Sentinel 2",\n "description": "Deriving minimum NDVI measurements over pixel time series of Sentinel 2 imagery.",\n "process_graph": {\n "loadco1": {\n "process_id": "load_collection",\n "arguments": {\n "id": "Sentinel-2",\n "spatial_extent": {\n "west": {"variable_id": "spatial_extent_west"},\n "east": {"variable_id": "spatial_extent_east"},\n "north": {"variable_id": "spatial_extent_north"},\n "south": {"variable_id": "spatial_extent_south"}\n },\n "temporal_extent": ["2017-01-01", "2017-02-01"]\n }\n },\n "ndvi1": {\n "process_id": "ndvi",\n "arguments": {\n "data": {"from_node": "loadco1"}\n }\n },\n "reduce1": {\n "process_id": "reduce",\n "arguments": {\n "data": {"from_node": "ndvi1"},\n "dimension": "temporal",\n "reducer": {\n "callback": {\n "min1": {\n "process_id": "min",\n "arguments": {\n "data": {"from_argument": "data"}\n },\n "result": true\n }\n }\n }\n },\n "result": true\n }\n },\n "type": "WMS",\n "parameters": {\n "version": "1.1.1"\n }\n}\n')])])]),t("p",[t("em",[e._v("Response")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token response-status"}},[t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token status-code number"}},[e._v("201")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token reason-phrase string"}},[e._v("Created")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Location")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("/services/wms-a3cca9")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("OpenEO-Identifier")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("wms-a3cca9")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Requesting the service information")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("GET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/services/wms-a3cca9")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Download the data on demand from the WMS")])]),e._v(" "),t("p",[e._v("Omitted, not part of the openEO API.")])])]),e._v(" "),t("h2",{attrs:{id:"use-case-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#use-case-2"}},[e._v("#")]),e._v(" Use Case 2")]),e._v(" "),t("p",[e._v("Create a monthly aggregated Sentinel 1 product from a custom Python script.")]),e._v(" "),t("ol",[t("li",[t("p",[t("strong",[e._v("Upload python script")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("PUT")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/files/john_doe/s1_aggregate.py")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Content-Type")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("application/octet-stream")])]),e._v("\n\n\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Create a batch job")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("POST")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/jobs")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Content-Type")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("application/json; charset=utf-8")])]),e._v('\n\n{\n "title": "Monthly aggregation on Sentinel 1",\n "description": "Create a monthly aggregated Sentinel 1 product from a custom Python script.",\n "process_graph": {\n "loadco1": {\n "process_id": "load_collection",\n "arguments": {\n "id": "Sentinel-1",\n "spatial_extent": {\n "west": 16.1,\n "east": 16.6,\n "north": 48.6,\n "south": 47.2\n },\n "temporal_extent": ["2017-01-01", "2017-02-01"]\n }\n },\n "reduce1": {\n "process_id": "reduce",\n "arguments": {\n "data": {"from_node": "loadco1"},\n "dimension": "temporal",\n "reducer": {\n "callback": {\n "runudf1": {\n "process_id": "run_udf",\n "arguments": {\n "data": [\n {"from_argument": "x"},\n {"from_argument": "y"}\n ],\n "udf": "s1_aggregate.py",\n "runtime": "Python"\n },\n "result": true\n }\n }\n },\n "binary": true\n },\n "result": true\n }\n }\n}\n')])])]),t("p",[t("em",[e._v("Response")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token response-status"}},[t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token status-code number"}},[e._v("201")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token reason-phrase string"}},[e._v("Created")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Location")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("https://openeo.org/api/v0.4/jobs/132")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("OpenEO-Identifier")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("132")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Start batch processing the job")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("POST")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/jobs/132/results")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Create a TMS service")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("POST")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/services")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Content-Type")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("application/json; charset=utf-8")])]),e._v('\n\n{\n "title": "Monthly aggregation on Sentinel 1",\n "description": "Create a monthly aggregated Sentinel 1 product from a custom Python script.",\n "process_graph": {\n "1": {\n "process_id": "load_result",\n "arguments": {\n "id": "132"\n },\n "result": true\n }\n },\n "type": "TMS"\n}\n')])])]),t("p",[t("em",[e._v("Response")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token response-status"}},[t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token status-code number"}},[e._v("201")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token reason-phrase string"}},[e._v("Created")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Location")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("https://openeo.org/api/v0.4/services/tms-75ff8c")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("OpenEO-Identifier")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("tms-75ff8c")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Requesting the service information")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("GET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("https://openeo.org/api/v0.4/services/tms-75ff8c")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Download the data on demand from the WMS")])]),e._v(" "),t("p",[e._v("Omitted, not part of the openEO API.")])])]),e._v(" "),t("h2",{attrs:{id:"use-case-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#use-case-3"}},[e._v("#")]),e._v(" Use Case 3")]),e._v(" "),t("p",[e._v("Compute time series of zonal (regional) statistics of Sentinel 2 imagery over user-specified polygons.")]),e._v(" "),t("ol",[t("li",[t("p",[t("strong",[e._v("Create a batch job")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("POST")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/jobs")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Content-Type")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("application/json; charset=utf-8")])]),e._v('\n\n{\n "title": "Zonal Statistics / Sentinel 2",\n "description": "Compute time series of zonal (regional) statistics of Sentinel 2 imagery over user-specified polygons.",\n "process_graph": {\n "loadco1": {\n "process_id": "load_collection",\n "arguments": {\n "id": "Sentinel-2",\n "spatial_extent": {\n "west": 16.1,\n "east": 16.6,\n "north": 48.6,\n "south": 47.2\n },\n "temporal_extent": ["2017-01-01", "2017-02-01"],\n "bands": ["B8"]\n }\n },\n "reduce1": {\n "process_id": "reduce",\n "arguments": {\n "data": {"from_node": "loadco1"},\n "dimension": "spectral"\n }\n },\n "aggreg1": {\n "process_id": "aggregate_polygon",\n "arguments": {\n "data": {"from_node": "reduce1"},\n "polygons": {\n "type": "Polygon",\n "coordinates": [\n [\n [16.138916,48.320647],\n [16.524124,48.320647],\n [16.524124,48.1386],\n [16.138916,48.1386],\n [16.138916,48.320647]\n ]\n ]\n },\n "reducer": {\n "callback": {\n "mean1": {\n "process_id": "mean",\n "arguments": {\n "data": {"from_argument": "data"}\n },\n "result": true\n }\n }\n }\n }\n },\n "savere1": {\n "process_id": "save_result",\n "arguments": {\n "data": {"from_node": "aggreg1"},\n "format": "JSON"\n },\n "result": true\n }\n }\n}\n')])])]),t("p",[t("em",[e._v("Response")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token response-status"}},[t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token status-code number"}},[e._v("201")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token reason-phrase string"}},[e._v("Created")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Location")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("https://openeo.org/jobs/133")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("OpenEO-Identifier")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("133")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Start batch processing the job")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("POST")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/jobs/133/results")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Retrieve download links")]),e._v(" (after the job has finished)")]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("GET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/jobs/133/results")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])]),t("p",[t("em",[e._v("Response")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token response-status"}},[t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token status-code number"}},[e._v("200")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token reason-phrase string"}},[e._v("OK")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Content-Type")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("application/json; charset=utf-8")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Expires")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("Wed, 01 May 2019 00:00:00 GMT")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("OpenEO-Costs")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("0")])]),e._v('\n\n{\n "id":"133",\n "title":"Zonal Statistics / Sentinel 2",\n "description":"Compute time series of zonal (regional) statistics of Sentinel 2 imagery over user-specified polygons.",\n "updated": "2019-02-01T09:36:18Z",\n "links": [\n {\n "href": "https://cdn.openeo.org/4854b51643548ab8a858e2b8282711d8/result.json",\n "type": "application/json"\n }\n ]\n}\n')])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Download file(s)")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("GET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("https://cdn.openeo.org/4854b51643548ab8a858e2b8282711d8/result.json")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])]),t("p",[t("em",[e._v("Response")])]),e._v(" "),t("p",[e._v("A JSON file containing the results, content omitted.")])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[67],{511:function(e,t,s){"use strict";s.r(t);var a=s(4),n=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"examples-proof-of-concept"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#examples-proof-of-concept"}},[e._v("#")]),e._v(" Examples (proof of concept)")]),e._v(" "),t("p",[e._v("This page gives a detailed description of the openEO proof of concept use cases. After the proof of concept, this stays in the API to have some basic examples. The proof of concept covered three clearly defined example use cases and how they are translated to sequences of API calls:")]),e._v(" "),t("ol",[t("li",[t("a",{attrs:{href:"#use-case-1"}},[e._v("Deriving minimum NDVI measurements over pixel time series of Sentinel 2 imagery")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#use-case-2"}},[e._v("Create a monthly aggregated Sentinel 1 product from a custom Python script")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#use-case-3"}},[e._v("Compute time series of zonal (regional) statistics of Sentinel 2 imagery over user-specified polygons")])])]),e._v(" "),t("p",[t("strong",[e._v("Note")]),e._v(": "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/api/"}},[e._v("CORS")]),e._v(" and authentication is not included in these examples for simplicity.\nRepeating calls are also not included as it would not make much sense to list the same discovery requests (see Use Case 1, requests 1 to 6) for each use case individually.")],1),e._v(" "),t("h2",{attrs:{id:"use-case-1"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#use-case-1"}},[e._v("#")]),e._v(" Use Case 1")]),e._v(" "),t("p",[e._v("Deriving minimum NDVI measurements over pixel time series of Sentinel 2 imagery.")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/tree/0.4.2/examples/evi",target:"_blank",rel:"noopener noreferrer"}},[e._v("A similar example (computing an EVI) is also available."),t("OutboundLink")],1)]),e._v(" "),t("ol",[t("li",[t("p",[t("strong",[e._v("Requesting the API versions available at the back-end")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[e._v("GET /.well-known/openeo\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Requesting the capabilities of the back-end")])]),e._v(" "),t("p",[t("em",[e._v("Note:")]),e._v(" The actual request path depends on the response of the previous request.")]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[e._v("GET /\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Check which collections are available at the back-end")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("GET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/collections")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Request details about a specific collection")]),e._v(" (e.g. Sentinel 2)")]),e._v(" "),t("p",[t("em",[e._v("Note:")]),e._v(" The actual collection ID in the path depends on the response of the previous request.")]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("GET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/collections/Sentinel-2")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Check that needed processes are available")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("GET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/processes")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Request the supported secondary web service types")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("GET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/service_types")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Create a WMS service")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("POST")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/services")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Content-Type")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("application/json; charset=utf-8")])]),e._v('\n\n{\n "title": "Min. NDVI for Sentinel 2",\n "description": "Deriving minimum NDVI measurements over pixel time series of Sentinel 2 imagery.",\n "process_graph": {\n "loadco1": {\n "process_id": "load_collection",\n "arguments": {\n "id": "Sentinel-2",\n "spatial_extent": {\n "west": {"variable_id": "spatial_extent_west"},\n "east": {"variable_id": "spatial_extent_east"},\n "north": {"variable_id": "spatial_extent_north"},\n "south": {"variable_id": "spatial_extent_south"}\n },\n "temporal_extent": ["2017-01-01", "2017-02-01"]\n }\n },\n "ndvi1": {\n "process_id": "ndvi",\n "arguments": {\n "data": {"from_node": "loadco1"}\n }\n },\n "reduce1": {\n "process_id": "reduce",\n "arguments": {\n "data": {"from_node": "ndvi1"},\n "dimension": "temporal",\n "reducer": {\n "callback": {\n "min1": {\n "process_id": "min",\n "arguments": {\n "data": {"from_argument": "data"}\n },\n "result": true\n }\n }\n }\n },\n "result": true\n }\n },\n "type": "WMS",\n "parameters": {\n "version": "1.1.1"\n }\n}\n')])])]),t("p",[t("em",[e._v("Response")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token response-status"}},[t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token status-code number"}},[e._v("201")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token reason-phrase string"}},[e._v("Created")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Location")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("/services/wms-a3cca9")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("OpenEO-Identifier")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("wms-a3cca9")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Requesting the service information")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("GET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/services/wms-a3cca9")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Download the data on demand from the WMS")])]),e._v(" "),t("p",[e._v("Omitted, not part of the openEO API.")])])]),e._v(" "),t("h2",{attrs:{id:"use-case-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#use-case-2"}},[e._v("#")]),e._v(" Use Case 2")]),e._v(" "),t("p",[e._v("Create a monthly aggregated Sentinel 1 product from a custom Python script.")]),e._v(" "),t("ol",[t("li",[t("p",[t("strong",[e._v("Upload python script")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("PUT")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/files/john_doe/s1_aggregate.py")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Content-Type")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("application/octet-stream")])]),e._v("\n\n\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Create a batch job")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("POST")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/jobs")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Content-Type")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("application/json; charset=utf-8")])]),e._v('\n\n{\n "title": "Monthly aggregation on Sentinel 1",\n "description": "Create a monthly aggregated Sentinel 1 product from a custom Python script.",\n "process_graph": {\n "loadco1": {\n "process_id": "load_collection",\n "arguments": {\n "id": "Sentinel-1",\n "spatial_extent": {\n "west": 16.1,\n "east": 16.6,\n "north": 48.6,\n "south": 47.2\n },\n "temporal_extent": ["2017-01-01", "2017-02-01"]\n }\n },\n "reduce1": {\n "process_id": "reduce",\n "arguments": {\n "data": {"from_node": "loadco1"},\n "dimension": "temporal",\n "reducer": {\n "callback": {\n "runudf1": {\n "process_id": "run_udf",\n "arguments": {\n "data": [\n {"from_argument": "x"},\n {"from_argument": "y"}\n ],\n "udf": "s1_aggregate.py",\n "runtime": "Python"\n },\n "result": true\n }\n }\n },\n "binary": true\n },\n "result": true\n }\n }\n}\n')])])]),t("p",[t("em",[e._v("Response")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token response-status"}},[t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token status-code number"}},[e._v("201")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token reason-phrase string"}},[e._v("Created")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Location")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("https://openeo.org/api/v0.4/jobs/132")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("OpenEO-Identifier")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("132")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Start batch processing the job")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("POST")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/jobs/132/results")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Create a TMS service")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("POST")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/services")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Content-Type")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("application/json; charset=utf-8")])]),e._v('\n\n{\n "title": "Monthly aggregation on Sentinel 1",\n "description": "Create a monthly aggregated Sentinel 1 product from a custom Python script.",\n "process_graph": {\n "1": {\n "process_id": "load_result",\n "arguments": {\n "id": "132"\n },\n "result": true\n }\n },\n "type": "TMS"\n}\n')])])]),t("p",[t("em",[e._v("Response")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token response-status"}},[t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token status-code number"}},[e._v("201")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token reason-phrase string"}},[e._v("Created")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Location")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("https://openeo.org/api/v0.4/services/tms-75ff8c")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("OpenEO-Identifier")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("tms-75ff8c")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Requesting the service information")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("GET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("https://openeo.org/api/v0.4/services/tms-75ff8c")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Download the data on demand from the WMS")])]),e._v(" "),t("p",[e._v("Omitted, not part of the openEO API.")])])]),e._v(" "),t("h2",{attrs:{id:"use-case-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#use-case-3"}},[e._v("#")]),e._v(" Use Case 3")]),e._v(" "),t("p",[e._v("Compute time series of zonal (regional) statistics of Sentinel 2 imagery over user-specified polygons.")]),e._v(" "),t("ol",[t("li",[t("p",[t("strong",[e._v("Create a batch job")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("POST")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/jobs")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Content-Type")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("application/json; charset=utf-8")])]),e._v('\n\n{\n "title": "Zonal Statistics / Sentinel 2",\n "description": "Compute time series of zonal (regional) statistics of Sentinel 2 imagery over user-specified polygons.",\n "process_graph": {\n "loadco1": {\n "process_id": "load_collection",\n "arguments": {\n "id": "Sentinel-2",\n "spatial_extent": {\n "west": 16.1,\n "east": 16.6,\n "north": 48.6,\n "south": 47.2\n },\n "temporal_extent": ["2017-01-01", "2017-02-01"],\n "bands": ["B8"]\n }\n },\n "reduce1": {\n "process_id": "reduce",\n "arguments": {\n "data": {"from_node": "loadco1"},\n "dimension": "spectral"\n }\n },\n "aggreg1": {\n "process_id": "aggregate_polygon",\n "arguments": {\n "data": {"from_node": "reduce1"},\n "polygons": {\n "type": "Polygon",\n "coordinates": [\n [\n [16.138916,48.320647],\n [16.524124,48.320647],\n [16.524124,48.1386],\n [16.138916,48.1386],\n [16.138916,48.320647]\n ]\n ]\n },\n "reducer": {\n "callback": {\n "mean1": {\n "process_id": "mean",\n "arguments": {\n "data": {"from_argument": "data"}\n },\n "result": true\n }\n }\n }\n }\n },\n "savere1": {\n "process_id": "save_result",\n "arguments": {\n "data": {"from_node": "aggreg1"},\n "format": "JSON"\n },\n "result": true\n }\n }\n}\n')])])]),t("p",[t("em",[e._v("Response")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token response-status"}},[t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token status-code number"}},[e._v("201")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token reason-phrase string"}},[e._v("Created")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Location")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("https://openeo.org/jobs/133")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("OpenEO-Identifier")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("133")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Start batch processing the job")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("POST")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/jobs/133/results")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Retrieve download links")]),e._v(" (after the job has finished)")]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("GET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("/jobs/133/results")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])]),t("p",[t("em",[e._v("Response")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token response-status"}},[t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token status-code number"}},[e._v("200")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token reason-phrase string"}},[e._v("OK")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Content-Type")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("application/json; charset=utf-8")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("Expires")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("Wed, 01 May 2019 00:00:00 GMT")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token header"}},[t("span",{pre:!0,attrs:{class:"token header-name keyword"}},[e._v("OpenEO-Costs")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token header-value"}},[e._v("0")])]),e._v('\n\n{\n "id":"133",\n "title":"Zonal Statistics / Sentinel 2",\n "description":"Compute time series of zonal (regional) statistics of Sentinel 2 imagery over user-specified polygons.",\n "updated": "2019-02-01T09:36:18Z",\n "links": [\n {\n "href": "https://cdn.openeo.org/4854b51643548ab8a858e2b8282711d8/result.json",\n "type": "application/json"\n }\n ]\n}\n')])])])]),e._v(" "),t("li",[t("p",[t("strong",[e._v("Download file(s)")])]),e._v(" "),t("p",[t("em",[e._v("Request")])]),e._v(" "),t("div",{staticClass:"language-http extra-class"},[t("pre",{pre:!0,attrs:{class:"language-http"}},[t("code",[t("span",{pre:!0,attrs:{class:"token request-line"}},[t("span",{pre:!0,attrs:{class:"token method property"}},[e._v("GET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token request-target url"}},[e._v("https://cdn.openeo.org/4854b51643548ab8a858e2b8282711d8/result.json")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token http-version property"}},[e._v("HTTP/1.1")])]),e._v("\n")])])]),t("p",[t("em",[e._v("Response")])]),e._v(" "),t("p",[e._v("A JSON file containing the results, content omitted.")])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/68.422382f4.js b/assets/js/68.be66aa05.js similarity index 97% rename from assets/js/68.422382f4.js rename to assets/js/68.be66aa05.js index 511002075..e41346f04 100644 --- a/assets/js/68.422382f4.js +++ b/assets/js/68.be66aa05.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[68],{506:function(e,t,r){"use strict";r.r(t);var n=r(4),o=Object(n.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"getting-started-for-users"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getting-started-for-users"}},[e._v("#")]),e._v(" Getting started for users")]),e._v(" "),t("p",[e._v("Currently, there are three official client libraries, a web-based interface for openEO and a QGIS plugin.")]),e._v(" "),t("p",[e._v("If you are "),t("strong",[e._v("unfamiliar")]),e._v(" with programming, you could start using the "),t("a",{attrs:{href:"https://editor.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("web-based editor for openEO"),t("OutboundLink")],1),e._v(". It supports visual modelling of your algorithms and a simplified JavaScript based access to the openEO workflows and providers. openEO can also be used in QGIS through a "),t("a",{attrs:{href:"https://plugins.qgis.org/plugins/openeo-qgis-plugin-master/",target:"_blank",rel:"noopener noreferrer"}},[e._v("QGIS plugin"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("If you are "),t("strong",[e._v("familiar")]),e._v(" with programming, you could choose a client library for three programming languages:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://www.npmjs.com/package/@openeo/js-client",target:"_blank",rel:"noopener noreferrer"}},[e._v("JavaScript"),t("OutboundLink")],1),e._v(" (client-side and server-side)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://pypi.org/project/openeo/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Python"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client",target:"_blank",rel:"noopener noreferrer"}},[e._v("R"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Follow the links above to find usage instructions for each of the client libraries.")]),e._v(" "),t("h2",{attrs:{id:"contribute"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#contribute"}},[e._v("#")]),e._v(" Contribute")]),e._v(" "),t("p",[e._v("Didn't find your programming language? You can also access the "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/api/reference.html"}},[e._v("openEO API")]),e._v(" implementations directly or start "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/clients/getting-started.html"}},[e._v("implementing your own client library")]),e._v(".")],1),e._v(" "),t("p",[e._v("If you are missing any functionality in the API feel free to "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("open an issue"),t("OutboundLink")],1),e._v(" or actively start proposing API changes as Pull Requests.")]),e._v(" "),t("p",[e._v("Feel free to contact us for further assistance.")])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[68],{505:function(e,t,r){"use strict";r.r(t);var n=r(4),o=Object(n.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"getting-started-for-users"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getting-started-for-users"}},[e._v("#")]),e._v(" Getting started for users")]),e._v(" "),t("p",[e._v("Currently, there are three official client libraries, a web-based interface for openEO and a QGIS plugin.")]),e._v(" "),t("p",[e._v("If you are "),t("strong",[e._v("unfamiliar")]),e._v(" with programming, you could start using the "),t("a",{attrs:{href:"https://editor.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("web-based editor for openEO"),t("OutboundLink")],1),e._v(". It supports visual modelling of your algorithms and a simplified JavaScript based access to the openEO workflows and providers. openEO can also be used in QGIS through a "),t("a",{attrs:{href:"https://plugins.qgis.org/plugins/openeo-qgis-plugin-master/",target:"_blank",rel:"noopener noreferrer"}},[e._v("QGIS plugin"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("If you are "),t("strong",[e._v("familiar")]),e._v(" with programming, you could choose a client library for three programming languages:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://www.npmjs.com/package/@openeo/js-client",target:"_blank",rel:"noopener noreferrer"}},[e._v("JavaScript"),t("OutboundLink")],1),e._v(" (client-side and server-side)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://pypi.org/project/openeo/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Python"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/Open-EO/openeo-r-client",target:"_blank",rel:"noopener noreferrer"}},[e._v("R"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("Follow the links above to find usage instructions for each of the client libraries.")]),e._v(" "),t("h2",{attrs:{id:"contribute"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#contribute"}},[e._v("#")]),e._v(" Contribute")]),e._v(" "),t("p",[e._v("Didn't find your programming language? You can also access the "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/api/reference.html"}},[e._v("openEO API")]),e._v(" implementations directly or start "),t("RouterLink",{attrs:{to:"/documentation/0.4/developers/clients/getting-started.html"}},[e._v("implementing your own client library")]),e._v(".")],1),e._v(" "),t("p",[e._v("If you are missing any functionality in the API feel free to "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("open an issue"),t("OutboundLink")],1),e._v(" or actively start proposing API changes as Pull Requests.")]),e._v(" "),t("p",[e._v("Feel free to contact us for further assistance.")])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/69.b32248fb.js b/assets/js/69.e137d461.js similarity index 79% rename from assets/js/69.b32248fb.js rename to assets/js/69.e137d461.js index daa9a8e87..596f3b18a 100644 --- a/assets/js/69.b32248fb.js +++ b/assets/js/69.e137d461.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[69],{509:function(t,s,e){"use strict";e.r(s);var n=e(4),o=Object(n.a)({},(function(){var t=this._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("ProcessesSpec")],1)}),[],!1,null,null,null);s.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[69],{507:function(t,s,e){"use strict";e.r(s);var n=e(4),o=Object(n.a)({},(function(){var t=this._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("ProcessesSpec")],1)}),[],!1,null,null,null);s.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/71.5877cc88.js b/assets/js/71.add22aa1.js similarity index 98% rename from assets/js/71.5877cc88.js rename to assets/js/71.add22aa1.js index 07398a2aa..fa745d94f 100644 --- a/assets/js/71.5877cc88.js +++ b/assets/js/71.add22aa1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[71],{510:function(t,e,o){"use strict";o.r(e);var n=o(4),r=Object(n.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"introduction"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#introduction"}},[t._v("#")]),t._v(" Introduction")]),t._v(" "),e("p",[t._v("First of all, a good idea is to get familiar with the terminology in openEO by reading the "),e("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html"}},[t._v("glossary")]),t._v(".\nThere's also an in-depth "),e("RouterLink",{attrs:{to:"/documentation/1.0/datacubes.html"}},[t._v("introduction to datacubes")]),t._v(" and processing them with openEO.")],1),t._v(" "),e("p",[t._v("Currently, there are three official client libraries, a web-based interface for openEO and a QGIS plugin.")]),t._v(" "),e("p",[t._v("If you are "),e("strong",[t._v("unfamiliar")]),t._v(" with programming, you could start using the "),e("a",{attrs:{href:"https://editor.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[t._v("web-based editor for openEO"),e("OutboundLink")],1),t._v(". It supports visual modelling of your algorithms and a simplified JavaScript based access to the openEO workflows and providers. openEO can also be used in QGIS through a "),e("RouterLink",{attrs:{to:"/documentation/1.0/qgis/"}},[t._v("QGIS plugin")]),t._v(".")],1),t._v(" "),e("p",[t._v("If you are "),e("strong",[t._v("familiar")]),t._v(" with programming, you could choose a client library for three programming languages:")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/documentation/1.0/javascript/"}},[t._v("JavaScript")]),t._v(" (client-side and server-side)")],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/documentation/1.0/python/"}},[t._v("Python")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/documentation/1.0/r/"}},[t._v("R")])],1)]),t._v(" "),e("p",[t._v("Follow the links above to find usage instructions for each of the client libraries.")]),t._v(" "),e("p",[t._v("For details about available processes, see the "),e("strong",[e("RouterLink",{attrs:{to:"/documentation/1.0/processes.html"}},[t._v("list of openEO processes")])],1),t._v(". The "),e("strong",[e("RouterLink",{attrs:{to:"/documentation/1.0/cookbook/"}},[t._v("openEO Cookbook")])],1),t._v(" describes common use-cases with code examples in all three languages.")]),t._v(" "),e("p",[t._v("The more advanced topic to run your own code on back-ends, is explained in the introduction to "),e("RouterLink",{attrs:{to:"/documentation/1.0/udfs.html"}},[t._v("openEO UDFs (user-defined functions)")]),t._v(".")],1),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),e("p",[t._v("This is the documentation for the "),e("strong",[t._v("openEO API version 1.0")]),t._v(". If you are looking for other versions of openEO, please use the version switch at the top right of this page.")])]),t._v(" "),e("h2",{attrs:{id:"contribute"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#contribute"}},[t._v("#")]),t._v(" Contribute")]),t._v(" "),e("p",[t._v("Didn't find your programming language? You can also access the "),e("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html"}},[t._v("openEO API")]),t._v(" implementations directly or start "),e("RouterLink",{attrs:{to:"/documentation/1.0/developers/clients/getting-started.html"}},[t._v("implementing your own client library")]),t._v(".")],1),t._v(" "),e("p",[t._v("If you are missing any functionality in the API feel free to "),e("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/issues",target:"_blank",rel:"noopener noreferrer"}},[t._v("open an issue"),e("OutboundLink")],1),t._v(" or actively start proposing API changes as Pull Requests.")]),t._v(" "),e("p",[t._v("Feel free to contact us for further assistance.")])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[71],{509:function(t,e,o){"use strict";o.r(e);var n=o(4),r=Object(n.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"introduction"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#introduction"}},[t._v("#")]),t._v(" Introduction")]),t._v(" "),e("p",[t._v("First of all, a good idea is to get familiar with the terminology in openEO by reading the "),e("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html"}},[t._v("glossary")]),t._v(".\nThere's also an in-depth "),e("RouterLink",{attrs:{to:"/documentation/1.0/datacubes.html"}},[t._v("introduction to datacubes")]),t._v(" and processing them with openEO.")],1),t._v(" "),e("p",[t._v("Currently, there are three official client libraries, a web-based interface for openEO and a QGIS plugin.")]),t._v(" "),e("p",[t._v("If you are "),e("strong",[t._v("unfamiliar")]),t._v(" with programming, you could start using the "),e("a",{attrs:{href:"https://editor.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[t._v("web-based editor for openEO"),e("OutboundLink")],1),t._v(". It supports visual modelling of your algorithms and a simplified JavaScript based access to the openEO workflows and providers. openEO can also be used in QGIS through a "),e("RouterLink",{attrs:{to:"/documentation/1.0/qgis/"}},[t._v("QGIS plugin")]),t._v(".")],1),t._v(" "),e("p",[t._v("If you are "),e("strong",[t._v("familiar")]),t._v(" with programming, you could choose a client library for three programming languages:")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/documentation/1.0/javascript/"}},[t._v("JavaScript")]),t._v(" (client-side and server-side)")],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/documentation/1.0/python/"}},[t._v("Python")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/documentation/1.0/r/"}},[t._v("R")])],1)]),t._v(" "),e("p",[t._v("Follow the links above to find usage instructions for each of the client libraries.")]),t._v(" "),e("p",[t._v("For details about available processes, see the "),e("strong",[e("RouterLink",{attrs:{to:"/documentation/1.0/processes.html"}},[t._v("list of openEO processes")])],1),t._v(". The "),e("strong",[e("RouterLink",{attrs:{to:"/documentation/1.0/cookbook/"}},[t._v("openEO Cookbook")])],1),t._v(" describes common use-cases with code examples in all three languages.")]),t._v(" "),e("p",[t._v("The more advanced topic to run your own code on back-ends, is explained in the introduction to "),e("RouterLink",{attrs:{to:"/documentation/1.0/udfs.html"}},[t._v("openEO UDFs (user-defined functions)")]),t._v(".")],1),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),e("p",[t._v("This is the documentation for the "),e("strong",[t._v("openEO API version 1.0")]),t._v(". If you are looking for other versions of openEO, please use the version switch at the top right of this page.")])]),t._v(" "),e("h2",{attrs:{id:"contribute"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#contribute"}},[t._v("#")]),t._v(" Contribute")]),t._v(" "),e("p",[t._v("Didn't find your programming language? You can also access the "),e("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html"}},[t._v("openEO API")]),t._v(" implementations directly or start "),e("RouterLink",{attrs:{to:"/documentation/1.0/developers/clients/getting-started.html"}},[t._v("implementing your own client library")]),t._v(".")],1),t._v(" "),e("p",[t._v("If you are missing any functionality in the API feel free to "),e("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/issues",target:"_blank",rel:"noopener noreferrer"}},[t._v("open an issue"),e("OutboundLink")],1),t._v(" or actively start proposing API changes as Pull Requests.")]),t._v(" "),e("p",[t._v("Feel free to contact us for further assistance.")])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/72.03809523.js b/assets/js/72.28596c84.js similarity index 99% rename from assets/js/72.03809523.js rename to assets/js/72.28596c84.js index 1d6ebea80..c855d1eca 100644 --- a/assets/js/72.03809523.js +++ b/assets/js/72.28596c84.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[72],{511:function(e,t,o){"use strict";o.r(t);var n=o(4),i=Object(n.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"authentication"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#authentication"}},[e._v("#")]),e._v(" Authentication")]),e._v(" "),t("p",[e._v("While a couple of openEO operations can be done anonymously, most of the interesting parts of the API require you to identify as a registered user. openEO specifies two ways to authenticate as a user:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://en.wikipedia.org/wiki/OpenID_Connect",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenID Connect"),t("OutboundLink")],1),e._v(" (recommended, but not always straightforward to use)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://en.wikipedia.org/wiki/Basic_access_authentication",target:"_blank",rel:"noopener noreferrer"}},[e._v("HTTP Basic"),t("OutboundLink")],1),e._v(" (not recommended, but practically easier in some situations)")])]),e._v(" "),t("h2",{attrs:{id:"http-basic"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#http-basic"}},[e._v("#")]),e._v(" HTTP Basic")]),e._v(" "),t("p",[e._v("Let's start with the easiest authentication method, based on the HTTP Basic authentication scheme. It is however "),t("em",[e._v("not recommended")]),e._v(" for various reasons, such as its limited "),t("em",[e._v("security")]),e._v(" measures. For example, if you are connecting to a back-end with a "),t("code",[e._v("http://")]),e._v(" URL (unencrypted; discouraged in openEO) instead of a "),t("code",[e._v("https://")]),e._v(" one (encrypted), you should certainly not use HTTP Basic authentication.")]),e._v(" "),t("p",[e._v("With these security related caveats out of the way, you authenticate using your username and password. The clients usually have a "),t("code",[e._v("authenticate_basic")]),e._v(" method for this or graphical clients (e.g. QGIS and the Web Editor) will ask for your username and password directly.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Further Information")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-js-client/latest/BasicProvider.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("JS Client Documentation"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-python-client/auth.html#basic-http-auth",target:"_blank",rel:"noopener noreferrer"}},[e._v("Python Client Documentation"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/reference/BasicAuth.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("R Client Documentation"),t("OutboundLink")],1)])])]),e._v(" "),t("h2",{attrs:{id:"openid-connect"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#openid-connect"}},[e._v("#")]),e._v(" OpenID Connect")]),e._v(" "),t("p",[e._v("OpenID Connect (OIDC) is an identity layer on top of the OAuth 2.0 protocol. It is a quite an extensive stack of interacting actors and protocols, and an in-depth discussion of its architecture would lead us too far here. However, in the context of working with openEO, these OpenID Connect concepts are useful to understand:")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("There is "),t("strong",[e._v("decoupling")]),e._v(" between:")]),e._v(" "),t("ul",[t("li",[e._v("the "),t("em",[e._v("OpenID Connect identity provider")]),e._v(" (the platform that handles the authentication of the user)")]),e._v(" "),t("li",[e._v("the "),t("em",[e._v("openEO back-end")]),e._v(", which manages earth observation collections and executes your algorithms")])]),e._v(" "),t("p",[e._v("openEO back-ends can decide to host their own OpenID Connect infrastructure, but they may also allow to authenticate with an external OpenID Connect provider, which could be an organization like Google or Microsoft. This means that the back-end does not have to take care of all the security and privacy challenges of properly handling user registration, authentication, etc. Also, it allows the user to securely reuse an existing account registered with an established organization, instead of having to register yet another account with some web service.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Note")]),e._v(" "),t("p",[e._v("An openEO back-end might support "),t("strong",[e._v("multiple OpenID Connect providers")]),e._v(". If there is only one, the openEO client libraries will usually pick it automatically, but otherwise you may need to decide explicitly which provider to authenticate against.")])])]),e._v(" "),t("li",[t("p",[e._v("Your openEO script or application acts as a so called "),t("strong",[e._v("OpenID Connect client")]),e._v(", with an associated "),t("strong",[e._v("client ID")]),e._v(". This practically means that, apart from a user account, you need a client ID as well (and often a client secret too) when authenticating.")]),e._v(" "),t("p",[e._v("The details of how to obtain the client ID and secret largely depend on the back-end and OpenID Connect provider: you might have to register a client yourself, or you might have to use an existing client ID. Consult the openEO back-end (documentation) about how to obtain client ID (and secret).")])]),e._v(" "),t("li",[t("p",[e._v('There are several possible "'),t("strong",[e._v("flows")]),e._v('" (also called "grants") to complete the whole OpenID Connect authentication dance:')]),e._v(" "),t("ul",[t("li",[e._v("Authorization Code Flow")]),e._v(" "),t("li",[e._v("Device Flow")]),e._v(" "),t("li",[e._v("Client Credentials Flow")]),e._v(" "),t("li",[e._v("Resource Owner Password flow")]),e._v(" "),t("li",[e._v("Refresh Token Flow")])]),e._v(" "),t("p",[e._v("Picking the right flow highly depends on your use case and context: are you working interactively, are you working in a browser based environment, should your application be able to work without user interaction in the background, what does the OpenID Connect provider support, ...?")])])]),e._v(" "),t("p",[e._v("OpenID Connect is clearly more complex than HTTP Basic Authentication. In the sections below we will discuss the practical details of each flow.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Further Information")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-js-client/latest/OidcProvider.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("JS Client Documentation"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-python-client/auth.html#openid-connect-based-authentication",target:"_blank",rel:"noopener noreferrer"}},[e._v("Python Client Documentation"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/reference/OIDCAuth.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("R Client Documentation"),t("OutboundLink")],1)])])]),e._v(" "),t("h3",{attrs:{id:"authorization-code-flow"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#authorization-code-flow"}},[e._v("#")]),e._v(" Authorization Code Flow")]),e._v(" "),t("p",[e._v("This is the most popular and widely supported OpenID Connect flow in the general web development world. However, it requires an environment that can be hard to get right when using in other environments like a mobile app or a CLI (command line interface). Some prerequisites must be met:")]),e._v(" "),t("ul",[t("li",[e._v("You are working interactively (e.g. in a Jupyter notebook, in a Python or R shell or running a script manually)")]),e._v(" "),t("li",[e._v("You have access to a web browser (preferably on the same machine as your application), to authenticate with the OpenID Connect provider")]),e._v(" "),t("li",[e._v("The web browser has (network) access")]),e._v(" "),t("li",[e._v("A URL must be whitelisted in the OpenID client's \"redirect URL\" configuration at the OpenID Connect provider's side.")])]),e._v(" "),t("p",[e._v("For authentication, the client forwards a user to the log-in page of the OpenID Connect provider. There the user can log in with an existing account (or create a new one) and then generally has to explicitly grant access to basic profile information (e.g. email address) that the back-end will use to identify the user.")]),e._v(" "),t("h3",{attrs:{id:"device-flow"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#device-flow"}},[e._v("#")]),e._v(" Device Flow")]),e._v(" "),t("p",[e._v("The device flow (also called device authorization grant) is a relatively new OpenID Connect flow and it is not as widely supported across different OpenID Connect Providers as the other flows. It provides a nice alternative that is roughly comparable to the authorization code flow but without the previously mentioned issues related to short-living webservers, network access and browser redirects.")]),e._v(" "),t("p",[e._v("The device flow is only suited for interactive use cases and requires a web browser for the authentication with the OpenID Connect provider. However, it can be any web browser, even one on your mobile phone. There is no networking magic required to be able to access any short-living background webserver like with the authorization code flow.")]),e._v(" "),t("p",[e._v('The "magic" is that the client will show a message like this:')]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",[t("code",[e._v("To authenticate: visit https://provider.example.com/device\nand enter the user code 'DTNY-KLNX'.\n")])])]),t("p",[e._v("You should now visit this URL. Usually it is intentionally a short URL to make it feasible to type it instead of copy-pasting it (e.g. on another device). Authenticate with the OpenID Connect provider and enter the user code shown in the message. Meanwhile, the client library is usually actively polling the OpenID Connect provider and when you successfully complete the authentication and entering of the user code, it will receive the necessary tokens for authenticated communication with the back-end.")]),e._v(" "),t("h3",{attrs:{id:"client-credentials-flow"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#client-credentials-flow"}},[e._v("#")]),e._v(" Client Credentials Flow")]),e._v(" "),t("p",[e._v("The Client Credentials flow directly uses the client ID and secret to authenticate. It does not involve interactive authentication through a web browser, which makes it useful for "),t("strong",[e._v("non-interactive use cases")]),e._v(".")]),e._v(" "),t("p",[e._v("The downside is of the Client Credentials flow is that it can be challenging or even impossible with a given OpenID Connect provider, to set up a client that supports this. Also, your openEO back-end might not allow it, because technically you are authenticating a "),t("em",[e._v("client")]),e._v(", and not a "),t("em",[e._v("user")]),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"resource-owner-password-flow"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#resource-owner-password-flow"}},[e._v("#")]),e._v(" Resource Owner Password flow")]),e._v(" "),t("p",[e._v("With the Resource Owner Password flow you directly pass the user (and client) credentials. Like the Client Credentials flow, it is useful for "),t("strong",[e._v("non-interactive uses cases")]),e._v(".")]),e._v(" "),t("p",[e._v("However, usage of the Resource Owner Password flow is "),t("strong",[e._v("generally discouraged")]),e._v(" because of its poor security features (e.g. OAuth/OIDC was designed to avoid passing and storing user passwords unnecessarily). It is also not widely supported across OpenID Connect providers, probably due to its weak security measures.")]),e._v(" "),t("h3",{attrs:{id:"refresh-token-flow"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#refresh-token-flow"}},[e._v("#")]),e._v(" Refresh Token Flow")]),e._v(" "),t("p",[e._v("When OpenID Connect authentication completes successfully, the client receives an access token to be used when doing authenticated calls to the back-end. The access token usually has a short lifetime to reduce the security risk when it would be stolen or intercepted. The client also receives a "),t("em",[e._v("refresh token")]),e._v(" that can be used, through the Refresh Token flow, to easily request a new access token, without having to re-authenticate, which makes it useful for "),t("strong",[e._v("non-interactive uses cases")]),e._v(".")]),e._v(" "),t("p",[e._v("However, as it needs an existing refresh token, the Refresh Token Flow requires "),t("strong",[e._v("first to authenticate with one of the other flows")]),e._v(" (but in practice it might not be required very often because refresh tokens usually have a relatively long lifetime).")])])}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[72],{510:function(e,t,o){"use strict";o.r(t);var n=o(4),i=Object(n.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"authentication"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#authentication"}},[e._v("#")]),e._v(" Authentication")]),e._v(" "),t("p",[e._v("While a couple of openEO operations can be done anonymously, most of the interesting parts of the API require you to identify as a registered user. openEO specifies two ways to authenticate as a user:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://en.wikipedia.org/wiki/OpenID_Connect",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenID Connect"),t("OutboundLink")],1),e._v(" (recommended, but not always straightforward to use)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://en.wikipedia.org/wiki/Basic_access_authentication",target:"_blank",rel:"noopener noreferrer"}},[e._v("HTTP Basic"),t("OutboundLink")],1),e._v(" (not recommended, but practically easier in some situations)")])]),e._v(" "),t("h2",{attrs:{id:"http-basic"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#http-basic"}},[e._v("#")]),e._v(" HTTP Basic")]),e._v(" "),t("p",[e._v("Let's start with the easiest authentication method, based on the HTTP Basic authentication scheme. It is however "),t("em",[e._v("not recommended")]),e._v(" for various reasons, such as its limited "),t("em",[e._v("security")]),e._v(" measures. For example, if you are connecting to a back-end with a "),t("code",[e._v("http://")]),e._v(" URL (unencrypted; discouraged in openEO) instead of a "),t("code",[e._v("https://")]),e._v(" one (encrypted), you should certainly not use HTTP Basic authentication.")]),e._v(" "),t("p",[e._v("With these security related caveats out of the way, you authenticate using your username and password. The clients usually have a "),t("code",[e._v("authenticate_basic")]),e._v(" method for this or graphical clients (e.g. QGIS and the Web Editor) will ask for your username and password directly.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Further Information")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-js-client/latest/BasicProvider.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("JS Client Documentation"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-python-client/auth.html#basic-http-auth",target:"_blank",rel:"noopener noreferrer"}},[e._v("Python Client Documentation"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/reference/BasicAuth.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("R Client Documentation"),t("OutboundLink")],1)])])]),e._v(" "),t("h2",{attrs:{id:"openid-connect"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#openid-connect"}},[e._v("#")]),e._v(" OpenID Connect")]),e._v(" "),t("p",[e._v("OpenID Connect (OIDC) is an identity layer on top of the OAuth 2.0 protocol. It is a quite an extensive stack of interacting actors and protocols, and an in-depth discussion of its architecture would lead us too far here. However, in the context of working with openEO, these OpenID Connect concepts are useful to understand:")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("There is "),t("strong",[e._v("decoupling")]),e._v(" between:")]),e._v(" "),t("ul",[t("li",[e._v("the "),t("em",[e._v("OpenID Connect identity provider")]),e._v(" (the platform that handles the authentication of the user)")]),e._v(" "),t("li",[e._v("the "),t("em",[e._v("openEO back-end")]),e._v(", which manages earth observation collections and executes your algorithms")])]),e._v(" "),t("p",[e._v("openEO back-ends can decide to host their own OpenID Connect infrastructure, but they may also allow to authenticate with an external OpenID Connect provider, which could be an organization like Google or Microsoft. This means that the back-end does not have to take care of all the security and privacy challenges of properly handling user registration, authentication, etc. Also, it allows the user to securely reuse an existing account registered with an established organization, instead of having to register yet another account with some web service.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Note")]),e._v(" "),t("p",[e._v("An openEO back-end might support "),t("strong",[e._v("multiple OpenID Connect providers")]),e._v(". If there is only one, the openEO client libraries will usually pick it automatically, but otherwise you may need to decide explicitly which provider to authenticate against.")])])]),e._v(" "),t("li",[t("p",[e._v("Your openEO script or application acts as a so called "),t("strong",[e._v("OpenID Connect client")]),e._v(", with an associated "),t("strong",[e._v("client ID")]),e._v(". This practically means that, apart from a user account, you need a client ID as well (and often a client secret too) when authenticating.")]),e._v(" "),t("p",[e._v("The details of how to obtain the client ID and secret largely depend on the back-end and OpenID Connect provider: you might have to register a client yourself, or you might have to use an existing client ID. Consult the openEO back-end (documentation) about how to obtain client ID (and secret).")])]),e._v(" "),t("li",[t("p",[e._v('There are several possible "'),t("strong",[e._v("flows")]),e._v('" (also called "grants") to complete the whole OpenID Connect authentication dance:')]),e._v(" "),t("ul",[t("li",[e._v("Authorization Code Flow")]),e._v(" "),t("li",[e._v("Device Flow")]),e._v(" "),t("li",[e._v("Client Credentials Flow")]),e._v(" "),t("li",[e._v("Resource Owner Password flow")]),e._v(" "),t("li",[e._v("Refresh Token Flow")])]),e._v(" "),t("p",[e._v("Picking the right flow highly depends on your use case and context: are you working interactively, are you working in a browser based environment, should your application be able to work without user interaction in the background, what does the OpenID Connect provider support, ...?")])])]),e._v(" "),t("p",[e._v("OpenID Connect is clearly more complex than HTTP Basic Authentication. In the sections below we will discuss the practical details of each flow.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Further Information")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-js-client/latest/OidcProvider.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("JS Client Documentation"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-python-client/auth.html#openid-connect-based-authentication",target:"_blank",rel:"noopener noreferrer"}},[e._v("Python Client Documentation"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-r-client/reference/OIDCAuth.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("R Client Documentation"),t("OutboundLink")],1)])])]),e._v(" "),t("h3",{attrs:{id:"authorization-code-flow"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#authorization-code-flow"}},[e._v("#")]),e._v(" Authorization Code Flow")]),e._v(" "),t("p",[e._v("This is the most popular and widely supported OpenID Connect flow in the general web development world. However, it requires an environment that can be hard to get right when using in other environments like a mobile app or a CLI (command line interface). Some prerequisites must be met:")]),e._v(" "),t("ul",[t("li",[e._v("You are working interactively (e.g. in a Jupyter notebook, in a Python or R shell or running a script manually)")]),e._v(" "),t("li",[e._v("You have access to a web browser (preferably on the same machine as your application), to authenticate with the OpenID Connect provider")]),e._v(" "),t("li",[e._v("The web browser has (network) access")]),e._v(" "),t("li",[e._v("A URL must be whitelisted in the OpenID client's \"redirect URL\" configuration at the OpenID Connect provider's side.")])]),e._v(" "),t("p",[e._v("For authentication, the client forwards a user to the log-in page of the OpenID Connect provider. There the user can log in with an existing account (or create a new one) and then generally has to explicitly grant access to basic profile information (e.g. email address) that the back-end will use to identify the user.")]),e._v(" "),t("h3",{attrs:{id:"device-flow"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#device-flow"}},[e._v("#")]),e._v(" Device Flow")]),e._v(" "),t("p",[e._v("The device flow (also called device authorization grant) is a relatively new OpenID Connect flow and it is not as widely supported across different OpenID Connect Providers as the other flows. It provides a nice alternative that is roughly comparable to the authorization code flow but without the previously mentioned issues related to short-living webservers, network access and browser redirects.")]),e._v(" "),t("p",[e._v("The device flow is only suited for interactive use cases and requires a web browser for the authentication with the OpenID Connect provider. However, it can be any web browser, even one on your mobile phone. There is no networking magic required to be able to access any short-living background webserver like with the authorization code flow.")]),e._v(" "),t("p",[e._v('The "magic" is that the client will show a message like this:')]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",[t("code",[e._v("To authenticate: visit https://provider.example.com/device\nand enter the user code 'DTNY-KLNX'.\n")])])]),t("p",[e._v("You should now visit this URL. Usually it is intentionally a short URL to make it feasible to type it instead of copy-pasting it (e.g. on another device). Authenticate with the OpenID Connect provider and enter the user code shown in the message. Meanwhile, the client library is usually actively polling the OpenID Connect provider and when you successfully complete the authentication and entering of the user code, it will receive the necessary tokens for authenticated communication with the back-end.")]),e._v(" "),t("h3",{attrs:{id:"client-credentials-flow"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#client-credentials-flow"}},[e._v("#")]),e._v(" Client Credentials Flow")]),e._v(" "),t("p",[e._v("The Client Credentials flow directly uses the client ID and secret to authenticate. It does not involve interactive authentication through a web browser, which makes it useful for "),t("strong",[e._v("non-interactive use cases")]),e._v(".")]),e._v(" "),t("p",[e._v("The downside is of the Client Credentials flow is that it can be challenging or even impossible with a given OpenID Connect provider, to set up a client that supports this. Also, your openEO back-end might not allow it, because technically you are authenticating a "),t("em",[e._v("client")]),e._v(", and not a "),t("em",[e._v("user")]),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"resource-owner-password-flow"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#resource-owner-password-flow"}},[e._v("#")]),e._v(" Resource Owner Password flow")]),e._v(" "),t("p",[e._v("With the Resource Owner Password flow you directly pass the user (and client) credentials. Like the Client Credentials flow, it is useful for "),t("strong",[e._v("non-interactive uses cases")]),e._v(".")]),e._v(" "),t("p",[e._v("However, usage of the Resource Owner Password flow is "),t("strong",[e._v("generally discouraged")]),e._v(" because of its poor security features (e.g. OAuth/OIDC was designed to avoid passing and storing user passwords unnecessarily). It is also not widely supported across OpenID Connect providers, probably due to its weak security measures.")]),e._v(" "),t("h3",{attrs:{id:"refresh-token-flow"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#refresh-token-flow"}},[e._v("#")]),e._v(" Refresh Token Flow")]),e._v(" "),t("p",[e._v("When OpenID Connect authentication completes successfully, the client receives an access token to be used when doing authenticated calls to the back-end. The access token usually has a short lifetime to reduce the security risk when it would be stolen or intercepted. The client also receives a "),t("em",[e._v("refresh token")]),e._v(" that can be used, through the Refresh Token flow, to easily request a new access token, without having to re-authenticate, which makes it useful for "),t("strong",[e._v("non-interactive uses cases")]),e._v(".")]),e._v(" "),t("p",[e._v("However, as it needs an existing refresh token, the Refresh Token Flow requires "),t("strong",[e._v("first to authenticate with one of the other flows")]),e._v(" (but in practice it might not be required very often because refresh tokens usually have a relatively long lifetime).")])])}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file diff --git a/assets/js/74.aae63b43.js b/assets/js/74.7a85eb49.js similarity index 97% rename from assets/js/74.aae63b43.js rename to assets/js/74.7a85eb49.js index fcefa12e9..773b61387 100644 --- a/assets/js/74.aae63b43.js +++ b/assets/js/74.7a85eb49.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[74],{516:function(e,t,n){"use strict";n.r(t);var o=n(4),a=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"introduction"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#introduction"}},[e._v("#")]),e._v(" Introduction")]),e._v(" "),t("p",[e._v("The openEO API defines a "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html"}},[e._v("HTTP API")]),e._v(" that lets cloud back-ends with large Earth observation datasets communicate with front end analysis applications in an interoperable way.")],1),e._v(" "),t("p",[e._v("As an overview, the openEO API specifies how to")]),e._v(" "),t("ul",[t("li",[e._v("discover which Earth observation data and processes are available at cloud back-ends,")]),e._v(" "),t("li",[e._v("execute (chained) processes on back-ends,")]),e._v(" "),t("li",[e._v("run "),t("RouterLink",{attrs:{to:"/documentation/1.0/udfs.html"}},[e._v("user-defined functions")]),e._v(" (UDFs) on back-ends where UDFs can be exposed to the data in different ways,")],1),e._v(" "),t("li",[e._v("download (intermediate) results, and")]),e._v(" "),t("li",[e._v("manage user content including billing.")])]),e._v(" "),t("p",[e._v("The API is defined as an "),t("a",{attrs:{href:"https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenAPI 3.0"),t("OutboundLink")],1),e._v(" YAML file.")]),e._v(" "),t("p",[e._v("The API and processes are grouped into "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/profiles/"}},[e._v("compliance profiles")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"additional-information"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#additional-information"}},[e._v("#")]),e._v(" Additional information")]),e._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/documentation/code-of-conduct.html"}},[e._v("Code of Conduct")])],1),e._v(" "),t("li",[t("RouterLink",{attrs:{to:"/documentation/software-guidelines.html"}},[e._v("Software Development Guidelines")])],1)])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[74],{514:function(e,t,n){"use strict";n.r(t);var o=n(4),a=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"introduction"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#introduction"}},[e._v("#")]),e._v(" Introduction")]),e._v(" "),t("p",[e._v("The openEO API defines a "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html"}},[e._v("HTTP API")]),e._v(" that lets cloud back-ends with large Earth observation datasets communicate with front end analysis applications in an interoperable way.")],1),e._v(" "),t("p",[e._v("As an overview, the openEO API specifies how to")]),e._v(" "),t("ul",[t("li",[e._v("discover which Earth observation data and processes are available at cloud back-ends,")]),e._v(" "),t("li",[e._v("execute (chained) processes on back-ends,")]),e._v(" "),t("li",[e._v("run "),t("RouterLink",{attrs:{to:"/documentation/1.0/udfs.html"}},[e._v("user-defined functions")]),e._v(" (UDFs) on back-ends where UDFs can be exposed to the data in different ways,")],1),e._v(" "),t("li",[e._v("download (intermediate) results, and")]),e._v(" "),t("li",[e._v("manage user content including billing.")])]),e._v(" "),t("p",[e._v("The API is defined as an "),t("a",{attrs:{href:"https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenAPI 3.0"),t("OutboundLink")],1),e._v(" YAML file.")]),e._v(" "),t("p",[e._v("The API and processes are grouped into "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/profiles/"}},[e._v("compliance profiles")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"additional-information"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#additional-information"}},[e._v("#")]),e._v(" Additional information")]),e._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/documentation/code-of-conduct.html"}},[e._v("Code of Conduct")])],1),e._v(" "),t("li",[t("RouterLink",{attrs:{to:"/documentation/software-guidelines.html"}},[e._v("Software Development Guidelines")])],1)])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/75.f928aa32.js b/assets/js/75.b42f4081.js similarity index 77% rename from assets/js/75.f928aa32.js rename to assets/js/75.b42f4081.js index d5bdc29b4..0fad00e9a 100644 --- a/assets/js/75.f928aa32.js +++ b/assets/js/75.b42f4081.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[75],{517:function(t,n,s){"use strict";s.r(n);var e=s(4),o=Object(e.a)({},(function(){return(0,this._self._c)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})}),[],!1,null,null,null);n.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[75],{516:function(t,n,s){"use strict";s.r(n);var e=s(4),o=Object(e.a)({},(function(){return(0,this._self._c)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})}),[],!1,null,null,null);n.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/76.e219c1b9.js b/assets/js/76.87a367a3.js similarity index 95% rename from assets/js/76.e219c1b9.js rename to assets/js/76.87a367a3.js index 08b6a3ef1..6a48894f3 100644 --- a/assets/js/76.e219c1b9.js +++ b/assets/js/76.87a367a3.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[76],{514:function(e,r,o){"use strict";o.r(r);var t=o(4),n=Object(t.a)({},(function(){var e=this,r=e._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"openeo-error-codes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#openeo-error-codes"}},[e._v("#")]),e._v(" openEO error codes")]),e._v(" "),r("p",[e._v("The general error handling in the openEO API is documented in the "),r("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#section/API-Principles/Error-Handling"}},[e._v("API documentation")]),e._v(".")],1),e._v(" "),r("p",[e._v("The following table of error codes is "),r("strong",[e._v("incomplete")]),e._v(". These error codes will evolve over time. If you are missing any common error, please contribute it by adding an "),r("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/issues/new",target:"_blank",rel:"noopener noreferrer"}},[e._v("issue"),r("OutboundLink")],1),e._v(", creating a "),r("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/pulls",target:"_blank",rel:"noopener noreferrer"}},[e._v("pull request"),r("OutboundLink")],1),e._v(" or get in "),r("RouterLink",{attrs:{to:"/contact.html"}},[e._v("contact")]),e._v(".")],1),e._v(" "),r("ErrorCodes")],1)}),[],!1,null,null,null);r.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[76],{517:function(e,r,o){"use strict";o.r(r);var t=o(4),n=Object(t.a)({},(function(){var e=this,r=e._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"openeo-error-codes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#openeo-error-codes"}},[e._v("#")]),e._v(" openEO error codes")]),e._v(" "),r("p",[e._v("The general error handling in the openEO API is documented in the "),r("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#section/API-Principles/Error-Handling"}},[e._v("API documentation")]),e._v(".")],1),e._v(" "),r("p",[e._v("The following table of error codes is "),r("strong",[e._v("incomplete")]),e._v(". These error codes will evolve over time. If you are missing any common error, please contribute it by adding an "),r("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/issues/new",target:"_blank",rel:"noopener noreferrer"}},[e._v("issue"),r("OutboundLink")],1),e._v(", creating a "),r("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/pulls",target:"_blank",rel:"noopener noreferrer"}},[e._v("pull request"),r("OutboundLink")],1),e._v(" or get in "),r("RouterLink",{attrs:{to:"/contact.html"}},[e._v("contact")]),e._v(".")],1),e._v(" "),r("ErrorCodes")],1)}),[],!1,null,null,null);r.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/78.3394d6c2.js b/assets/js/78.f3a67e14.js similarity index 98% rename from assets/js/78.3394d6c2.js rename to assets/js/78.f3a67e14.js index d6a5bfb15..cdd5d0b8c 100644 --- a/assets/js/78.3394d6c2.js +++ b/assets/js/78.f3a67e14.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[78],{521:function(e,t,o){"use strict";o.r(t);var r=o(4),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"getting-started-for-service-back-end-providers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getting-started-for-service-back-end-providers"}},[e._v("#")]),e._v(" Getting started for service (back-end) providers")]),e._v(" "),t("p",[e._v("As a back-end provider who wants to provide its datasets, processes and infrastructure to a broader audience through a standardized interface you may want to implement a driver for openEO.")]),e._v(" "),t("p",[e._v("First of all, you should go through the list of "),t("a",{attrs:{href:"https://github.com/Open-EO",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO repositories"),t("OutboundLink")],1),e._v(' and check whether there is already a back-end driver that suits your needs. In this case you don\'t need to develop your own driver, but "only" need to ingest your data, adopt your required processes and set up the infrastructure. Please follow the documentation for the individual driver you want to use.')]),e._v(" "),t("p",[e._v("If your preferred technology has no back-end driver yet, you may consider writing your own driver. All software written for openEO should follow the "),t("RouterLink",{attrs:{to:"/documentation/software-guidelines.html"}},[e._v("software development guidelines")]),e._v(".")],1),e._v(" "),t("p",[e._v("You certainly need to understand the "),t("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html"}},[e._v("glossary")]),e._v(", the "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/arch.html"}},[e._v("architecture")]),e._v(" of openEO and the concepts behind "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#section/Processes"}},[e._v("processes")]),e._v(" and "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#section/Processes/Process-Graphs"}},[e._v("process graphs")]),e._v(". This helps you read and understand the "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html"}},[e._v("API specification")]),e._v(". Technical API related documents like "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#section/Cross-Origin-Resource-Sharing-(CORS)"}},[e._v("CORS")]),e._v(" and "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#section/API-Principles/Error-Handling"}},[e._v("error handing")]),e._v(" should be read, too.")],1),e._v(" "),t("p",[e._v("If you do not want to start from scratch, you could try to generate a server stub from the "),t("a",{attrs:{href:"https://www.openapis.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenAPI 3.0"),t("OutboundLink")],1),e._v("-based "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html"}},[e._v("API specification")]),e._v(" with the "),t("a",{attrs:{href:"https://github.com/OpenAPITools/openapi-generator",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenAPI Generator"),t("OutboundLink")],1),e._v(".\nIf you are using Python to implement your driver you may reuse some common modules of the existing driver implementations:")],1),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://github.com/Open-EO/openeo-python-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Python Driver Commons"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("You can implement a back-end in iterations. It is recommended to start by implementing the "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#tag/Capabilities"}},[e._v("Capabilities")]),e._v(" microservice. "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#tag/EO-Data-Discovery"}},[e._v("EO Data Discovery")]),e._v(", "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#tag/Process-Discovery"}},[e._v("Process Discovery")]),e._v(" are important for the client libraries to be available, too. Afterwards you should implement "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#tag/Batch-Jobs"}},[e._v("Batch Job Management")]),e._v(" or "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#/paths/~1result/post"}},[e._v("synchronous data processing")]),e._v(". All other microservices can be added later and are not strictly required to run openEO services. Keep in mind that you don't need to implement all endpoints in the first iteration and that you can specify in the Capabilities, which endpoints you are supporting.")],1),e._v(" "),t("p",[e._v("For example, you could start by implementing the following endpoints in the first iteration:")]),e._v(" "),t("ul",[t("li",[e._v("Well-Known Document: "),t("code",[e._v("GET /.well-known/openeo")])]),e._v(" "),t("li",[e._v("Capabilities: "),t("code",[e._v("GET /")]),e._v(" and "),t("code",[e._v("GET /file_formats")])]),e._v(" "),t("li",[e._v("Data discovery: "),t("code",[e._v("GET /collections")]),e._v(" and "),t("code",[e._v("GET /collections/{collection_id}")])]),e._v(" "),t("li",[e._v("Process discovery: "),t("code",[e._v("GET /processes")])]),e._v(" "),t("li",[e._v("Data processing: "),t("code",[e._v("POST /result")])]),e._v(" "),t("li",[e._v("Authentication (if required): "),t("code",[e._v("GET /credentials/basic")])])]),e._v(" "),t("p",[e._v("A more detailed recommendation about the endpoints and processes to implement can be found in the "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/profiles/"}},[e._v("API and Processes profiles")]),e._v(".")],1),e._v(" "),t("p",[e._v("Afterwards you can already start experimenting with your first process graphs and process EO data with our client libraries on your back-end.")]),e._v(" "),t("p",[t("em",[e._v("More information will follow soon, for example about back-end compliance testing.")])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[78],{519:function(e,t,o){"use strict";o.r(t);var r=o(4),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"getting-started-for-service-back-end-providers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getting-started-for-service-back-end-providers"}},[e._v("#")]),e._v(" Getting started for service (back-end) providers")]),e._v(" "),t("p",[e._v("As a back-end provider who wants to provide its datasets, processes and infrastructure to a broader audience through a standardized interface you may want to implement a driver for openEO.")]),e._v(" "),t("p",[e._v("First of all, you should go through the list of "),t("a",{attrs:{href:"https://github.com/Open-EO",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO repositories"),t("OutboundLink")],1),e._v(' and check whether there is already a back-end driver that suits your needs. In this case you don\'t need to develop your own driver, but "only" need to ingest your data, adopt your required processes and set up the infrastructure. Please follow the documentation for the individual driver you want to use.')]),e._v(" "),t("p",[e._v("If your preferred technology has no back-end driver yet, you may consider writing your own driver. All software written for openEO should follow the "),t("RouterLink",{attrs:{to:"/documentation/software-guidelines.html"}},[e._v("software development guidelines")]),e._v(".")],1),e._v(" "),t("p",[e._v("You certainly need to understand the "),t("RouterLink",{attrs:{to:"/documentation/1.0/glossary.html"}},[e._v("glossary")]),e._v(", the "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/arch.html"}},[e._v("architecture")]),e._v(" of openEO and the concepts behind "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#section/Processes"}},[e._v("processes")]),e._v(" and "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#section/Processes/Process-Graphs"}},[e._v("process graphs")]),e._v(". This helps you read and understand the "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html"}},[e._v("API specification")]),e._v(". Technical API related documents like "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#section/Cross-Origin-Resource-Sharing-(CORS)"}},[e._v("CORS")]),e._v(" and "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#section/API-Principles/Error-Handling"}},[e._v("error handing")]),e._v(" should be read, too.")],1),e._v(" "),t("p",[e._v("If you do not want to start from scratch, you could try to generate a server stub from the "),t("a",{attrs:{href:"https://www.openapis.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenAPI 3.0"),t("OutboundLink")],1),e._v("-based "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html"}},[e._v("API specification")]),e._v(" with the "),t("a",{attrs:{href:"https://github.com/OpenAPITools/openapi-generator",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenAPI Generator"),t("OutboundLink")],1),e._v(".\nIf you are using Python to implement your driver you may reuse some common modules of the existing driver implementations:")],1),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://github.com/Open-EO/openeo-python-driver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Python Driver Commons"),t("OutboundLink")],1)])]),e._v(" "),t("p",[e._v("You can implement a back-end in iterations. It is recommended to start by implementing the "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#tag/Capabilities"}},[e._v("Capabilities")]),e._v(" microservice. "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#tag/EO-Data-Discovery"}},[e._v("EO Data Discovery")]),e._v(", "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#tag/Process-Discovery"}},[e._v("Process Discovery")]),e._v(" are important for the client libraries to be available, too. Afterwards you should implement "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#tag/Batch-Jobs"}},[e._v("Batch Job Management")]),e._v(" or "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/api/reference.html#/paths/~1result/post"}},[e._v("synchronous data processing")]),e._v(". All other microservices can be added later and are not strictly required to run openEO services. Keep in mind that you don't need to implement all endpoints in the first iteration and that you can specify in the Capabilities, which endpoints you are supporting.")],1),e._v(" "),t("p",[e._v("For example, you could start by implementing the following endpoints in the first iteration:")]),e._v(" "),t("ul",[t("li",[e._v("Well-Known Document: "),t("code",[e._v("GET /.well-known/openeo")])]),e._v(" "),t("li",[e._v("Capabilities: "),t("code",[e._v("GET /")]),e._v(" and "),t("code",[e._v("GET /file_formats")])]),e._v(" "),t("li",[e._v("Data discovery: "),t("code",[e._v("GET /collections")]),e._v(" and "),t("code",[e._v("GET /collections/{collection_id}")])]),e._v(" "),t("li",[e._v("Process discovery: "),t("code",[e._v("GET /processes")])]),e._v(" "),t("li",[e._v("Data processing: "),t("code",[e._v("POST /result")])]),e._v(" "),t("li",[e._v("Authentication (if required): "),t("code",[e._v("GET /credentials/basic")])])]),e._v(" "),t("p",[e._v("A more detailed recommendation about the endpoints and processes to implement can be found in the "),t("RouterLink",{attrs:{to:"/documentation/1.0/developers/profiles/"}},[e._v("API and Processes profiles")]),e._v(".")],1),e._v(" "),t("p",[e._v("Afterwards you can already start experimenting with your first process graphs and process EO data with our client libraries on your back-end.")]),e._v(" "),t("p",[t("em",[e._v("More information will follow soon, for example about back-end compliance testing.")])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/79.db0b8d8b.js b/assets/js/79.10e22d61.js similarity index 99% rename from assets/js/79.db0b8d8b.js rename to assets/js/79.10e22d61.js index ac068ad2a..5edff8253 100644 --- a/assets/js/79.db0b8d8b.js +++ b/assets/js/79.10e22d61.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[79],{520:function(e,a,t){"use strict";t.r(a);var o=t(4),s=Object(o.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"performance-guide-for-openeo-backends"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#performance-guide-for-openeo-backends"}},[e._v("#")]),e._v(" Performance guide for openEO backends")]),e._v(" "),a("h2",{attrs:{id:"openeo-api-vision-on-performance-scalability"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#openeo-api-vision-on-performance-scalability"}},[e._v("#")]),e._v(" openEO API vision on performance & scalability")]),e._v(" "),a("p",[e._v("Given that the openEO API only defines a web service, it can in no way ensure the performance or scalability of an\nimplementation. What it can do however, is avoiding API definitions that prevent an implementation from being efficient.\nWhen openEO was designed, performance was one of the key design drivers, so here we try to explain how that is achieved.")]),e._v(" "),a("h3",{attrs:{id:"bringing-the-processing-to-the-data"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#bringing-the-processing-to-the-data"}},[e._v("#")]),e._v(" Bringing the processing to the data")]),e._v(" "),a("p",[e._v("Two evolutions created the need for an API designed for performance and scalability: EO programmes like Copernicus that\npushed data volumes into the petabyte range, and a move towards ever larger cloud infrastructure and HPC processing capacity\nto analyze these volumes of data. OpenEO supports this by defining data access and processing into a single specification.\nAs a result, the openEO process graph allows the backend to choose any data access pattern that is optimal for\nthe processing that is to be executed, and the dataset that is to be read.")]),e._v(" "),a("p",[e._v("A popular example of such a case, is infrastructures that store the data on the same machines that do the processing.\nIn such a case, an openEO backend can choose to load and process the data directly on the machine that has the data stored.\nAnother example is adjusting and aligning the data chunks for the processing to the internal layout of the file format that\nstores the EO data. IO performance optimizations like this are only possible if the processing engine has deep knowledge\nof the data organization from storage system over networks to file formats.")]),e._v(" "),a("h3",{attrs:{id:"datacube-processing"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#datacube-processing"}},[e._v("#")]),e._v(" Datacube processing")]),e._v(" "),a("p",[e._v("The datacube view that openEO uses as a model to represent the data as it is transformed by various processes also has\nimportant performance and scalability implications.")]),e._v(" "),a("p",[e._v("The easiest way to understand this is to contrast it with a more traditional 'product-based' view of building workflows.\nIn a product or file based workflow, a process operates on a set of input files and generates a set of output files. Many\nEO workflows have been written like this, but the consequence is that every process spends time on reading date into memory, and\nwriting it back to disk. Persistent storage is often the slowest component in a processing system, and thus these workflows\nspend a lot of time on IO. In the openEO specification, a process transforms one datacube into another datacube.\nBackend implementations are encouraged to avoid writing data to disk in between processing steps whenever possible. By\nkeeping the datacubes into memory, this avoids those costly IO operations.")]),e._v(" "),a("p",[e._v("Here it is important to note that openEO does not enforce or define how the datacube should look like on the backend. The\ndatacube can be a set of files, or arrays in memory distributed over a cluster. These choices are left to the\nbackend implementor, this guide only tries to highlight the possibilities.")]),e._v(" "),a("p",[e._v("For scalability, the openEO processes clearly define along which set of dimensions of the datacube they operate. When\na user writes a process graph, it should never instruct the backend to apply a black box algorithm or function on the\nentire datacube. For most algorithms, this is not necessary, and loading the complete datacube of a Copernicus mission at once\nis simply not possible. Hence, users run '"),a("a",{attrs:{href:"https://openeo.org/documentation/1.0/developers/api/reference.html#section/Processes/Process-Graphs",target:"_blank",rel:"noopener noreferrer"}},[e._v("user-defined (child) processes"),a("OutboundLink")],1),e._v("' over a 1-dimensional array, or even multidimensional arrays or 'chunks'\nof the datacube. Based on this information, the backend is able to define both a data access and processing strategy that is\noptimal for the given process graph.")]),e._v(" "),a("h2",{attrs:{id:"process-graph-execution"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#process-graph-execution"}},[e._v("#")]),e._v(" Process graph execution")]),e._v(" "),a("p",[e._v("Here we go a bit more into detail about how a backend evaluates a process graph. Again, this is not normative or\nmandated by the specification, but rather an explanation of one way to achieve optimal performance.")]),e._v(" "),a("p",[e._v("In general, process graphs are first analyzed as a whole before the actual processing starts. The analysis phase serves\nto reveal the optimal processing strategy and parameters.")]),e._v(" "),a("p",[e._v("These are a few examples of things that can be derived from a process graph and subsequent optimizations:")]),e._v(" "),a("ul",[a("li",[a("strong",[e._v("Masking:")]),e._v(" when a raster dataset is masked with another raster or polygons, then often the loading of the datacube to\nwhich the mask is applied can be limited to unmasked values.")]),e._v(" "),a("li",[a("strong",[e._v("Vector filtering:")]),e._v(" various operations (aggregate_spatial, filter_spatial, mask_polygon) can restrict the datacube to a\nset of polygons, resulting in a rather sparse cube. Loading and processing of sparse cubes can be rather different from dense data cubes.")]),e._v(" "),a("li",[a("strong",[e._v("Resampling:")]),e._v(" resampling operations can allow data to be loaded from overviews rather than original resolution. Applying\nresampling and reprojection at load time can also be faster and save memory.")]),e._v(" "),a("li",[a("strong",[e._v("Multitemporal processing:")]),e._v(" many EO algorithms work over the temporal dimension rather than spatial dimensions. The\ntype of algorithm can be inferred from the process graph, allowing to adjust the processing strategy accordingly.")])]),e._v(" "),a("h2",{attrs:{id:"performance-faq"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#performance-faq"}},[e._v("#")]),e._v(" Performance FAQ")]),e._v(" "),a("h3",{attrs:{id:"i-have-a-highly-optimized-workflow-can-openeo-expose-it"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#i-have-a-highly-optimized-workflow-can-openeo-expose-it"}},[e._v("#")]),e._v(" I have a highly optimized workflow, can openEO expose it?")]),e._v(" "),a("p",[e._v("Basically openEO can expose anything as a custom 'process'. If your algorithm can not be expressed as an openEO process graph,\nthen you can just let your backend advertise your custom process. By doing this, you still benefit from a lot of the standardized\nfeatures in the openEO API, and most tools for openEO will also support working with custom processes. This is fairly similar\nto exposing your process in other standards such as OGC Processes.")]),e._v(" "),a("p",[e._v("We do expect however that it is much more likely that your workflow can still reuse a few standardized processes. For instance,\nif it can be run on a geographical bounding box, the filter_bbox process would be a standardized way to specify that. Or\nperhaps it can operate on any set of Sentinel-2 products, in which case you might fit in a load_collection to let your users\ncustomize the input data. So usually, while you might start from a fully custom process, you'll notice that openEO offers\nways to gradually standardize your workflow further in a stepwise manner.")]),e._v(" "),a("h3",{attrs:{id:"can-openeo-be-as-fast-as-a-hand-written-workflow"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#can-openeo-be-as-fast-as-a-hand-written-workflow"}},[e._v("#")]),e._v(" Can openEO be as fast as a hand-written workflow?")]),e._v(" "),a("p",[e._v("This question depends on which backend implementation you compare to which workflow, so there is no generic answer.\nWe do note that for writing non-trivial workflows in a cloud environment, you require a combination of algorithmic programming skills\nand cloud engineering that usually requires a team of skilled persons spending (in total) multiple person months to years on the same workflow.\nSo if you know that many workflow patterns in the operational openEO backends have already been highly optimized, you may\nwant to consider if the potential of reducing processing cost with a few percentages justifies the effort.")]),e._v(" "),a("p",[e._v("Also consider that next to the openEO API, there's also a community of open source backend implementations. So if you have\nthe skills to optimize processing pipelines to perfection, why don't you consider contributing to a backend that matches your\npreferred technology stack?")])])}),[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[79],{521:function(e,a,t){"use strict";t.r(a);var o=t(4),s=Object(o.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"performance-guide-for-openeo-backends"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#performance-guide-for-openeo-backends"}},[e._v("#")]),e._v(" Performance guide for openEO backends")]),e._v(" "),a("h2",{attrs:{id:"openeo-api-vision-on-performance-scalability"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#openeo-api-vision-on-performance-scalability"}},[e._v("#")]),e._v(" openEO API vision on performance & scalability")]),e._v(" "),a("p",[e._v("Given that the openEO API only defines a web service, it can in no way ensure the performance or scalability of an\nimplementation. What it can do however, is avoiding API definitions that prevent an implementation from being efficient.\nWhen openEO was designed, performance was one of the key design drivers, so here we try to explain how that is achieved.")]),e._v(" "),a("h3",{attrs:{id:"bringing-the-processing-to-the-data"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#bringing-the-processing-to-the-data"}},[e._v("#")]),e._v(" Bringing the processing to the data")]),e._v(" "),a("p",[e._v("Two evolutions created the need for an API designed for performance and scalability: EO programmes like Copernicus that\npushed data volumes into the petabyte range, and a move towards ever larger cloud infrastructure and HPC processing capacity\nto analyze these volumes of data. OpenEO supports this by defining data access and processing into a single specification.\nAs a result, the openEO process graph allows the backend to choose any data access pattern that is optimal for\nthe processing that is to be executed, and the dataset that is to be read.")]),e._v(" "),a("p",[e._v("A popular example of such a case, is infrastructures that store the data on the same machines that do the processing.\nIn such a case, an openEO backend can choose to load and process the data directly on the machine that has the data stored.\nAnother example is adjusting and aligning the data chunks for the processing to the internal layout of the file format that\nstores the EO data. IO performance optimizations like this are only possible if the processing engine has deep knowledge\nof the data organization from storage system over networks to file formats.")]),e._v(" "),a("h3",{attrs:{id:"datacube-processing"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#datacube-processing"}},[e._v("#")]),e._v(" Datacube processing")]),e._v(" "),a("p",[e._v("The datacube view that openEO uses as a model to represent the data as it is transformed by various processes also has\nimportant performance and scalability implications.")]),e._v(" "),a("p",[e._v("The easiest way to understand this is to contrast it with a more traditional 'product-based' view of building workflows.\nIn a product or file based workflow, a process operates on a set of input files and generates a set of output files. Many\nEO workflows have been written like this, but the consequence is that every process spends time on reading date into memory, and\nwriting it back to disk. Persistent storage is often the slowest component in a processing system, and thus these workflows\nspend a lot of time on IO. In the openEO specification, a process transforms one datacube into another datacube.\nBackend implementations are encouraged to avoid writing data to disk in between processing steps whenever possible. By\nkeeping the datacubes into memory, this avoids those costly IO operations.")]),e._v(" "),a("p",[e._v("Here it is important to note that openEO does not enforce or define how the datacube should look like on the backend. The\ndatacube can be a set of files, or arrays in memory distributed over a cluster. These choices are left to the\nbackend implementor, this guide only tries to highlight the possibilities.")]),e._v(" "),a("p",[e._v("For scalability, the openEO processes clearly define along which set of dimensions of the datacube they operate. When\na user writes a process graph, it should never instruct the backend to apply a black box algorithm or function on the\nentire datacube. For most algorithms, this is not necessary, and loading the complete datacube of a Copernicus mission at once\nis simply not possible. Hence, users run '"),a("a",{attrs:{href:"https://openeo.org/documentation/1.0/developers/api/reference.html#section/Processes/Process-Graphs",target:"_blank",rel:"noopener noreferrer"}},[e._v("user-defined (child) processes"),a("OutboundLink")],1),e._v("' over a 1-dimensional array, or even multidimensional arrays or 'chunks'\nof the datacube. Based on this information, the backend is able to define both a data access and processing strategy that is\noptimal for the given process graph.")]),e._v(" "),a("h2",{attrs:{id:"process-graph-execution"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#process-graph-execution"}},[e._v("#")]),e._v(" Process graph execution")]),e._v(" "),a("p",[e._v("Here we go a bit more into detail about how a backend evaluates a process graph. Again, this is not normative or\nmandated by the specification, but rather an explanation of one way to achieve optimal performance.")]),e._v(" "),a("p",[e._v("In general, process graphs are first analyzed as a whole before the actual processing starts. The analysis phase serves\nto reveal the optimal processing strategy and parameters.")]),e._v(" "),a("p",[e._v("These are a few examples of things that can be derived from a process graph and subsequent optimizations:")]),e._v(" "),a("ul",[a("li",[a("strong",[e._v("Masking:")]),e._v(" when a raster dataset is masked with another raster or polygons, then often the loading of the datacube to\nwhich the mask is applied can be limited to unmasked values.")]),e._v(" "),a("li",[a("strong",[e._v("Vector filtering:")]),e._v(" various operations (aggregate_spatial, filter_spatial, mask_polygon) can restrict the datacube to a\nset of polygons, resulting in a rather sparse cube. Loading and processing of sparse cubes can be rather different from dense data cubes.")]),e._v(" "),a("li",[a("strong",[e._v("Resampling:")]),e._v(" resampling operations can allow data to be loaded from overviews rather than original resolution. Applying\nresampling and reprojection at load time can also be faster and save memory.")]),e._v(" "),a("li",[a("strong",[e._v("Multitemporal processing:")]),e._v(" many EO algorithms work over the temporal dimension rather than spatial dimensions. The\ntype of algorithm can be inferred from the process graph, allowing to adjust the processing strategy accordingly.")])]),e._v(" "),a("h2",{attrs:{id:"performance-faq"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#performance-faq"}},[e._v("#")]),e._v(" Performance FAQ")]),e._v(" "),a("h3",{attrs:{id:"i-have-a-highly-optimized-workflow-can-openeo-expose-it"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#i-have-a-highly-optimized-workflow-can-openeo-expose-it"}},[e._v("#")]),e._v(" I have a highly optimized workflow, can openEO expose it?")]),e._v(" "),a("p",[e._v("Basically openEO can expose anything as a custom 'process'. If your algorithm can not be expressed as an openEO process graph,\nthen you can just let your backend advertise your custom process. By doing this, you still benefit from a lot of the standardized\nfeatures in the openEO API, and most tools for openEO will also support working with custom processes. This is fairly similar\nto exposing your process in other standards such as OGC Processes.")]),e._v(" "),a("p",[e._v("We do expect however that it is much more likely that your workflow can still reuse a few standardized processes. For instance,\nif it can be run on a geographical bounding box, the filter_bbox process would be a standardized way to specify that. Or\nperhaps it can operate on any set of Sentinel-2 products, in which case you might fit in a load_collection to let your users\ncustomize the input data. So usually, while you might start from a fully custom process, you'll notice that openEO offers\nways to gradually standardize your workflow further in a stepwise manner.")]),e._v(" "),a("h3",{attrs:{id:"can-openeo-be-as-fast-as-a-hand-written-workflow"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#can-openeo-be-as-fast-as-a-hand-written-workflow"}},[e._v("#")]),e._v(" Can openEO be as fast as a hand-written workflow?")]),e._v(" "),a("p",[e._v("This question depends on which backend implementation you compare to which workflow, so there is no generic answer.\nWe do note that for writing non-trivial workflows in a cloud environment, you require a combination of algorithmic programming skills\nand cloud engineering that usually requires a team of skilled persons spending (in total) multiple person months to years on the same workflow.\nSo if you know that many workflow patterns in the operational openEO backends have already been highly optimized, you may\nwant to consider if the potential of reducing processing cost with a few percentages justifies the effort.")]),e._v(" "),a("p",[e._v("Also consider that next to the openEO API, there's also a community of open source backend implementations. So if you have\nthe skills to optimize processing pipelines to perfection, why don't you consider contributing to a backend that matches your\npreferred technology stack?")])])}),[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/82.4f4bed4a.js b/assets/js/82.8c9c7d6f.js similarity index 99% rename from assets/js/82.4f4bed4a.js rename to assets/js/82.8c9c7d6f.js index 00bf09bcc..0063ac517 100644 --- a/assets/js/82.4f4bed4a.js +++ b/assets/js/82.8c9c7d6f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[82],{524:function(t,e,s){"use strict";s.r(e);var a=s(4),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"client-library-development-guidelines"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#client-library-development-guidelines"}},[t._v("#")]),t._v(" Client library development guidelines")]),t._v(" "),e("p",[t._v("This is a proposal for workflows that client libraries should support to make the experience with each library similar and users can easily adopt examples and workflows.")]),t._v(" "),e("p",[t._v("For best experience libraries should still embrace best practices common in their environments. This means clients can...")]),t._v(" "),e("ul",[e("li",[t._v("choose which kind of casing they use (see below).")]),t._v(" "),e("li",[t._v("feel free to implement aliases for methods.")])]),t._v(" "),e("h2",{attrs:{id:"conventions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#conventions"}},[t._v("#")]),t._v(" Conventions")]),t._v(" "),e("h3",{attrs:{id:"casing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#casing"}},[t._v("#")]),t._v(" Casing")]),t._v(" "),e("p",[t._v("Clients can use "),e("code",[t._v("snake_case")]),t._v(", "),e("code",[t._v("camelCase")]),t._v(" or any method used commonly in their environment. For example, the API request to get a list of collections can either be names "),e("code",[t._v("get_collections")]),t._v(" or "),e("code",[t._v("getCollections")]),t._v(". This applies for all names, including scopes, method names and parameters.")]),t._v(" "),e("h3",{attrs:{id:"scopes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scopes"}},[t._v("#")]),t._v(" Scopes")]),t._v(" "),e("p",[t._v('Each method belongs to a scope. To achieve this in object-oriented (OO) programming languages, methods would be part of a class. If programming languages don\'t support scopes, you may need to simulate it somehow to prevent name collisions, e.g. by adding a prefix to the method names (like in the "procedural style" example below). Best practices for this will likely evolve over time.')]),t._v(" "),e("p",[t._v("Example for the "),e("code",[t._v("clientVersion")]),t._v(" method in "),e("code",[t._v("openEO")]),t._v(":")]),t._v(" "),e("ul",[e("li",[t._v("Procedural style: "),e("code",[t._v("openeo_client_version()")])]),t._v(" "),e("li",[t._v("Object-oriented style:"),e("div",{staticClass:"language-java extra-class"},[e("pre",{pre:!0,attrs:{class:"language-java"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),t._v(" obj "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nobj"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("clientVersion")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])]),t._v(" "),e("p",[t._v("If you can't store scope data in an object, you may need to pass these information as argument(s) to the method.")]),t._v(" "),e("p",[t._v("Example:")]),t._v(" "),e("ul",[e("li",[t._v("Procedural style:"),e("div",{staticClass:"language-php extra-class"},[e("pre",{pre:!0,attrs:{class:"language-php"}},[e("code",[e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_connect")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"https://openeo.org"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_capabilities")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),e("li",[t._v("Object-oriented style:"),e("div",{staticClass:"language-java extra-class"},[e("pre",{pre:!0,attrs:{class:"language-java"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),t._v(" obj "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Connection")]),t._v(" con "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" obj"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("connect")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://openeo.org"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\ncon"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("capabilities")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])]),t._v(" "),e("h3",{attrs:{id:"scope-categories"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scope-categories"}},[t._v("#")]),t._v(" Scope categories")]),t._v(" "),e("p",[t._v("Each scope is assigned to a scope category, of which there are three:")]),t._v(" "),e("ul",[e("li",[e("em",[t._v("Root")]),t._v(" category: Contains only the scope "),e("code",[t._v("openEO")]),t._v(".")]),t._v(" "),e("li",[e("em",[t._v("API")]),t._v(" category: Mostly methods hiding API calls to the back-ends. Methods may be implemented asynchronously. Contains the scopes "),e("code",[t._v("Connection")]),t._v(", "),e("code",[t._v("File")]),t._v(", "),e("code",[t._v("Job")]),t._v(", "),e("code",[t._v("UserProcess")]),t._v(", "),e("code",[t._v("Service")]),t._v(".")]),t._v(" "),e("li",[e("em",[t._v("Content")]),t._v(": Mostly methods hiding the complexity of response content. Methods are usually implemented synchronously. Currently contains only the scope "),e("code",[t._v("Capabilities")]),t._v(". Method names should be prefixed if name collisions are likely.")])]),t._v(" "),e("p",[t._v("Method names across ALL the scopes that belong to the "),e("em",[t._v("root")]),t._v(" or "),e("em",[t._v("API")]),t._v(" categories MUST be unique. This is the case because the parameter in "),e("code",[t._v("hasFeature(method_name)")]),t._v(" must be unambiguous.")]),t._v(" "),e("p",[t._v("Method names of scopes in the "),e("em",[t._v("Content")]),t._v(" category may collide with method names of scopes in the "),e("em",[t._v("root")]),t._v("/"),e("em",[t._v("API")]),t._v(" categories and names should be prefixed if collisions of names between different scope categories are to be expected.")]),t._v(" "),e("h3",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("p",[t._v("The parameters usually follow the request schemes in the openAPI specification. The parameters should follow their characteristics, for example regarding the default values.")]),t._v(" "),e("p",[t._v("Some methods have a long list of (optional) parameters. This is easy to implement in languages that support named parameters such as R. For example, creating a job in R with a budget would lead to this method call:")]),t._v(" "),e("div",{staticClass:"language-R extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("createJob"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("process_graph "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),e("span",{pre:!0,attrs:{class:"token ellipsis"}},[t._v("...")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" budget "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("123")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("Other languages that only support non-named parameters (i.e. the order of parameters is fixed) need to fill many parameters with default values, which is not convenient for a user. The example above in PHP would be:")]),t._v(" "),e("div",{staticClass:"language-php extra-class"},[e("pre",{pre:!0,attrs:{class:"language-php"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("createJob")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("123")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("To avoid such method calls client developers should consider to pass either")]),t._v(" "),e("ul",[e("li",[t._v("an instance of a class, which contains all parameters as member variables or")]),t._v(" "),e("li",[t._v("the required parameters directly and the optional parameters as a dictionary (see example below).")])]),t._v(" "),e("p",[t._v("This basically emulates named parameters. The member variables / dictionary keys should use the same names as the parameters. The exemplary method call in PHP could be improved as follows:")]),t._v(" "),e("div",{staticClass:"language-php extra-class"},[e("pre",{pre:!0,attrs:{class:"language-php"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("createJob")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("budget "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("123")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("h2",{attrs:{id:"method-mappings"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#method-mappings"}},[t._v("#")]),t._v(" Method mappings")]),t._v(" "),e("p",[e("strong",[t._v("Note:")]),t._v(" Some scopes for response JSON objects are still missing. We are open for proposals.")]),t._v(" "),e("p",[t._v("Parameters with a leading "),e("code",[t._v("?")]),t._v(" are optional.")]),t._v(" "),e("h3",{attrs:{id:"scope-openeo-root-category"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scope-openeo-root-category"}},[t._v("#")]),t._v(" Scope: "),e("code",[t._v("openEO")]),t._v(" (root category)")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Client method")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("Connect to a back-end, includes version discovery ("),e("code",[t._v("GET /.well-known/openeo")]),t._v("), requesting capabilities and authentication where required. Returns "),e("code",[t._v("Connection")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("connect(url, ?authType, ?authOptions)")])])]),t._v(" "),e("tr",[e("td",[t._v("Get client library version.")]),t._v(" "),e("td",[e("code",[t._v("clientVersion()")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("authType")]),t._v(" in "),e("code",[t._v("connect")]),t._v(": "),e("code",[t._v("null")]),t._v(", "),e("code",[t._v("basic")]),t._v(" or "),e("code",[t._v("oidc")]),t._v(" (non-exclusive). Defaults to "),e("code",[t._v("null")]),t._v(" (no authentication).")]),t._v(" "),e("li",[e("strong",[t._v("authOptions")]),t._v(" in "),e("code",[t._v("connect")]),t._v(": May hold additional data for authentication, for example a username and password for "),e("code",[t._v("basic")]),t._v(" authentication.")])]),t._v(" "),e("h3",{attrs:{id:"scope-connection-api-category"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scope-connection-api-category"}},[t._v("#")]),t._v(" Scope: "),e("code",[t._v("Connection")]),t._v(" (API category)")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("API Request")]),t._v(" "),e("th",[t._v("Client method")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("Get the capabilities of the back-end. Returns "),e("code",[t._v("Capabilities")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("GET /")])]),t._v(" "),e("td",[e("code",[t._v("capabilities()")])])]),t._v(" "),e("tr",[e("td",[t._v("List the supported output file formats.")]),t._v(" "),e("td",[e("code",[t._v("GET /file_formats")])]),t._v(" "),e("td",[e("code",[t._v("listFileTypes()")])])]),t._v(" "),e("tr",[e("td",[t._v("List the supported secondary service types.")]),t._v(" "),e("td",[e("code",[t._v("GET /service_types")])]),t._v(" "),e("td",[e("code",[t._v("listServiceTypes()")])])]),t._v(" "),e("tr",[e("td",[t._v("List the supported UDF runtimes.")]),t._v(" "),e("td",[e("code",[t._v("GET /udf_runtimes")])]),t._v(" "),e("td",[e("code",[t._v("listUdfRuntimes()")])])]),t._v(" "),e("tr",[e("td",[t._v("List all collections available on the back-end.")]),t._v(" "),e("td",[e("code",[t._v("GET /collections")])]),t._v(" "),e("td",[e("code",[t._v("listCollections()")])])]),t._v(" "),e("tr",[e("td",[t._v("Get information about a single collection.")]),t._v(" "),e("td",[e("code",[t._v("GET /collections/{collection_id}")])]),t._v(" "),e("td",[e("code",[t._v("describeCollection(collection_id)")])])]),t._v(" "),e("tr",[e("td",[t._v("List all pre-defined processes available on the back-end.")]),t._v(" "),e("td",[e("code",[t._v("GET /processes")])]),t._v(" "),e("td",[e("code",[t._v("listProcesses()")])])]),t._v(" "),e("tr",[e("td",[t._v("List authentication providers (may also list HTTP Basic).")]),t._v(" "),e("td",[e("code",[t._v("GET /credentials/oidc")]),t._v(" / "),e("code",[t._v("GET /credentials/basic")])]),t._v(" "),e("td",[e("code",[t._v("listAuthProviders()")])])]),t._v(" "),e("tr",[e("td",[t._v("Get information about the authenticated user.")]),t._v(" "),e("td",[e("code",[t._v("GET /me")])]),t._v(" "),e("td",[e("code",[t._v("describeAccount()")])])]),t._v(" "),e("tr",[e("td",[t._v("Lists all files from a user. Returns a list of "),e("code",[t._v("File")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("GET /files")])]),t._v(" "),e("td",[e("code",[t._v("listFiles()")])])]),t._v(" "),e("tr",[e("td",[t._v("Opens an (existing or non-existing) file without reading it. Returns a "),e("code",[t._v("File")]),t._v(".")]),t._v(" "),e("td",[e("em",[t._v("None")])]),t._v(" "),e("td",[e("code",[t._v("getFile(path)")])])]),t._v(" "),e("tr",[e("td",[t._v("Upload a user file. Returns a "),e("code",[t._v("File")]),t._v(".")]),t._v(" "),e("td",[t._v("Shortcut: "),e("code",[t._v("getFile(path).uploadFile(source)")])]),t._v(" "),e("td",[e("code",[t._v("uploadFile(source, path)")])])]),t._v(" "),e("tr",[e("td",[t._v("Validates a process graph.")]),t._v(" "),e("td",[e("code",[t._v("POST /validation")])]),t._v(" "),e("td",[e("code",[t._v("validateProcess(process)")])])]),t._v(" "),e("tr",[e("td",[t._v("Lists all user-defined processes of the authenticated user. Returns a list of "),e("code",[t._v("UserProcess")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("GET /process_graphs")])]),t._v(" "),e("td",[e("code",[t._v("listUserProcesses()")])])]),t._v(" "),e("tr",[e("td",[t._v("Creates a new user-defined process. Returns a "),e("code",[t._v("UserProcess")]),t._v(".")]),t._v(" "),e("td",[t._v("Shortcut: "),e("code",[t._v("getUserProcess(id).replaceUserProcess(process)")])]),t._v(" "),e("td",[e("code",[t._v("setUserProcess(id, process)")])])]),t._v(" "),e("tr",[e("td",[t._v("Get all information about a user-defined process. Returns a "),e("code",[t._v("UserProcess")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("GET /process_graphs/{process_graph_id}")])]),t._v(" "),e("td",[e("code",[t._v("getUserProcess(id)")])])]),t._v(" "),e("tr",[e("td",[t._v("Executes a process graph synchronously.")]),t._v(" "),e("td",[e("code",[t._v("POST /result")])]),t._v(" "),e("td",[e("code",[t._v("computeResult(process, ?plan, ?budget, ?additional)")])])]),t._v(" "),e("tr",[e("td",[t._v("Lists all jobs of the authenticated user. Returns a list of "),e("code",[t._v("Job")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("GET /jobs")])]),t._v(" "),e("td",[e("code",[t._v("listJobs()")])])]),t._v(" "),e("tr",[e("td",[t._v("Creates a new job. Returns a "),e("code",[t._v("Job")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("POST /jobs")])]),t._v(" "),e("td",[e("code",[t._v("createJob(process, ?title, ?description, ?plan, ?budget, ?additional)")])])]),t._v(" "),e("tr",[e("td",[t._v("Get all information about a job. Returns a "),e("code",[t._v("Job")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("GET /jobs/{job_id}")])]),t._v(" "),e("td",[e("code",[t._v("getJob(id)")])])]),t._v(" "),e("tr",[e("td",[t._v("Lists all secondary services of the authenticated user. Returns a list of "),e("code",[t._v("Service")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("GET /services")])]),t._v(" "),e("td",[e("code",[t._v("listServices()")])])]),t._v(" "),e("tr",[e("td",[t._v("Creates a new secondary service. Returns a "),e("code",[t._v("Service")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("POST /services")])]),t._v(" "),e("td",[e("code",[t._v("createService(process, type, ?title, ?description, ?enabled, ?parameters, ?plan, ?budget, ?additional)")])])]),t._v(" "),e("tr",[e("td",[t._v("Get all information about a service. Returns a "),e("code",[t._v("Service")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("GET /services/{service_id}")])]),t._v(" "),e("td",[e("code",[t._v("getService(id)")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("options")]),t._v(" in "),e("code",[t._v("authenticateOIDC")]),t._v(": May hold additional data required for OpenID connect authentication.")]),t._v(" "),e("li",[e("strong",[t._v("additional")]),t._v(" in "),e("code",[t._v("createJob")]),t._v(" and "),e("code",[t._v("createService")]),t._v(" (also below in "),e("code",[t._v("updateJob")]),t._v(" and "),e("code",[t._v("updateService")]),t._v("): May hold additional key-value-pairs as object. The object should be merged with the body of the request.")])]),t._v(" "),e("h3",{attrs:{id:"scope-capabilities-content-category"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scope-capabilities-content-category"}},[t._v("#")]),t._v(" Scope "),e("code",[t._v("Capabilities")]),t._v(" (Content category)")]),t._v(" "),e("p",[t._v("Should be prefixed with "),e("code",[t._v("Capabilities")]),t._v(" if collisions of names between different scope categories are to be expected.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Field")]),t._v(" "),e("th",[t._v("Client method")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("Get the implemented openEO version.")]),t._v(" "),e("td",[e("code",[t._v("api_version")])]),t._v(" "),e("td",[e("code",[t._v("apiVersion()")])])]),t._v(" "),e("tr",[e("td",[t._v("Get the back-end version.")]),t._v(" "),e("td",[e("code",[t._v("backend_version")])]),t._v(" "),e("td",[e("code",[t._v("backendVersion()")])])]),t._v(" "),e("tr",[e("td",[t._v("Is the back-end suitable for use in production?")]),t._v(" "),e("td",[e("code",[t._v("production")])]),t._v(" "),e("td",[e("code",[t._v("isStable()")])])]),t._v(" "),e("tr",[e("td",[t._v("Get the name of the back-end.")]),t._v(" "),e("td",[e("code",[t._v("title")])]),t._v(" "),e("td",[e("code",[t._v("title()")])])]),t._v(" "),e("tr",[e("td",[t._v("Get the description of the back-end.")]),t._v(" "),e("td",[e("code",[t._v("description")])]),t._v(" "),e("td",[e("code",[t._v("description()")])])]),t._v(" "),e("tr",[e("td",[t._v("List all supported features / endpoints.")]),t._v(" "),e("td",[e("code",[t._v("endpoints")])]),t._v(" "),e("td",[e("code",[t._v("listFeatures()")])])]),t._v(" "),e("tr",[e("td",[t._v("Check whether a feature / endpoint is supported.")]),t._v(" "),e("td",[e("code",[t._v("endpoints")]),t._v(" > ...")]),t._v(" "),e("td",[e("code",[t._v("hasFeature(methodName)")])])]),t._v(" "),e("tr",[e("td",[t._v("Get the default billing currency.")]),t._v(" "),e("td",[e("code",[t._v("billing")]),t._v(" > "),e("code",[t._v("currency")])]),t._v(" "),e("td",[e("code",[t._v("currency()")])])]),t._v(" "),e("tr",[e("td",[t._v("List all billing plans.")]),t._v(" "),e("td",[e("code",[t._v("billing")]),t._v(" > "),e("code",[t._v("plans")])]),t._v(" "),e("td",[e("code",[t._v("listPlans()")])])]),t._v(" "),e("tr",[e("td",[t._v("List all links.")]),t._v(" "),e("td",[e("code",[t._v("links")])]),t._v(" "),e("td",[e("code",[t._v("links()")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("methodName")]),t._v(" in "),e("code",[t._v("hasFeature")]),t._v(": The name of a client method in any of the scopes that are part of the "),e("em",[t._v("API")]),t._v(" category. E.g. "),e("code",[t._v('hasFeature("describeAccount")')]),t._v(" checks whether the "),e("code",[t._v("GET /me")]),t._v(" endpoint is contained in the capabilities response's "),e("code",[t._v("endpoints")]),t._v(" object.")])]),t._v(" "),e("h3",{attrs:{id:"scope-file-api-category"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scope-file-api-category"}},[t._v("#")]),t._v(" Scope: "),e("code",[t._v("File")]),t._v(" (API category)")]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("File")]),t._v(" scope internally knows the "),e("code",[t._v("path")]),t._v(".")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("API Request")]),t._v(" "),e("th",[t._v("Client method")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("Download a user file.")]),t._v(" "),e("td",[e("code",[t._v("GET /files/{path}")])]),t._v(" "),e("td",[e("code",[t._v("downloadFile(target)")])])]),t._v(" "),e("tr",[e("td",[t._v("Upload a user file.")]),t._v(" "),e("td",[e("code",[t._v("PUT /files/{path}")])]),t._v(" "),e("td",[e("code",[t._v("uploadFile(source)")])])]),t._v(" "),e("tr",[e("td",[t._v("Delete a user file.")]),t._v(" "),e("td",[e("code",[t._v("DELETE /files/{path}")])]),t._v(" "),e("td",[e("code",[t._v("deleteFile()")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("target")]),t._v(" in "),e("code",[t._v("downloadFile")]),t._v(": Path to a local file or folder.")])]),t._v(" "),e("h3",{attrs:{id:"scope-job-api-category"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scope-job-api-category"}},[t._v("#")]),t._v(" Scope: "),e("code",[t._v("Job")]),t._v(" (API category)")]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("Job")]),t._v(" scope internally knows the "),e("code",[t._v("job_id")]),t._v(".")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("API Request")]),t._v(" "),e("th",[t._v("Client method")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("Get all job information.")]),t._v(" "),e("td",[e("code",[t._v("GET /jobs/{job_id}")])]),t._v(" "),e("td",[e("code",[t._v("describeJob()")])])]),t._v(" "),e("tr",[e("td",[t._v("Modify a job at the back-end.")]),t._v(" "),e("td",[e("code",[t._v("PATCH /jobs/{job_id}")])]),t._v(" "),e("td",[e("code",[t._v("updateJob(?process, ?title, ?description, ?plan, ?budget, ?additional)")])])]),t._v(" "),e("tr",[e("td",[t._v("Delete a job")]),t._v(" "),e("td",[e("code",[t._v("DELETE /jobs/{job_id}")])]),t._v(" "),e("td",[e("code",[t._v("deleteJob()")])])]),t._v(" "),e("tr",[e("td",[t._v("Calculate an time/cost estimate for a job.")]),t._v(" "),e("td",[e("code",[t._v("GET /jobs/{job_id}/estimate")])]),t._v(" "),e("td",[e("code",[t._v("estimateJob()")])])]),t._v(" "),e("tr",[e("td",[t._v("Get the log files for a job.")]),t._v(" "),e("td",[e("code",[t._v("GET /jobs/{job_id}/logs")])]),t._v(" "),e("td",[e("code",[t._v("debugJob()")])])]),t._v(" "),e("tr",[e("td",[t._v("Start / queue a job for processing.")]),t._v(" "),e("td",[e("code",[t._v("POST /jobs/{job_id}/results")])]),t._v(" "),e("td",[e("code",[t._v("startJob()")])])]),t._v(" "),e("tr",[e("td",[t._v("Stop / cancel job processing.")]),t._v(" "),e("td",[e("code",[t._v("DELETE /jobs/{job_id}/results")])]),t._v(" "),e("td",[e("code",[t._v("stopJob()")])])]),t._v(" "),e("tr",[e("td",[t._v("Get STAC catalog with download links.")]),t._v(" "),e("td",[e("code",[t._v("GET /jobs/{job_id}/results")])]),t._v(" "),e("td",[e("code",[t._v("listResults()")])])]),t._v(" "),e("tr",[e("td",[t._v("Download job results.")]),t._v(" "),e("td",[e("code",[t._v("GET /jobs/{job_id}/results")]),t._v(" > assets")]),t._v(" "),e("td",[e("code",[t._v("downloadResults(target)")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("target")]),t._v(" in "),e("code",[t._v("downloadResults")]),t._v(": Path to a local folder.")])]),t._v(" "),e("h3",{attrs:{id:"scope-userprocess-api-category"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scope-userprocess-api-category"}},[t._v("#")]),t._v(" Scope: "),e("code",[t._v("UserProcess")]),t._v(" (API category)")]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("UserProcess")]),t._v(" scope manages the user-defined processes and internally knows the "),e("code",[t._v("process_graph_id")]),t._v(".")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("API Request")]),t._v(" "),e("th",[t._v("Client method")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("Get information about a user-defined process.")]),t._v(" "),e("td",[e("code",[t._v("GET /process_graphs/{process_graph_id}")])]),t._v(" "),e("td",[e("code",[t._v("describeUserProcess()")])])]),t._v(" "),e("tr",[e("td",[t._v("Create or replace a user-defined process at the back-end.")]),t._v(" "),e("td",[e("code",[t._v("PUT /process_graphs/{process_graph_id}")])]),t._v(" "),e("td",[e("code",[t._v("replaceUserProcess(process)")])])]),t._v(" "),e("tr",[e("td",[t._v("Delete a user-defined process.")]),t._v(" "),e("td",[e("code",[t._v("DELETE /process_graphs/{process_graph_id}")])]),t._v(" "),e("td",[e("code",[t._v("deleteUserProcess()")])])])])]),t._v(" "),e("h3",{attrs:{id:"scope-service-api-category"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scope-service-api-category"}},[t._v("#")]),t._v(" Scope: "),e("code",[t._v("Service")]),t._v(" (API category)")]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("Service")]),t._v(" scope internally knows the "),e("code",[t._v("service_id")]),t._v(".")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("API Request")]),t._v(" "),e("th",[t._v("Client method")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("Get all information about a secondary web service.")]),t._v(" "),e("td",[e("code",[t._v("GET /services/{service_id}")])]),t._v(" "),e("td",[e("code",[t._v("describeService()")])])]),t._v(" "),e("tr",[e("td",[t._v("Get the log files for a web service.")]),t._v(" "),e("td",[e("code",[t._v("GET /services/{service_id}/logs")])]),t._v(" "),e("td",[e("code",[t._v("debugService()")])])]),t._v(" "),e("tr",[e("td",[t._v("Modify a secondary web service at the back-end.")]),t._v(" "),e("td",[e("code",[t._v("PATCH /services/{service_id}")])]),t._v(" "),e("td",[e("code",[t._v("updateService(?process, ?title, ?description, ?enabled, ?configuration, ?plan, ?budget, ?additional)")])])]),t._v(" "),e("tr",[e("td",[t._v("Delete a secondary web service.")]),t._v(" "),e("td",[e("code",[t._v("DELETE /services/{service_id}")])]),t._v(" "),e("td",[e("code",[t._v("deleteService()")])])])])]),t._v(" "),e("h2",{attrs:{id:"processes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#processes"}},[t._v("#")]),t._v(" Processes")]),t._v(" "),e("p",[t._v("The processes a back-end supports may be offered by the clients as methods in its own scope. The method names should follow the process names, but the conventions listed above can be applied here as well, e.g. converting "),e("code",[t._v("filter_bands")]),t._v(" to "),e("code",[t._v("filterBands")]),t._v(". As parameters have no natural or technical ordering in the JSON objects, clients must come up with a reasonable ordering of parameters if required. This could be inspired by existing clients. The way of building a process graph from processes heavily depends on the technical capabilities of the programming language. Therefore it may differ between the client libraries. Follow the best practices of the programming language, e.g. support method chaining if possible.")]),t._v(" "),e("h2",{attrs:{id:"workflow-example"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#workflow-example"}},[t._v("#")]),t._v(" Workflow example")]),t._v(" "),e("p",[t._v("Some simplified example workflows using different programming styles are listed below. The following steps are executed:")]),t._v(" "),e("ol",[e("li",[t._v("Loading the client library.")]),t._v(" "),e("li",[t._v("Connecting to a back-end and authenticating with username and password via OpenID Connect.")]),t._v(" "),e("li",[t._v("Requesting the capabilities and showing the implemented openEO version of the back-end.")]),t._v(" "),e("li",[t._v('Showing information about the "Sentinel-2A" collection.')]),t._v(" "),e("li",[t._v("Showing information about all processes supported by the back-end.")]),t._v(" "),e("li",[t._v("Building a simple process graph.")]),t._v(" "),e("li",[t._v("Creating a job.")]),t._v(" "),e("li",[t._v("Pushing the job to the processing queue.")]),t._v(" "),e("li",[t._v("After a while, showing the job details, e.g. checking the job status.")]),t._v(" "),e("li",[t._v("Once processing is finished, downloading the job results to the local directory "),e("code",[t._v("/tmp/job_results/")]),t._v(".")])]),t._v(" "),e("p",[t._v("Please note that the examples below do not comply to the latest process specification. They are meant to show the differences in client development, but are no working examples!")]),t._v(" "),e("h3",{attrs:{id:"r-functional-style"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#r-functional-style"}},[t._v("#")]),t._v(" R (functional style)")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("library"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("openeo"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\ncon "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" connect"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://openeo.org"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token ellipsis"}},[t._v("...")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ncap "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" capabilities"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ncap"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("api_version"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ndescribe_collection"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2A"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nlist_processes"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\ndatacube "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" datacube"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Chain processes, implementation is up to the client")]),t._v("\n\njob "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" createJob"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("process "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" datacube"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nstart_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ndescribe_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ndownload_results"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" folder "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"/tmp/job_results/"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("h3",{attrs:{id:"python-mixed-style"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#python-mixed-style"}},[t._v("#")]),t._v(" Python (mixed style)")]),t._v(" "),e("div",{staticClass:"language-python extra-class"},[e("pre",{pre:!0,attrs:{class:"language-python"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" openeo\n\ncon "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" openeo"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("connect"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://openeo.org"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("authenticate_basic"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"username"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"password"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ncap "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("capabilities"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("print")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cap"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("api_version"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("print")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("con"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("describe_collection"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2A"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("print")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("con"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("list_processes"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\ndatacube "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("load_collection"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Chain processes, implementation is up to the client")]),t._v("\n\njob "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" datacube"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("create_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\njob"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("start_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("print")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("describe_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\njob"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("download_results"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"/tmp/job_results/"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("h3",{attrs:{id:"java-object-oriented-style"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#java-object-oriented-style"}},[t._v("#")]),t._v(" Java (object oriented style)")]),t._v(" "),e("div",{staticClass:"language-java extra-class"},[e("pre",{pre:!0,attrs:{class:"language-java"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token import"}},[e("span",{pre:!0,attrs:{class:"token namespace"}},[t._v("org"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("openeo"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")])]),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")])]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),t._v(" obj "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Connection")]),t._v(" con "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" obj"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("connect")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://openeo.org"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Capabilities")]),t._v(" cap "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("capabilities")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("System")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("out"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("println")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cap"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("apiVersion")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("System")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("out"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("println")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("con"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("describeCollection")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2A"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("System")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("out"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("println")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("con"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("listProcesses")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("DataCube")]),t._v(" cube "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("createDataCube")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Chain processes, implementation is up to the client")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Job")]),t._v(" job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" cube"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("createJob")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\njob"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("startJob")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("System")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("out"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("println")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("describeJob")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\njob"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("downloadResults")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"/tmp/job_results/"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h3",{attrs:{id:"php-procedural-style"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#php-procedural-style"}},[t._v("#")]),t._v(" PHP (procedural style)")]),t._v(" "),e("div",{staticClass:"language-php extra-class"},[e("pre",{pre:!0,attrs:{class:"language-php"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("require_once")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"/path/to/openeo.php"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_connect")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"http://openeo.org"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$capabilities")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_capabilities")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_api_version")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$capabilites")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_describe_collection")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"Sentinel-2A"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_list_processes")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$datacube")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_datacube")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Chain processes, implementation is up to the client")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$job")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_create_job")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$datacube")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_start_job")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$job")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_describe_job")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$job")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_download_results")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$job")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"/tmp/job_results/"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[82],{525:function(t,e,s){"use strict";s.r(e);var a=s(4),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"client-library-development-guidelines"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#client-library-development-guidelines"}},[t._v("#")]),t._v(" Client library development guidelines")]),t._v(" "),e("p",[t._v("This is a proposal for workflows that client libraries should support to make the experience with each library similar and users can easily adopt examples and workflows.")]),t._v(" "),e("p",[t._v("For best experience libraries should still embrace best practices common in their environments. This means clients can...")]),t._v(" "),e("ul",[e("li",[t._v("choose which kind of casing they use (see below).")]),t._v(" "),e("li",[t._v("feel free to implement aliases for methods.")])]),t._v(" "),e("h2",{attrs:{id:"conventions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#conventions"}},[t._v("#")]),t._v(" Conventions")]),t._v(" "),e("h3",{attrs:{id:"casing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#casing"}},[t._v("#")]),t._v(" Casing")]),t._v(" "),e("p",[t._v("Clients can use "),e("code",[t._v("snake_case")]),t._v(", "),e("code",[t._v("camelCase")]),t._v(" or any method used commonly in their environment. For example, the API request to get a list of collections can either be names "),e("code",[t._v("get_collections")]),t._v(" or "),e("code",[t._v("getCollections")]),t._v(". This applies for all names, including scopes, method names and parameters.")]),t._v(" "),e("h3",{attrs:{id:"scopes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scopes"}},[t._v("#")]),t._v(" Scopes")]),t._v(" "),e("p",[t._v('Each method belongs to a scope. To achieve this in object-oriented (OO) programming languages, methods would be part of a class. If programming languages don\'t support scopes, you may need to simulate it somehow to prevent name collisions, e.g. by adding a prefix to the method names (like in the "procedural style" example below). Best practices for this will likely evolve over time.')]),t._v(" "),e("p",[t._v("Example for the "),e("code",[t._v("clientVersion")]),t._v(" method in "),e("code",[t._v("openEO")]),t._v(":")]),t._v(" "),e("ul",[e("li",[t._v("Procedural style: "),e("code",[t._v("openeo_client_version()")])]),t._v(" "),e("li",[t._v("Object-oriented style:"),e("div",{staticClass:"language-java extra-class"},[e("pre",{pre:!0,attrs:{class:"language-java"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),t._v(" obj "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nobj"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("clientVersion")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])]),t._v(" "),e("p",[t._v("If you can't store scope data in an object, you may need to pass these information as argument(s) to the method.")]),t._v(" "),e("p",[t._v("Example:")]),t._v(" "),e("ul",[e("li",[t._v("Procedural style:"),e("div",{staticClass:"language-php extra-class"},[e("pre",{pre:!0,attrs:{class:"language-php"}},[e("code",[e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_connect")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"https://openeo.org"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_capabilities")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])]),t._v(" "),e("li",[t._v("Object-oriented style:"),e("div",{staticClass:"language-java extra-class"},[e("pre",{pre:!0,attrs:{class:"language-java"}},[e("code",[e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),t._v(" obj "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Connection")]),t._v(" con "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" obj"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("connect")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://openeo.org"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\ncon"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("capabilities")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])]),t._v(" "),e("h3",{attrs:{id:"scope-categories"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scope-categories"}},[t._v("#")]),t._v(" Scope categories")]),t._v(" "),e("p",[t._v("Each scope is assigned to a scope category, of which there are three:")]),t._v(" "),e("ul",[e("li",[e("em",[t._v("Root")]),t._v(" category: Contains only the scope "),e("code",[t._v("openEO")]),t._v(".")]),t._v(" "),e("li",[e("em",[t._v("API")]),t._v(" category: Mostly methods hiding API calls to the back-ends. Methods may be implemented asynchronously. Contains the scopes "),e("code",[t._v("Connection")]),t._v(", "),e("code",[t._v("File")]),t._v(", "),e("code",[t._v("Job")]),t._v(", "),e("code",[t._v("UserProcess")]),t._v(", "),e("code",[t._v("Service")]),t._v(".")]),t._v(" "),e("li",[e("em",[t._v("Content")]),t._v(": Mostly methods hiding the complexity of response content. Methods are usually implemented synchronously. Currently contains only the scope "),e("code",[t._v("Capabilities")]),t._v(". Method names should be prefixed if name collisions are likely.")])]),t._v(" "),e("p",[t._v("Method names across ALL the scopes that belong to the "),e("em",[t._v("root")]),t._v(" or "),e("em",[t._v("API")]),t._v(" categories MUST be unique. This is the case because the parameter in "),e("code",[t._v("hasFeature(method_name)")]),t._v(" must be unambiguous.")]),t._v(" "),e("p",[t._v("Method names of scopes in the "),e("em",[t._v("Content")]),t._v(" category may collide with method names of scopes in the "),e("em",[t._v("root")]),t._v("/"),e("em",[t._v("API")]),t._v(" categories and names should be prefixed if collisions of names between different scope categories are to be expected.")]),t._v(" "),e("h3",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("p",[t._v("The parameters usually follow the request schemes in the openAPI specification. The parameters should follow their characteristics, for example regarding the default values.")]),t._v(" "),e("p",[t._v("Some methods have a long list of (optional) parameters. This is easy to implement in languages that support named parameters such as R. For example, creating a job in R with a budget would lead to this method call:")]),t._v(" "),e("div",{staticClass:"language-R extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("createJob"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("process_graph "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),e("span",{pre:!0,attrs:{class:"token ellipsis"}},[t._v("...")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" budget "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("123")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("Other languages that only support non-named parameters (i.e. the order of parameters is fixed) need to fill many parameters with default values, which is not convenient for a user. The example above in PHP would be:")]),t._v(" "),e("div",{staticClass:"language-php extra-class"},[e("pre",{pre:!0,attrs:{class:"language-php"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("createJob")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token constant"}},[t._v("null")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("123")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("p",[t._v("To avoid such method calls client developers should consider to pass either")]),t._v(" "),e("ul",[e("li",[t._v("an instance of a class, which contains all parameters as member variables or")]),t._v(" "),e("li",[t._v("the required parameters directly and the optional parameters as a dictionary (see example below).")])]),t._v(" "),e("p",[t._v("This basically emulates named parameters. The member variables / dictionary keys should use the same names as the parameters. The exemplary method call in PHP could be improved as follows:")]),t._v(" "),e("div",{staticClass:"language-php extra-class"},[e("pre",{pre:!0,attrs:{class:"language-php"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("createJob")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("budget "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("123")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("h2",{attrs:{id:"method-mappings"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#method-mappings"}},[t._v("#")]),t._v(" Method mappings")]),t._v(" "),e("p",[e("strong",[t._v("Note:")]),t._v(" Some scopes for response JSON objects are still missing. We are open for proposals.")]),t._v(" "),e("p",[t._v("Parameters with a leading "),e("code",[t._v("?")]),t._v(" are optional.")]),t._v(" "),e("h3",{attrs:{id:"scope-openeo-root-category"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scope-openeo-root-category"}},[t._v("#")]),t._v(" Scope: "),e("code",[t._v("openEO")]),t._v(" (root category)")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Client method")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("Connect to a back-end, includes version discovery ("),e("code",[t._v("GET /.well-known/openeo")]),t._v("), requesting capabilities and authentication where required. Returns "),e("code",[t._v("Connection")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("connect(url, ?authType, ?authOptions)")])])]),t._v(" "),e("tr",[e("td",[t._v("Get client library version.")]),t._v(" "),e("td",[e("code",[t._v("clientVersion()")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("authType")]),t._v(" in "),e("code",[t._v("connect")]),t._v(": "),e("code",[t._v("null")]),t._v(", "),e("code",[t._v("basic")]),t._v(" or "),e("code",[t._v("oidc")]),t._v(" (non-exclusive). Defaults to "),e("code",[t._v("null")]),t._v(" (no authentication).")]),t._v(" "),e("li",[e("strong",[t._v("authOptions")]),t._v(" in "),e("code",[t._v("connect")]),t._v(": May hold additional data for authentication, for example a username and password for "),e("code",[t._v("basic")]),t._v(" authentication.")])]),t._v(" "),e("h3",{attrs:{id:"scope-connection-api-category"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scope-connection-api-category"}},[t._v("#")]),t._v(" Scope: "),e("code",[t._v("Connection")]),t._v(" (API category)")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("API Request")]),t._v(" "),e("th",[t._v("Client method")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("Get the capabilities of the back-end. Returns "),e("code",[t._v("Capabilities")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("GET /")])]),t._v(" "),e("td",[e("code",[t._v("capabilities()")])])]),t._v(" "),e("tr",[e("td",[t._v("List the supported output file formats.")]),t._v(" "),e("td",[e("code",[t._v("GET /file_formats")])]),t._v(" "),e("td",[e("code",[t._v("listFileTypes()")])])]),t._v(" "),e("tr",[e("td",[t._v("List the supported secondary service types.")]),t._v(" "),e("td",[e("code",[t._v("GET /service_types")])]),t._v(" "),e("td",[e("code",[t._v("listServiceTypes()")])])]),t._v(" "),e("tr",[e("td",[t._v("List the supported UDF runtimes.")]),t._v(" "),e("td",[e("code",[t._v("GET /udf_runtimes")])]),t._v(" "),e("td",[e("code",[t._v("listUdfRuntimes()")])])]),t._v(" "),e("tr",[e("td",[t._v("List all collections available on the back-end.")]),t._v(" "),e("td",[e("code",[t._v("GET /collections")])]),t._v(" "),e("td",[e("code",[t._v("listCollections()")])])]),t._v(" "),e("tr",[e("td",[t._v("Get information about a single collection.")]),t._v(" "),e("td",[e("code",[t._v("GET /collections/{collection_id}")])]),t._v(" "),e("td",[e("code",[t._v("describeCollection(collection_id)")])])]),t._v(" "),e("tr",[e("td",[t._v("List all pre-defined processes available on the back-end.")]),t._v(" "),e("td",[e("code",[t._v("GET /processes")])]),t._v(" "),e("td",[e("code",[t._v("listProcesses()")])])]),t._v(" "),e("tr",[e("td",[t._v("List authentication providers (may also list HTTP Basic).")]),t._v(" "),e("td",[e("code",[t._v("GET /credentials/oidc")]),t._v(" / "),e("code",[t._v("GET /credentials/basic")])]),t._v(" "),e("td",[e("code",[t._v("listAuthProviders()")])])]),t._v(" "),e("tr",[e("td",[t._v("Get information about the authenticated user.")]),t._v(" "),e("td",[e("code",[t._v("GET /me")])]),t._v(" "),e("td",[e("code",[t._v("describeAccount()")])])]),t._v(" "),e("tr",[e("td",[t._v("Lists all files from a user. Returns a list of "),e("code",[t._v("File")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("GET /files")])]),t._v(" "),e("td",[e("code",[t._v("listFiles()")])])]),t._v(" "),e("tr",[e("td",[t._v("Opens an (existing or non-existing) file without reading it. Returns a "),e("code",[t._v("File")]),t._v(".")]),t._v(" "),e("td",[e("em",[t._v("None")])]),t._v(" "),e("td",[e("code",[t._v("getFile(path)")])])]),t._v(" "),e("tr",[e("td",[t._v("Upload a user file. Returns a "),e("code",[t._v("File")]),t._v(".")]),t._v(" "),e("td",[t._v("Shortcut: "),e("code",[t._v("getFile(path).uploadFile(source)")])]),t._v(" "),e("td",[e("code",[t._v("uploadFile(source, path)")])])]),t._v(" "),e("tr",[e("td",[t._v("Validates a process graph.")]),t._v(" "),e("td",[e("code",[t._v("POST /validation")])]),t._v(" "),e("td",[e("code",[t._v("validateProcess(process)")])])]),t._v(" "),e("tr",[e("td",[t._v("Lists all user-defined processes of the authenticated user. Returns a list of "),e("code",[t._v("UserProcess")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("GET /process_graphs")])]),t._v(" "),e("td",[e("code",[t._v("listUserProcesses()")])])]),t._v(" "),e("tr",[e("td",[t._v("Creates a new user-defined process. Returns a "),e("code",[t._v("UserProcess")]),t._v(".")]),t._v(" "),e("td",[t._v("Shortcut: "),e("code",[t._v("getUserProcess(id).replaceUserProcess(process)")])]),t._v(" "),e("td",[e("code",[t._v("setUserProcess(id, process)")])])]),t._v(" "),e("tr",[e("td",[t._v("Get all information about a user-defined process. Returns a "),e("code",[t._v("UserProcess")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("GET /process_graphs/{process_graph_id}")])]),t._v(" "),e("td",[e("code",[t._v("getUserProcess(id)")])])]),t._v(" "),e("tr",[e("td",[t._v("Executes a process graph synchronously.")]),t._v(" "),e("td",[e("code",[t._v("POST /result")])]),t._v(" "),e("td",[e("code",[t._v("computeResult(process, ?plan, ?budget, ?additional)")])])]),t._v(" "),e("tr",[e("td",[t._v("Lists all jobs of the authenticated user. Returns a list of "),e("code",[t._v("Job")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("GET /jobs")])]),t._v(" "),e("td",[e("code",[t._v("listJobs()")])])]),t._v(" "),e("tr",[e("td",[t._v("Creates a new job. Returns a "),e("code",[t._v("Job")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("POST /jobs")])]),t._v(" "),e("td",[e("code",[t._v("createJob(process, ?title, ?description, ?plan, ?budget, ?additional)")])])]),t._v(" "),e("tr",[e("td",[t._v("Get all information about a job. Returns a "),e("code",[t._v("Job")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("GET /jobs/{job_id}")])]),t._v(" "),e("td",[e("code",[t._v("getJob(id)")])])]),t._v(" "),e("tr",[e("td",[t._v("Lists all secondary services of the authenticated user. Returns a list of "),e("code",[t._v("Service")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("GET /services")])]),t._v(" "),e("td",[e("code",[t._v("listServices()")])])]),t._v(" "),e("tr",[e("td",[t._v("Creates a new secondary service. Returns a "),e("code",[t._v("Service")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("POST /services")])]),t._v(" "),e("td",[e("code",[t._v("createService(process, type, ?title, ?description, ?enabled, ?parameters, ?plan, ?budget, ?additional)")])])]),t._v(" "),e("tr",[e("td",[t._v("Get all information about a service. Returns a "),e("code",[t._v("Service")]),t._v(".")]),t._v(" "),e("td",[e("code",[t._v("GET /services/{service_id}")])]),t._v(" "),e("td",[e("code",[t._v("getService(id)")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("options")]),t._v(" in "),e("code",[t._v("authenticateOIDC")]),t._v(": May hold additional data required for OpenID connect authentication.")]),t._v(" "),e("li",[e("strong",[t._v("additional")]),t._v(" in "),e("code",[t._v("createJob")]),t._v(" and "),e("code",[t._v("createService")]),t._v(" (also below in "),e("code",[t._v("updateJob")]),t._v(" and "),e("code",[t._v("updateService")]),t._v("): May hold additional key-value-pairs as object. The object should be merged with the body of the request.")])]),t._v(" "),e("h3",{attrs:{id:"scope-capabilities-content-category"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scope-capabilities-content-category"}},[t._v("#")]),t._v(" Scope "),e("code",[t._v("Capabilities")]),t._v(" (Content category)")]),t._v(" "),e("p",[t._v("Should be prefixed with "),e("code",[t._v("Capabilities")]),t._v(" if collisions of names between different scope categories are to be expected.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("Field")]),t._v(" "),e("th",[t._v("Client method")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("Get the implemented openEO version.")]),t._v(" "),e("td",[e("code",[t._v("api_version")])]),t._v(" "),e("td",[e("code",[t._v("apiVersion()")])])]),t._v(" "),e("tr",[e("td",[t._v("Get the back-end version.")]),t._v(" "),e("td",[e("code",[t._v("backend_version")])]),t._v(" "),e("td",[e("code",[t._v("backendVersion()")])])]),t._v(" "),e("tr",[e("td",[t._v("Is the back-end suitable for use in production?")]),t._v(" "),e("td",[e("code",[t._v("production")])]),t._v(" "),e("td",[e("code",[t._v("isStable()")])])]),t._v(" "),e("tr",[e("td",[t._v("Get the name of the back-end.")]),t._v(" "),e("td",[e("code",[t._v("title")])]),t._v(" "),e("td",[e("code",[t._v("title()")])])]),t._v(" "),e("tr",[e("td",[t._v("Get the description of the back-end.")]),t._v(" "),e("td",[e("code",[t._v("description")])]),t._v(" "),e("td",[e("code",[t._v("description()")])])]),t._v(" "),e("tr",[e("td",[t._v("List all supported features / endpoints.")]),t._v(" "),e("td",[e("code",[t._v("endpoints")])]),t._v(" "),e("td",[e("code",[t._v("listFeatures()")])])]),t._v(" "),e("tr",[e("td",[t._v("Check whether a feature / endpoint is supported.")]),t._v(" "),e("td",[e("code",[t._v("endpoints")]),t._v(" > ...")]),t._v(" "),e("td",[e("code",[t._v("hasFeature(methodName)")])])]),t._v(" "),e("tr",[e("td",[t._v("Get the default billing currency.")]),t._v(" "),e("td",[e("code",[t._v("billing")]),t._v(" > "),e("code",[t._v("currency")])]),t._v(" "),e("td",[e("code",[t._v("currency()")])])]),t._v(" "),e("tr",[e("td",[t._v("List all billing plans.")]),t._v(" "),e("td",[e("code",[t._v("billing")]),t._v(" > "),e("code",[t._v("plans")])]),t._v(" "),e("td",[e("code",[t._v("listPlans()")])])]),t._v(" "),e("tr",[e("td",[t._v("List all links.")]),t._v(" "),e("td",[e("code",[t._v("links")])]),t._v(" "),e("td",[e("code",[t._v("links()")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("methodName")]),t._v(" in "),e("code",[t._v("hasFeature")]),t._v(": The name of a client method in any of the scopes that are part of the "),e("em",[t._v("API")]),t._v(" category. E.g. "),e("code",[t._v('hasFeature("describeAccount")')]),t._v(" checks whether the "),e("code",[t._v("GET /me")]),t._v(" endpoint is contained in the capabilities response's "),e("code",[t._v("endpoints")]),t._v(" object.")])]),t._v(" "),e("h3",{attrs:{id:"scope-file-api-category"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scope-file-api-category"}},[t._v("#")]),t._v(" Scope: "),e("code",[t._v("File")]),t._v(" (API category)")]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("File")]),t._v(" scope internally knows the "),e("code",[t._v("path")]),t._v(".")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("API Request")]),t._v(" "),e("th",[t._v("Client method")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("Download a user file.")]),t._v(" "),e("td",[e("code",[t._v("GET /files/{path}")])]),t._v(" "),e("td",[e("code",[t._v("downloadFile(target)")])])]),t._v(" "),e("tr",[e("td",[t._v("Upload a user file.")]),t._v(" "),e("td",[e("code",[t._v("PUT /files/{path}")])]),t._v(" "),e("td",[e("code",[t._v("uploadFile(source)")])])]),t._v(" "),e("tr",[e("td",[t._v("Delete a user file.")]),t._v(" "),e("td",[e("code",[t._v("DELETE /files/{path}")])]),t._v(" "),e("td",[e("code",[t._v("deleteFile()")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("target")]),t._v(" in "),e("code",[t._v("downloadFile")]),t._v(": Path to a local file or folder.")])]),t._v(" "),e("h3",{attrs:{id:"scope-job-api-category"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scope-job-api-category"}},[t._v("#")]),t._v(" Scope: "),e("code",[t._v("Job")]),t._v(" (API category)")]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("Job")]),t._v(" scope internally knows the "),e("code",[t._v("job_id")]),t._v(".")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("API Request")]),t._v(" "),e("th",[t._v("Client method")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("Get all job information.")]),t._v(" "),e("td",[e("code",[t._v("GET /jobs/{job_id}")])]),t._v(" "),e("td",[e("code",[t._v("describeJob()")])])]),t._v(" "),e("tr",[e("td",[t._v("Modify a job at the back-end.")]),t._v(" "),e("td",[e("code",[t._v("PATCH /jobs/{job_id}")])]),t._v(" "),e("td",[e("code",[t._v("updateJob(?process, ?title, ?description, ?plan, ?budget, ?additional)")])])]),t._v(" "),e("tr",[e("td",[t._v("Delete a job")]),t._v(" "),e("td",[e("code",[t._v("DELETE /jobs/{job_id}")])]),t._v(" "),e("td",[e("code",[t._v("deleteJob()")])])]),t._v(" "),e("tr",[e("td",[t._v("Calculate an time/cost estimate for a job.")]),t._v(" "),e("td",[e("code",[t._v("GET /jobs/{job_id}/estimate")])]),t._v(" "),e("td",[e("code",[t._v("estimateJob()")])])]),t._v(" "),e("tr",[e("td",[t._v("Get the log files for a job.")]),t._v(" "),e("td",[e("code",[t._v("GET /jobs/{job_id}/logs")])]),t._v(" "),e("td",[e("code",[t._v("debugJob()")])])]),t._v(" "),e("tr",[e("td",[t._v("Start / queue a job for processing.")]),t._v(" "),e("td",[e("code",[t._v("POST /jobs/{job_id}/results")])]),t._v(" "),e("td",[e("code",[t._v("startJob()")])])]),t._v(" "),e("tr",[e("td",[t._v("Stop / cancel job processing.")]),t._v(" "),e("td",[e("code",[t._v("DELETE /jobs/{job_id}/results")])]),t._v(" "),e("td",[e("code",[t._v("stopJob()")])])]),t._v(" "),e("tr",[e("td",[t._v("Get STAC catalog with download links.")]),t._v(" "),e("td",[e("code",[t._v("GET /jobs/{job_id}/results")])]),t._v(" "),e("td",[e("code",[t._v("listResults()")])])]),t._v(" "),e("tr",[e("td",[t._v("Download job results.")]),t._v(" "),e("td",[e("code",[t._v("GET /jobs/{job_id}/results")]),t._v(" > assets")]),t._v(" "),e("td",[e("code",[t._v("downloadResults(target)")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("target")]),t._v(" in "),e("code",[t._v("downloadResults")]),t._v(": Path to a local folder.")])]),t._v(" "),e("h3",{attrs:{id:"scope-userprocess-api-category"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scope-userprocess-api-category"}},[t._v("#")]),t._v(" Scope: "),e("code",[t._v("UserProcess")]),t._v(" (API category)")]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("UserProcess")]),t._v(" scope manages the user-defined processes and internally knows the "),e("code",[t._v("process_graph_id")]),t._v(".")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("API Request")]),t._v(" "),e("th",[t._v("Client method")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("Get information about a user-defined process.")]),t._v(" "),e("td",[e("code",[t._v("GET /process_graphs/{process_graph_id}")])]),t._v(" "),e("td",[e("code",[t._v("describeUserProcess()")])])]),t._v(" "),e("tr",[e("td",[t._v("Create or replace a user-defined process at the back-end.")]),t._v(" "),e("td",[e("code",[t._v("PUT /process_graphs/{process_graph_id}")])]),t._v(" "),e("td",[e("code",[t._v("replaceUserProcess(process)")])])]),t._v(" "),e("tr",[e("td",[t._v("Delete a user-defined process.")]),t._v(" "),e("td",[e("code",[t._v("DELETE /process_graphs/{process_graph_id}")])]),t._v(" "),e("td",[e("code",[t._v("deleteUserProcess()")])])])])]),t._v(" "),e("h3",{attrs:{id:"scope-service-api-category"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scope-service-api-category"}},[t._v("#")]),t._v(" Scope: "),e("code",[t._v("Service")]),t._v(" (API category)")]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("Service")]),t._v(" scope internally knows the "),e("code",[t._v("service_id")]),t._v(".")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Description")]),t._v(" "),e("th",[t._v("API Request")]),t._v(" "),e("th",[t._v("Client method")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("Get all information about a secondary web service.")]),t._v(" "),e("td",[e("code",[t._v("GET /services/{service_id}")])]),t._v(" "),e("td",[e("code",[t._v("describeService()")])])]),t._v(" "),e("tr",[e("td",[t._v("Get the log files for a web service.")]),t._v(" "),e("td",[e("code",[t._v("GET /services/{service_id}/logs")])]),t._v(" "),e("td",[e("code",[t._v("debugService()")])])]),t._v(" "),e("tr",[e("td",[t._v("Modify a secondary web service at the back-end.")]),t._v(" "),e("td",[e("code",[t._v("PATCH /services/{service_id}")])]),t._v(" "),e("td",[e("code",[t._v("updateService(?process, ?title, ?description, ?enabled, ?configuration, ?plan, ?budget, ?additional)")])])]),t._v(" "),e("tr",[e("td",[t._v("Delete a secondary web service.")]),t._v(" "),e("td",[e("code",[t._v("DELETE /services/{service_id}")])]),t._v(" "),e("td",[e("code",[t._v("deleteService()")])])])])]),t._v(" "),e("h2",{attrs:{id:"processes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#processes"}},[t._v("#")]),t._v(" Processes")]),t._v(" "),e("p",[t._v("The processes a back-end supports may be offered by the clients as methods in its own scope. The method names should follow the process names, but the conventions listed above can be applied here as well, e.g. converting "),e("code",[t._v("filter_bands")]),t._v(" to "),e("code",[t._v("filterBands")]),t._v(". As parameters have no natural or technical ordering in the JSON objects, clients must come up with a reasonable ordering of parameters if required. This could be inspired by existing clients. The way of building a process graph from processes heavily depends on the technical capabilities of the programming language. Therefore it may differ between the client libraries. Follow the best practices of the programming language, e.g. support method chaining if possible.")]),t._v(" "),e("h2",{attrs:{id:"workflow-example"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#workflow-example"}},[t._v("#")]),t._v(" Workflow example")]),t._v(" "),e("p",[t._v("Some simplified example workflows using different programming styles are listed below. The following steps are executed:")]),t._v(" "),e("ol",[e("li",[t._v("Loading the client library.")]),t._v(" "),e("li",[t._v("Connecting to a back-end and authenticating with username and password via OpenID Connect.")]),t._v(" "),e("li",[t._v("Requesting the capabilities and showing the implemented openEO version of the back-end.")]),t._v(" "),e("li",[t._v('Showing information about the "Sentinel-2A" collection.')]),t._v(" "),e("li",[t._v("Showing information about all processes supported by the back-end.")]),t._v(" "),e("li",[t._v("Building a simple process graph.")]),t._v(" "),e("li",[t._v("Creating a job.")]),t._v(" "),e("li",[t._v("Pushing the job to the processing queue.")]),t._v(" "),e("li",[t._v("After a while, showing the job details, e.g. checking the job status.")]),t._v(" "),e("li",[t._v("Once processing is finished, downloading the job results to the local directory "),e("code",[t._v("/tmp/job_results/")]),t._v(".")])]),t._v(" "),e("p",[t._v("Please note that the examples below do not comply to the latest process specification. They are meant to show the differences in client development, but are no working examples!")]),t._v(" "),e("h3",{attrs:{id:"r-functional-style"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#r-functional-style"}},[t._v("#")]),t._v(" R (functional style)")]),t._v(" "),e("div",{staticClass:"language-r extra-class"},[e("pre",{pre:!0,attrs:{class:"language-r"}},[e("code",[t._v("library"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("openeo"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\ncon "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" connect"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://openeo.org"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token ellipsis"}},[t._v("...")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ncap "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" capabilities"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ncap"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("$")]),t._v("api_version"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ndescribe_collection"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2A"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nlist_processes"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\ndatacube "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" datacube"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Chain processes, implementation is up to the client")]),t._v("\n\njob "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" createJob"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("process "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" datacube"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\nstart_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ndescribe_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ndownload_results"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" folder "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"/tmp/job_results/"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("h3",{attrs:{id:"python-mixed-style"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#python-mixed-style"}},[t._v("#")]),t._v(" Python (mixed style)")]),t._v(" "),e("div",{staticClass:"language-python extra-class"},[e("pre",{pre:!0,attrs:{class:"language-python"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" openeo\n\ncon "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" openeo"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("connect"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://openeo.org"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("authenticate_basic"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"username"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"password"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\ncap "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("capabilities"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("print")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cap"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("api_version"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("print")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("con"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("describe_collection"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2A"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("print")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("con"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("list_processes"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\ndatacube "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("load_collection"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Chain processes, implementation is up to the client")]),t._v("\n\njob "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" datacube"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("create_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\njob"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("start_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("print")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("describe_job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\njob"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("download_results"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"/tmp/job_results/"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),e("h3",{attrs:{id:"java-object-oriented-style"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#java-object-oriented-style"}},[t._v("#")]),t._v(" Java (object oriented style)")]),t._v(" "),e("div",{staticClass:"language-java extra-class"},[e("pre",{pre:!0,attrs:{class:"language-java"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token import"}},[e("span",{pre:!0,attrs:{class:"token namespace"}},[t._v("org"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("openeo"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")])]),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")])]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),t._v(" obj "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("OpenEO")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Connection")]),t._v(" con "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" obj"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("connect")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://openeo.org"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Capabilities")]),t._v(" cap "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("capabilities")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("System")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("out"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("println")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cap"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("apiVersion")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("System")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("out"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("println")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("con"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("describeCollection")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Sentinel-2A"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("System")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("out"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("println")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("con"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("listProcesses")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("DataCube")]),t._v(" cube "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" con"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("createDataCube")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Chain processes, implementation is up to the client")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Job")]),t._v(" job "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" cube"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("createJob")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\njob"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("startJob")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("System")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("out"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("println")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("job"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("describeJob")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\njob"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("downloadResults")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"/tmp/job_results/"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h3",{attrs:{id:"php-procedural-style"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#php-procedural-style"}},[t._v("#")]),t._v(" PHP (procedural style)")]),t._v(" "),e("div",{staticClass:"language-php extra-class"},[e("pre",{pre:!0,attrs:{class:"language-php"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("require_once")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"/path/to/openeo.php"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_connect")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"http://openeo.org"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$capabilities")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_capabilities")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_api_version")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$capabilites")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_describe_collection")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"Sentinel-2A"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_list_processes")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$datacube")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_datacube")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Chain processes, implementation is up to the client")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$job")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_create_job")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$connection")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$datacube")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_start_job")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$job")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_describe_job")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$job")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("openeo_download_results")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$job")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"/tmp/job_results/"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/83.58b5665f.js b/assets/js/83.d4d93c73.js similarity index 93% rename from assets/js/83.58b5665f.js rename to assets/js/83.d4d93c73.js index cd662d8a3..9bb54416f 100644 --- a/assets/js/83.58b5665f.js +++ b/assets/js/83.d4d93c73.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[83],{525:function(e,t,o){"use strict";o.r(t);var s=o(4),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"openeo-profiles"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#openeo-profiles"}},[e._v("#")]),e._v(" openEO Profiles")]),e._v(" "),t("p",[e._v("We've defined requirements grouped into a set of profiles for the openEO API and the openEO Processes. This helps to classify the implementation status of an openEO instance and gives recommendations to implementors which functionality to prioritize.")]),e._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/documentation/1.0/developers/profiles/api.html"}},[e._v("API Profiles")])],1),e._v(" "),t("li",[t("RouterLink",{attrs:{to:"/documentation/1.0/developers/profiles/processes.html"}},[e._v("Process Profiles")])],1)])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[83],{524:function(e,t,o){"use strict";o.r(t);var s=o(4),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"openeo-profiles"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#openeo-profiles"}},[e._v("#")]),e._v(" openEO Profiles")]),e._v(" "),t("p",[e._v("We've defined requirements grouped into a set of profiles for the openEO API and the openEO Processes. This helps to classify the implementation status of an openEO instance and gives recommendations to implementors which functionality to prioritize.")]),e._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/documentation/1.0/developers/profiles/api.html"}},[e._v("API Profiles")])],1),e._v(" "),t("li",[t("RouterLink",{attrs:{to:"/documentation/1.0/developers/profiles/processes.html"}},[e._v("Process Profiles")])],1)])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/84.92a8e2cc.js b/assets/js/84.e3f4445a.js similarity index 99% rename from assets/js/84.92a8e2cc.js rename to assets/js/84.e3f4445a.js index 0a45e86af..eedfeca63 100644 --- a/assets/js/84.92a8e2cc.js +++ b/assets/js/84.e3f4445a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[84],{528:function(e,t,a){"use strict";a.r(t);var o=a(4),r=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"glossary"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#glossary"}},[e._v("#")]),e._v(" Glossary")]),e._v(" "),t("p",[e._v("This glossary introduces the major technical terms used in the openEO project.")]),e._v(" "),t("h2",{attrs:{id:"general-terms"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#general-terms"}},[e._v("#")]),e._v(" General terms")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("EO")]),e._v(": Earth observation")]),e._v(" "),t("li",[t("strong",[e._v("API")]),e._v(": application programming interface ("),t("a",{attrs:{href:"https://en.wikipedia.org/wiki/Application_programming_interface",target:"_blank",rel:"noopener noreferrer"}},[e._v("wikipedia"),t("OutboundLink")],1),e._v("); a communication protocol between client and back-end")]),e._v(" "),t("li",[t("strong",[e._v("client")]),e._v(": software tool or environment that end-users directly interact with, e.g. R (RStudio), Python (Jupyter notebook), and JavaScript (web browser); R and Python are two major data science platforms; JavaScript is a major language for web development")]),e._v(" "),t("li",[t("strong",[e._v("(cloud) back-end")]),e._v(": server; computer infrastructure (one or more physical computers or virtual machines) used for storing EO data and processing it")]),e._v(" "),t("li",[t("strong",[e._v("big Earth observation cloud back-end")]),e._v(": server infrastructure where industry and researchers analyse large amounts of EO data")])]),e._v(" "),t("h2",{attrs:{id:"processes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#processes"}},[e._v("#")]),e._v(" Processes")]),e._v(" "),t("p",[e._v("A "),t("strong",[e._v("process")]),e._v(" is an operation that performs a specific task on a set of parameters and returns a result. An example is computing a statistical operation, such as mean or median, on selected EO data. A process is similar to a function or method in programming languages.")]),e._v(" "),t("p",[e._v("A "),t("strong",[e._v("pre-defined process")]),e._v(" is a process provided by the "),t("em",[e._v("back-end")]),e._v(", often one of the "),t("RouterLink",{attrs:{to:"/documentation/1.0/processes.html"}},[e._v("ones centrally defined by openEO")]),e._v(".")],1),e._v(" "),t("p",[e._v("A "),t("strong",[e._v("user-defined process")]),e._v(" is a process defined by the "),t("em",[e._v("user")]),e._v(". It can directly be part of another process graph or be stored as custom process on a back-end. Internally it is a "),t("em",[e._v("process graph")]),e._v(" with optional additional metadata.")]),e._v(" "),t("p",[e._v("A "),t("strong",[e._v("process graph")]),e._v(" chains specific process calls from the set of pre-defined and user-defined processes together. A process graph itself is a (user-defined) process again. Similarly to scripts in the context of programming, process graphs organize and automate the execution of one or more processes that could alternatively be executed individually.")]),e._v(" "),t("h2",{attrs:{id:"eo-data-collections"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#eo-data-collections"}},[e._v("#")]),e._v(" EO data (Collections)")]),e._v(" "),t("p",[e._v("In our domain, different terms are used to describe EO data(sets). Within openEO, a "),t("strong",[e._v("granule")]),e._v(" (sometimes also called "),t("em",[e._v("item")]),e._v(" or "),t("em",[e._v("asset")]),e._v(" in the specification) typically refers to a limited area and a single overpass leading to a very short observation period (seconds) or a temporal aggregation of such data (e.g. for 16-day MODIS composites). A "),t("strong",[e._v("collection")]),e._v(" is a sequence of granules sharing the same product specification. It typically corresponds to the series of products derived from data acquired by a sensor on board a satellite and having the same mode of operation.")]),e._v(" "),t("p",[e._v("The "),t("a",{attrs:{href:"http://ceos.org/ourwork/workinggroups/wgiss/access/opensearch/",target:"_blank",rel:"noopener noreferrer"}},[e._v("CEOS OpenSearch Best Practice Document v1.2"),t("OutboundLink")],1),e._v(" lists the following synonyms used by other organizations:")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("granule")]),e._v(": dataset (ESA, ISO 19115), granule (NASA), product (ESA, CNES), scene (JAXA)")]),e._v(" "),t("li",[t("strong",[e._v("collection")]),e._v(": dataset series (ESA, ISO 19115), collection (CNES, NASA), dataset (JAXA), product (JAXA)")])]),e._v(" "),t("p",[e._v("In openEO, a back-end offers a set of collections to be processed. All collections can be requested using a client and are described using the "),t("a",{attrs:{href:"https://github.com/radiantearth/stac-spec",target:"_blank",rel:"noopener noreferrer"}},[e._v("STAC (SpatioTemporal Asset Catalog) metadata specification"),t("OutboundLink")],1),e._v(" as STAC collections. A user can load (a subset of) a collection using a special process, which returns a (spatial) datacube. All further processing is then applied to the datacube on the back-end.")]),e._v(" "),t("h2",{attrs:{id:"spatial-datacubes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#spatial-datacubes"}},[e._v("#")]),e._v(" Spatial datacubes")]),e._v(" "),t("p",[e._v("A spatiotemporal datacube is a multidimensional array with one or more spatial or temporal dimensions.\nIn the EO domain, it is common to be implicit about the temporal dimension and just refer to them as spatial datacubes in short.\nSpecial cases are raster and "),t("a",{attrs:{href:"https://r-spatial.org/r/2022/09/12/vdc.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("vector datacubes"),t("OutboundLink")],1),e._v(".\nLearn more about datacubes in the "),t("a",{attrs:{href:"https://openeo.org/documentation/1.0/datacubes.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("datacube documentation"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"vector-data"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#vector-data"}},[e._v("#")]),e._v(" Vector data")]),e._v(" "),t("p",[e._v("In general, "),t("strong",[e._v("vector data")]),e._v(' represent specific things (also called "features") in a space, e.g. on the surface of the Earth.')]),e._v(" "),t("p",[e._v("A "),t("strong",[e._v("coordinate")]),e._v(" represents a specific point in space.")]),e._v(" "),t("p",[e._v("A "),t("strong",[e._v("feature")]),e._v(' is a thing that usually has a geometry (e.g. the outline of an agricultural field, a forest or an urban area) and it may have additional properties assigned (e.g. a name, a color or a population).\nIn rare cases features may not have a geometry, which is often referred to as an "empty geometry".')]),e._v(" "),t("p",[t("strong",[e._v("Geometries")]),e._v(" consist of one or more coordinates that may be connected and then form a specific type of geometry, e.g. two points can be connected to a straight line and four straight lines can be connected to rectangle.")]),e._v(" "),t("p",[e._v("Commonly used types of geometries are:")]),e._v(" "),t("ul",[t("li",[e._v("Point")]),e._v(" "),t("li",[e._v("LineString (connected straight line pieces)")]),e._v(" "),t("li",[e._v("Polygon (connected straight line pieces forming a closed ring, possibly with holes - for example a triangle or rectangle)")])]),e._v(" "),t("p",[e._v('Multiple geometries of the same type can be combined into a group of geometries, e.g. a so-called "multi point" or "multi polygon".')]),e._v(" "),t("p",[e._v("Features and geometries are specified by the OGC in the "),t("a",{attrs:{href:"https://www.ogc.org/standards/sfa",target:"_blank",rel:"noopener noreferrer"}},[e._v("Simple Feature Access specification"),t("OutboundLink")],1),e._v(" (and ISO 19125). See the specification for more details.")]),e._v(" "),t("h2",{attrs:{id:"user-defined-function-udf"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#user-defined-function-udf"}},[e._v("#")]),e._v(" User-defined function (UDF)")]),e._v(" "),t("p",[e._v("The abbreviation "),t("strong",[e._v("UDF")]),e._v(" stands for "),t("strong",[e._v("user-defined function")]),e._v(". With this concept, users are able to upload custom code and have it executed e.g. for every pixel of a scene, or applied to a particular dimension or set of dimensions, allowing custom server-side calculations. See the section on "),t("RouterLink",{attrs:{to:"/documentation/1.0/udfs.html"}},[e._v("UDFs")]),e._v(" for more information.")],1),e._v(" "),t("h2",{attrs:{id:"data-processing-modes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#data-processing-modes"}},[e._v("#")]),e._v(" Data Processing modes")]),e._v(" "),t("p",[e._v("Processes can run in three different ways:")]),e._v(" "),t("ol",[t("li",[e._v("Results can be pre-computed by creating a "),t("em",[t("strong",[e._v("batch job")])]),e._v(". They are submitted to the back-end's processing system, but will remain inactive until explicitly put into the processing queue. They will run only once and store results after execution. Results can be downloaded. Batch jobs are typically time consuming and user interaction is not possible although log files are generated for them. This is the only mode that allows to get an estimate about time, volume and costs beforehand.")]),e._v(" "),t("li",[e._v("A more dynamic way of processing and accessing data is to create a "),t("strong",[e._v("secondary web service")]),e._v(". They allow web-based access using different protocols such as "),t("a",{attrs:{href:"http://www.opengeospatial.org/standards/wms",target:"_blank",rel:"noopener noreferrer"}},[e._v("OGC WMS"),t("OutboundLink")],1),e._v(" (Open Geospatial Consortium Web Map Service), "),t("a",{attrs:{href:"http://www.opengeospatial.org/standards/wcs",target:"_blank",rel:"noopener noreferrer"}},[e._v("OGC WCS"),t("OutboundLink")],1),e._v(" (Web Coverage Service) or "),t("a",{attrs:{href:"https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames",target:"_blank",rel:"noopener noreferrer"}},[e._v("XYZ tiles"),t("OutboundLink")],1),e._v(". These protocols usually allow users to change the viewing extent or level of detail (zoom level). Therefore, computations often run "),t("em",[e._v("on demand")]),e._v(" so that the requested data is calculated during the request. Back-ends should make sure to cache processed data to avoid additional/high costs and reduce waiting times for the user.")]),e._v(" "),t("li",[e._v("Processes can also be executed "),t("strong",[e._v("on-demand")]),e._v(" (i.e. synchronously). Results are delivered with the request itself and no job is created. Only lightweight computations, for example previews, should be executed using this approach as timeouts are to be expected for "),t("a",{attrs:{href:"https://www.pubnub.com/blog/2014-12-01-http-long-polling/",target:"_blank",rel:"noopener noreferrer"}},[e._v("long-polling HTTP requests"),t("OutboundLink")],1),e._v(".")])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[84],{530:function(e,t,a){"use strict";a.r(t);var o=a(4),r=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"glossary"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#glossary"}},[e._v("#")]),e._v(" Glossary")]),e._v(" "),t("p",[e._v("This glossary introduces the major technical terms used in the openEO project.")]),e._v(" "),t("h2",{attrs:{id:"general-terms"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#general-terms"}},[e._v("#")]),e._v(" General terms")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("EO")]),e._v(": Earth observation")]),e._v(" "),t("li",[t("strong",[e._v("API")]),e._v(": application programming interface ("),t("a",{attrs:{href:"https://en.wikipedia.org/wiki/Application_programming_interface",target:"_blank",rel:"noopener noreferrer"}},[e._v("wikipedia"),t("OutboundLink")],1),e._v("); a communication protocol between client and back-end")]),e._v(" "),t("li",[t("strong",[e._v("client")]),e._v(": software tool or environment that end-users directly interact with, e.g. R (RStudio), Python (Jupyter notebook), and JavaScript (web browser); R and Python are two major data science platforms; JavaScript is a major language for web development")]),e._v(" "),t("li",[t("strong",[e._v("(cloud) back-end")]),e._v(": server; computer infrastructure (one or more physical computers or virtual machines) used for storing EO data and processing it")]),e._v(" "),t("li",[t("strong",[e._v("big Earth observation cloud back-end")]),e._v(": server infrastructure where industry and researchers analyse large amounts of EO data")])]),e._v(" "),t("h2",{attrs:{id:"processes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#processes"}},[e._v("#")]),e._v(" Processes")]),e._v(" "),t("p",[e._v("A "),t("strong",[e._v("process")]),e._v(" is an operation that performs a specific task on a set of parameters and returns a result. An example is computing a statistical operation, such as mean or median, on selected EO data. A process is similar to a function or method in programming languages.")]),e._v(" "),t("p",[e._v("A "),t("strong",[e._v("pre-defined process")]),e._v(" is a process provided by the "),t("em",[e._v("back-end")]),e._v(", often one of the "),t("RouterLink",{attrs:{to:"/documentation/1.0/processes.html"}},[e._v("ones centrally defined by openEO")]),e._v(".")],1),e._v(" "),t("p",[e._v("A "),t("strong",[e._v("user-defined process")]),e._v(" is a process defined by the "),t("em",[e._v("user")]),e._v(". It can directly be part of another process graph or be stored as custom process on a back-end. Internally it is a "),t("em",[e._v("process graph")]),e._v(" with optional additional metadata.")]),e._v(" "),t("p",[e._v("A "),t("strong",[e._v("process graph")]),e._v(" chains specific process calls from the set of pre-defined and user-defined processes together. A process graph itself is a (user-defined) process again. Similarly to scripts in the context of programming, process graphs organize and automate the execution of one or more processes that could alternatively be executed individually.")]),e._v(" "),t("h2",{attrs:{id:"eo-data-collections"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#eo-data-collections"}},[e._v("#")]),e._v(" EO data (Collections)")]),e._v(" "),t("p",[e._v("In our domain, different terms are used to describe EO data(sets). Within openEO, a "),t("strong",[e._v("granule")]),e._v(" (sometimes also called "),t("em",[e._v("item")]),e._v(" or "),t("em",[e._v("asset")]),e._v(" in the specification) typically refers to a limited area and a single overpass leading to a very short observation period (seconds) or a temporal aggregation of such data (e.g. for 16-day MODIS composites). A "),t("strong",[e._v("collection")]),e._v(" is a sequence of granules sharing the same product specification. It typically corresponds to the series of products derived from data acquired by a sensor on board a satellite and having the same mode of operation.")]),e._v(" "),t("p",[e._v("The "),t("a",{attrs:{href:"http://ceos.org/ourwork/workinggroups/wgiss/access/opensearch/",target:"_blank",rel:"noopener noreferrer"}},[e._v("CEOS OpenSearch Best Practice Document v1.2"),t("OutboundLink")],1),e._v(" lists the following synonyms used by other organizations:")]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("granule")]),e._v(": dataset (ESA, ISO 19115), granule (NASA), product (ESA, CNES), scene (JAXA)")]),e._v(" "),t("li",[t("strong",[e._v("collection")]),e._v(": dataset series (ESA, ISO 19115), collection (CNES, NASA), dataset (JAXA), product (JAXA)")])]),e._v(" "),t("p",[e._v("In openEO, a back-end offers a set of collections to be processed. All collections can be requested using a client and are described using the "),t("a",{attrs:{href:"https://github.com/radiantearth/stac-spec",target:"_blank",rel:"noopener noreferrer"}},[e._v("STAC (SpatioTemporal Asset Catalog) metadata specification"),t("OutboundLink")],1),e._v(" as STAC collections. A user can load (a subset of) a collection using a special process, which returns a (spatial) datacube. All further processing is then applied to the datacube on the back-end.")]),e._v(" "),t("h2",{attrs:{id:"spatial-datacubes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#spatial-datacubes"}},[e._v("#")]),e._v(" Spatial datacubes")]),e._v(" "),t("p",[e._v("A spatiotemporal datacube is a multidimensional array with one or more spatial or temporal dimensions.\nIn the EO domain, it is common to be implicit about the temporal dimension and just refer to them as spatial datacubes in short.\nSpecial cases are raster and "),t("a",{attrs:{href:"https://r-spatial.org/r/2022/09/12/vdc.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("vector datacubes"),t("OutboundLink")],1),e._v(".\nLearn more about datacubes in the "),t("a",{attrs:{href:"https://openeo.org/documentation/1.0/datacubes.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("datacube documentation"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"vector-data"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#vector-data"}},[e._v("#")]),e._v(" Vector data")]),e._v(" "),t("p",[e._v("In general, "),t("strong",[e._v("vector data")]),e._v(' represent specific things (also called "features") in a space, e.g. on the surface of the Earth.')]),e._v(" "),t("p",[e._v("A "),t("strong",[e._v("coordinate")]),e._v(" represents a specific point in space.")]),e._v(" "),t("p",[e._v("A "),t("strong",[e._v("feature")]),e._v(' is a thing that usually has a geometry (e.g. the outline of an agricultural field, a forest or an urban area) and it may have additional properties assigned (e.g. a name, a color or a population).\nIn rare cases features may not have a geometry, which is often referred to as an "empty geometry".')]),e._v(" "),t("p",[t("strong",[e._v("Geometries")]),e._v(" consist of one or more coordinates that may be connected and then form a specific type of geometry, e.g. two points can be connected to a straight line and four straight lines can be connected to rectangle.")]),e._v(" "),t("p",[e._v("Commonly used types of geometries are:")]),e._v(" "),t("ul",[t("li",[e._v("Point")]),e._v(" "),t("li",[e._v("LineString (connected straight line pieces)")]),e._v(" "),t("li",[e._v("Polygon (connected straight line pieces forming a closed ring, possibly with holes - for example a triangle or rectangle)")])]),e._v(" "),t("p",[e._v('Multiple geometries of the same type can be combined into a group of geometries, e.g. a so-called "multi point" or "multi polygon".')]),e._v(" "),t("p",[e._v("Features and geometries are specified by the OGC in the "),t("a",{attrs:{href:"https://www.ogc.org/standards/sfa",target:"_blank",rel:"noopener noreferrer"}},[e._v("Simple Feature Access specification"),t("OutboundLink")],1),e._v(" (and ISO 19125). See the specification for more details.")]),e._v(" "),t("h2",{attrs:{id:"user-defined-function-udf"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#user-defined-function-udf"}},[e._v("#")]),e._v(" User-defined function (UDF)")]),e._v(" "),t("p",[e._v("The abbreviation "),t("strong",[e._v("UDF")]),e._v(" stands for "),t("strong",[e._v("user-defined function")]),e._v(". With this concept, users are able to upload custom code and have it executed e.g. for every pixel of a scene, or applied to a particular dimension or set of dimensions, allowing custom server-side calculations. See the section on "),t("RouterLink",{attrs:{to:"/documentation/1.0/udfs.html"}},[e._v("UDFs")]),e._v(" for more information.")],1),e._v(" "),t("h2",{attrs:{id:"data-processing-modes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#data-processing-modes"}},[e._v("#")]),e._v(" Data Processing modes")]),e._v(" "),t("p",[e._v("Processes can run in three different ways:")]),e._v(" "),t("ol",[t("li",[e._v("Results can be pre-computed by creating a "),t("em",[t("strong",[e._v("batch job")])]),e._v(". They are submitted to the back-end's processing system, but will remain inactive until explicitly put into the processing queue. They will run only once and store results after execution. Results can be downloaded. Batch jobs are typically time consuming and user interaction is not possible although log files are generated for them. This is the only mode that allows to get an estimate about time, volume and costs beforehand.")]),e._v(" "),t("li",[e._v("A more dynamic way of processing and accessing data is to create a "),t("strong",[e._v("secondary web service")]),e._v(". They allow web-based access using different protocols such as "),t("a",{attrs:{href:"http://www.opengeospatial.org/standards/wms",target:"_blank",rel:"noopener noreferrer"}},[e._v("OGC WMS"),t("OutboundLink")],1),e._v(" (Open Geospatial Consortium Web Map Service), "),t("a",{attrs:{href:"http://www.opengeospatial.org/standards/wcs",target:"_blank",rel:"noopener noreferrer"}},[e._v("OGC WCS"),t("OutboundLink")],1),e._v(" (Web Coverage Service) or "),t("a",{attrs:{href:"https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames",target:"_blank",rel:"noopener noreferrer"}},[e._v("XYZ tiles"),t("OutboundLink")],1),e._v(". These protocols usually allow users to change the viewing extent or level of detail (zoom level). Therefore, computations often run "),t("em",[e._v("on demand")]),e._v(" so that the requested data is calculated during the request. Back-ends should make sure to cache processed data to avoid additional/high costs and reduce waiting times for the user.")]),e._v(" "),t("li",[e._v("Processes can also be executed "),t("strong",[e._v("on-demand")]),e._v(" (i.e. synchronously). Results are delivered with the request itself and no job is created. Only lightweight computations, for example previews, should be executed using this approach as timeouts are to be expected for "),t("a",{attrs:{href:"https://www.pubnub.com/blog/2014-12-01-http-long-polling/",target:"_blank",rel:"noopener noreferrer"}},[e._v("long-polling HTTP requests"),t("OutboundLink")],1),e._v(".")])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/85.287bcd71.js b/assets/js/85.1fc45bd0.js similarity index 79% rename from assets/js/85.287bcd71.js rename to assets/js/85.1fc45bd0.js index d38538354..379406e61 100644 --- a/assets/js/85.287bcd71.js +++ b/assets/js/85.1fc45bd0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[85],{530:function(t,s,e){"use strict";e.r(s);var n=e(4),o=Object(n.a)({},(function(){var t=this._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("ProcessesSpec")],1)}),[],!1,null,null,null);s.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[85],{529:function(t,s,e){"use strict";e.r(s);var n=e(4),o=Object(n.a)({},(function(){var t=this._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("ProcessesSpec")],1)}),[],!1,null,null,null);s.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/89.144159fa.js b/assets/js/89.284c8082.js similarity index 99% rename from assets/js/89.144159fa.js rename to assets/js/89.284c8082.js index 92627ba6a..ac75398b6 100644 --- a/assets/js/89.144159fa.js +++ b/assets/js/89.284c8082.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[89],{537:function(e,t,o){"use strict";o.r(t);var n=o(4),r=Object(n.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"software-development-guidelines"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#software-development-guidelines"}},[e._v("#")]),e._v(" Software Development Guidelines")]),e._v(" "),t("p",[e._v("This document describes guidelines for software developers, written for the "),t("a",{attrs:{href:"http://openeo.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO"),t("OutboundLink")],1),e._v(" project.\nSince the openEO infrastructure encompasses several programming languages and software environments, this document does not prescribe particular tools or platforms but rather focuses on general principles and methods behind them.")]),e._v(" "),t("ol",[t("li",[e._v("License: all software developed in the openEO project and published on the "),t("a",{attrs:{href:"http://github.com/open-eo/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO GitHub"),t("OutboundLink")],1),e._v(" organisation shall be licensed under the "),t("a",{attrs:{href:"https://opensource.org/licenses/Apache-2.0",target:"_blank",rel:"noopener noreferrer"}},[e._v("Apache 2.0 license"),t("OutboundLink")],1),e._v(". If software repositories deviate from this, or contain code or other artifacts that deviates from this, this shall be described in the "),t("code",[e._v("README.md")]),e._v(" file.")]),e._v(" "),t("li",[e._v("Location: Official openEO software is developed under the "),t("a",{attrs:{href:"https://github.com/open-EO/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO GitHub organisation"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[e._v("Proof-of-concept versus sustainable: each repository shall indicate its status: either "),t("em",[e._v("proof-of-concept")]),e._v(", or "),t("em",[e._v("sustainable")]),e._v(". Proof-of-concept code is meant to work but comes without quality assurance. Software repositories with proof-of-concept developments shall clearly say so in the first paragraph of the "),t("code",[e._v("README.md")]),e._v(" file.")]),e._v(" "),t("li",[e._v("Sustainable code should undergo standard "),t("a",{attrs:{href:"#software-quality-guidelines"}},[e._v("quality checks")]),e._v(", and point out its "),t("a",{attrs:{href:"#software-documentation-guidelines"}},[e._v("documentation")]),e._v(".")]),e._v(" "),t("li",[e._v("Sustainable code shall undergo "),t("a",{attrs:{href:"#software-review"}},[e._v("code review")]),e._v("; no direct commits to master; any commit shall come in the form of a PR, commit after review.")]),e._v(" "),t("li",[e._v("Sustainable code shall be written in a "),t("a",{attrs:{href:"#test-driven-development"}},[e._v("Test-driven manner")]),e._v(", and repositories shall at the top of their "),t("code",[e._v("README.md")]),e._v(" give indication of the degree to which code is covered by tests.")]),e._v(" "),t("li",[t("a",{attrs:{href:"#continuous-integration"}},[e._v("Continuous integration")]),e._v(" shall be used to indicate code currently passes its test on CI platforms.")]),e._v(" "),t("li",[e._v("A "),t("RouterLink",{attrs:{to:"/documentation/code-of-conduct.html"}},[e._v("Code of conduct")]),e._v(" describes the rules and constraints to developers and contributors.")],1),e._v(" "),t("li",[e._v("Version numbers of sustainable software releases shall follow "),t("a",{attrs:{href:"http://semver.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("Semantic Versioning 2.0.0"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("h2",{attrs:{id:"software-quality-guidelines"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#software-quality-guidelines"}},[e._v("#")]),e._v(" Software quality guidelines")]),e._v(" "),t("ul",[t("li",[e._v("software shall be written in such a way that another person can understand its intention")]),e._v(" "),t("li",[e._v("comment lines shall be used sparsely, but effectively")]),e._v(" "),t("li",[e._v("reuse of unstable or esoteric libraries shall be avoided")])]),e._v(" "),t("h2",{attrs:{id:"software-documentation-guidelines"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#software-documentation-guidelines"}},[e._v("#")]),e._v(" Software documentation guidelines")]),e._v(" "),t("p",[e._v("Software documentation shall include:")]),e._v(" "),t("ul",[t("li",[e._v("installation instructions")]),e._v(" "),t("li",[e._v("usage instructions")]),e._v(" "),t("li",[e._v("explain in detail the intention of the software")]),e._v(" "),t("li",[e._v("pointers to reference documents explaining overarching concepts")])]),e._v(" "),t("p",[e._v("Each repository's "),t("code",[e._v("README.md")]),e._v(" shall point to the documentation.")]),e._v(" "),t("p",[e._v("Reference documentation shall be written using well-defined reference documentation language, such as "),t("a",{attrs:{href:"https://tools.ietf.org/html/rfc2119",target:"_blank",rel:"noopener noreferrer"}},[e._v("RFC2119"),t("OutboundLink")],1),e._v(" or "),t("a",{attrs:{href:"http://arc42.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("arc42"),t("OutboundLink")],1),e._v(", and refer to the definitions used.")]),e._v(" "),t("h2",{attrs:{id:"software-review"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#software-review"}},[e._v("#")]),e._v(" Software review")]),e._v(" "),t("ul",[t("li",[e._v("sustainable software development shall take place by always having two persons involved in a change to the master branch: individuals push to branches, pull request indicate readiness to be taken up in the master branch, a second developer reviews the pull request before merging it into the master branch.")]),e._v(" "),t("li",[e._v("software review discussions shall be intelligible for external developers, and serve as implicit documentation of development decisions taken")])]),e._v(" "),t("h2",{attrs:{id:"test-driven-development"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#test-driven-development"}},[e._v("#")]),e._v(" Test-driven development")]),e._v(" "),t("p",[e._v("Software shall be developed in a test-driven fashion, meaning that while the code is written, tests are developed that verify, to a reasonable extent, the correctness of the code. Tools such as "),t("a",{attrs:{href:"https://codecov.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("codecov.io"),t("OutboundLink")],1),e._v(" to automatically indicate the amount of code covered by tests, and code that is not covered by tests shall be used in combination with a continuous integration framework.")]),e._v(" "),t("h2",{attrs:{id:"continuous-integration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#continuous-integration"}},[e._v("#")]),e._v(" Continuous integration")]),e._v(" "),t("p",[e._v("Repositories containing running software shall use an appropriate continuous integration platform, such as GitHub Actions or similar, to show whether the current build passes all checks. This helps understand contributors that the software passes tests on an independent platform, and may give insights in the way the software is compiled, deployed and tested.")]),e._v(" "),t("h2",{attrs:{id:"additional-guidelines"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#additional-guidelines"}},[e._v("#")]),e._v(" Additional guidelines")]),e._v(" "),t("p",[e._v("There is specific guideline for "),t("a",{attrs:{href:e.$site.themeConfig.docPath+"developers/clients/library-guidelines.html"}},[e._v("client library development")]),e._v(".")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[89],{538:function(e,t,o){"use strict";o.r(t);var n=o(4),r=Object(n.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"software-development-guidelines"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#software-development-guidelines"}},[e._v("#")]),e._v(" Software Development Guidelines")]),e._v(" "),t("p",[e._v("This document describes guidelines for software developers, written for the "),t("a",{attrs:{href:"http://openeo.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO"),t("OutboundLink")],1),e._v(" project.\nSince the openEO infrastructure encompasses several programming languages and software environments, this document does not prescribe particular tools or platforms but rather focuses on general principles and methods behind them.")]),e._v(" "),t("ol",[t("li",[e._v("License: all software developed in the openEO project and published on the "),t("a",{attrs:{href:"http://github.com/open-eo/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO GitHub"),t("OutboundLink")],1),e._v(" organisation shall be licensed under the "),t("a",{attrs:{href:"https://opensource.org/licenses/Apache-2.0",target:"_blank",rel:"noopener noreferrer"}},[e._v("Apache 2.0 license"),t("OutboundLink")],1),e._v(". If software repositories deviate from this, or contain code or other artifacts that deviates from this, this shall be described in the "),t("code",[e._v("README.md")]),e._v(" file.")]),e._v(" "),t("li",[e._v("Location: Official openEO software is developed under the "),t("a",{attrs:{href:"https://github.com/open-EO/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO GitHub organisation"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[e._v("Proof-of-concept versus sustainable: each repository shall indicate its status: either "),t("em",[e._v("proof-of-concept")]),e._v(", or "),t("em",[e._v("sustainable")]),e._v(". Proof-of-concept code is meant to work but comes without quality assurance. Software repositories with proof-of-concept developments shall clearly say so in the first paragraph of the "),t("code",[e._v("README.md")]),e._v(" file.")]),e._v(" "),t("li",[e._v("Sustainable code should undergo standard "),t("a",{attrs:{href:"#software-quality-guidelines"}},[e._v("quality checks")]),e._v(", and point out its "),t("a",{attrs:{href:"#software-documentation-guidelines"}},[e._v("documentation")]),e._v(".")]),e._v(" "),t("li",[e._v("Sustainable code shall undergo "),t("a",{attrs:{href:"#software-review"}},[e._v("code review")]),e._v("; no direct commits to master; any commit shall come in the form of a PR, commit after review.")]),e._v(" "),t("li",[e._v("Sustainable code shall be written in a "),t("a",{attrs:{href:"#test-driven-development"}},[e._v("Test-driven manner")]),e._v(", and repositories shall at the top of their "),t("code",[e._v("README.md")]),e._v(" give indication of the degree to which code is covered by tests.")]),e._v(" "),t("li",[t("a",{attrs:{href:"#continuous-integration"}},[e._v("Continuous integration")]),e._v(" shall be used to indicate code currently passes its test on CI platforms.")]),e._v(" "),t("li",[e._v("A "),t("RouterLink",{attrs:{to:"/documentation/code-of-conduct.html"}},[e._v("Code of conduct")]),e._v(" describes the rules and constraints to developers and contributors.")],1),e._v(" "),t("li",[e._v("Version numbers of sustainable software releases shall follow "),t("a",{attrs:{href:"http://semver.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("Semantic Versioning 2.0.0"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("h2",{attrs:{id:"software-quality-guidelines"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#software-quality-guidelines"}},[e._v("#")]),e._v(" Software quality guidelines")]),e._v(" "),t("ul",[t("li",[e._v("software shall be written in such a way that another person can understand its intention")]),e._v(" "),t("li",[e._v("comment lines shall be used sparsely, but effectively")]),e._v(" "),t("li",[e._v("reuse of unstable or esoteric libraries shall be avoided")])]),e._v(" "),t("h2",{attrs:{id:"software-documentation-guidelines"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#software-documentation-guidelines"}},[e._v("#")]),e._v(" Software documentation guidelines")]),e._v(" "),t("p",[e._v("Software documentation shall include:")]),e._v(" "),t("ul",[t("li",[e._v("installation instructions")]),e._v(" "),t("li",[e._v("usage instructions")]),e._v(" "),t("li",[e._v("explain in detail the intention of the software")]),e._v(" "),t("li",[e._v("pointers to reference documents explaining overarching concepts")])]),e._v(" "),t("p",[e._v("Each repository's "),t("code",[e._v("README.md")]),e._v(" shall point to the documentation.")]),e._v(" "),t("p",[e._v("Reference documentation shall be written using well-defined reference documentation language, such as "),t("a",{attrs:{href:"https://tools.ietf.org/html/rfc2119",target:"_blank",rel:"noopener noreferrer"}},[e._v("RFC2119"),t("OutboundLink")],1),e._v(" or "),t("a",{attrs:{href:"http://arc42.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("arc42"),t("OutboundLink")],1),e._v(", and refer to the definitions used.")]),e._v(" "),t("h2",{attrs:{id:"software-review"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#software-review"}},[e._v("#")]),e._v(" Software review")]),e._v(" "),t("ul",[t("li",[e._v("sustainable software development shall take place by always having two persons involved in a change to the master branch: individuals push to branches, pull request indicate readiness to be taken up in the master branch, a second developer reviews the pull request before merging it into the master branch.")]),e._v(" "),t("li",[e._v("software review discussions shall be intelligible for external developers, and serve as implicit documentation of development decisions taken")])]),e._v(" "),t("h2",{attrs:{id:"test-driven-development"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#test-driven-development"}},[e._v("#")]),e._v(" Test-driven development")]),e._v(" "),t("p",[e._v("Software shall be developed in a test-driven fashion, meaning that while the code is written, tests are developed that verify, to a reasonable extent, the correctness of the code. Tools such as "),t("a",{attrs:{href:"https://codecov.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("codecov.io"),t("OutboundLink")],1),e._v(" to automatically indicate the amount of code covered by tests, and code that is not covered by tests shall be used in combination with a continuous integration framework.")]),e._v(" "),t("h2",{attrs:{id:"continuous-integration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#continuous-integration"}},[e._v("#")]),e._v(" Continuous integration")]),e._v(" "),t("p",[e._v("Repositories containing running software shall use an appropriate continuous integration platform, such as GitHub Actions or similar, to show whether the current build passes all checks. This helps understand contributors that the software passes tests on an independent platform, and may give insights in the way the software is compiled, deployed and tested.")]),e._v(" "),t("h2",{attrs:{id:"additional-guidelines"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#additional-guidelines"}},[e._v("#")]),e._v(" Additional guidelines")]),e._v(" "),t("p",[e._v("There is specific guideline for "),t("a",{attrs:{href:e.$site.themeConfig.docPath+"developers/clients/library-guidelines.html"}},[e._v("client library development")]),e._v(".")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/90.dcb0053c.js b/assets/js/90.71e33d19.js similarity index 99% rename from assets/js/90.dcb0053c.js rename to assets/js/90.71e33d19.js index 3ce679746..1728fffc2 100644 --- a/assets/js/90.dcb0053c.js +++ b/assets/js/90.71e33d19.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[90],{538:function(e,t,o){"use strict";o.r(t);var r=o(4),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"ieee-igarrs-2021-hd-3-hands-on-openeo-access-cloud-platforms-using-your-preferred-programming-language"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ieee-igarrs-2021-hd-3-hands-on-openeo-access-cloud-platforms-using-your-preferred-programming-language"}},[e._v("#")]),e._v(" IEEE IGARRS 2021 HD-3: Hands-on openEO: access cloud platforms using your preferred programming language")]),e._v(" "),t("p",[e._v("This page contains the agenda, and links to used material for the\nIEEE IGARRS 2021 openEO tutorial.")]),e._v(" "),t("p",[e._v("Details: "),t("a",{attrs:{href:"https://igarss2021.com/tutorials.php#tut9",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://igarss2021.com/tutorials.php#tut9"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"agenda"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#agenda"}},[e._v("#")]),e._v(" Agenda")]),e._v(" "),t("ul",[t("li",[e._v("14:00-14:20: Introduction to openEO (Pieter Kempeneers - JRC)")]),e._v(" "),t("li",[e._v("14:20-14:30: Q&A")]),e._v(" "),t("li",[e._v("14:30-15:30: Python client (VITO) (Jeroen Dries - VITO)")]),e._v(" "),t("li",[e._v("15:30-16:15: R client (WUR) (Dainius Masiliunas - WUR)")]),e._v(" "),t("li",[e._v("16:15-16:30: Break")]),e._v(" "),t("li",[e._v("16:30-16:45: openEO UIs (Jeroen Dries - VITO)")]),e._v(" "),t("li",[e._v("16:45-17:15: Use case demo (Jeroen Dries - VITO)")]),e._v(" "),t("li",[e._v("17:15-18:00: Q&A")])]),e._v(" "),t("h2",{attrs:{id:"python-client"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#python-client"}},[e._v("#")]),e._v(" Python client")]),e._v(" "),t("h3",{attrs:{id:"logging-in"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#logging-in"}},[e._v("#")]),e._v(" Logging in")]),e._v(" "),t("p",[e._v("For participants interested in trying thing out, try logging into Terrascope openEO backend:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://docs.terrascope.be/#/Developers/WebServices/OpenEO/OpenEO",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://docs.terrascope.be/#/Developers/WebServices/OpenEO/OpenEO"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("Jupyter notebooks with the openEO Python client installed:\n"),t("a",{attrs:{href:"https://notebooks.terrascope.be",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://notebooks.terrascope.be"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("This jupyter environment also has the notebook samples in this git repository already available:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/VITObelgium/notebook-samples",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/VITObelgium/notebook-samples"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("Otherwise, git can be used to check out the notebooks, or simply download the 'ipynb' file.")]),e._v(" "),t("p",[e._v("Use 'edugain and social accounts' login to avoid having to register at Terrascope, you may still be required\nto fill in a form.")]),e._v(" "),t("h3",{attrs:{id:"openeo-in-python-intro"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#openeo-in-python-intro"}},[e._v("#")]),e._v(" openEO in Python intro")]),e._v(" "),t("p",[e._v("General Python documentation:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-python-client/",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://open-eo.github.io/openeo-python-client/"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("Basics:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/Open-EO/openeo-python-client/blob/master/examples/notebooks/openeo-terrascope-webinar.ipynb",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/Open-EO/openeo-python-client/blob/master/examples/notebooks/openeo-terrascope-webinar.ipynb"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("More advanced:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/VITObelgium/notebook-samples/blob/master/tools/openEO/openeo-showcase.ipynb",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/VITObelgium/notebook-samples/blob/master/tools/openEO/openeo-showcase.ipynb"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"r-client"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#r-client"}},[e._v("#")]),e._v(" R client")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://openeo.org/documentation/1.0/r/",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://openeo.org/documentation/1.0/r/"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("Demonstration notebook:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/VITObelgium/notebook-samples/blob/master/tools/openEO/openeo-r-client.ipynb",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/VITObelgium/notebook-samples/blob/master/tools/openEO/openeo-r-client.ipynb"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"openeo-user-interfaces"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#openeo-user-interfaces"}},[e._v("#")]),e._v(" openEO user interfaces")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://hub.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://hub.openeo.org"),t("OutboundLink")],1)]),e._v(" "),t("p",[t("a",{attrs:{href:"https://editor.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://editor.openeo.org"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"use-cases"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#use-cases"}},[e._v("#")]),e._v(" Use cases")]),e._v(" "),t("p",[e._v("Using predefined 'higher level' services:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/VITObelgium/notebook-samples/blob/master/Terrascope/Beginner/OpenEO_CropCalendarService.ipynb",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/VITObelgium/notebook-samples/blob/master/Terrascope/Beginner/OpenEO_CropCalendarService.ipynb"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("Creating 'higher level' services:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-python-client/udp.html#building-and-storing-user-defined-process",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://open-eo.github.io/openeo-python-client/udp.html#building-and-storing-user-defined-process"),t("OutboundLink")],1)])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[90],{537:function(e,t,o){"use strict";o.r(t);var r=o(4),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"ieee-igarrs-2021-hd-3-hands-on-openeo-access-cloud-platforms-using-your-preferred-programming-language"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ieee-igarrs-2021-hd-3-hands-on-openeo-access-cloud-platforms-using-your-preferred-programming-language"}},[e._v("#")]),e._v(" IEEE IGARRS 2021 HD-3: Hands-on openEO: access cloud platforms using your preferred programming language")]),e._v(" "),t("p",[e._v("This page contains the agenda, and links to used material for the\nIEEE IGARRS 2021 openEO tutorial.")]),e._v(" "),t("p",[e._v("Details: "),t("a",{attrs:{href:"https://igarss2021.com/tutorials.php#tut9",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://igarss2021.com/tutorials.php#tut9"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"agenda"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#agenda"}},[e._v("#")]),e._v(" Agenda")]),e._v(" "),t("ul",[t("li",[e._v("14:00-14:20: Introduction to openEO (Pieter Kempeneers - JRC)")]),e._v(" "),t("li",[e._v("14:20-14:30: Q&A")]),e._v(" "),t("li",[e._v("14:30-15:30: Python client (VITO) (Jeroen Dries - VITO)")]),e._v(" "),t("li",[e._v("15:30-16:15: R client (WUR) (Dainius Masiliunas - WUR)")]),e._v(" "),t("li",[e._v("16:15-16:30: Break")]),e._v(" "),t("li",[e._v("16:30-16:45: openEO UIs (Jeroen Dries - VITO)")]),e._v(" "),t("li",[e._v("16:45-17:15: Use case demo (Jeroen Dries - VITO)")]),e._v(" "),t("li",[e._v("17:15-18:00: Q&A")])]),e._v(" "),t("h2",{attrs:{id:"python-client"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#python-client"}},[e._v("#")]),e._v(" Python client")]),e._v(" "),t("h3",{attrs:{id:"logging-in"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#logging-in"}},[e._v("#")]),e._v(" Logging in")]),e._v(" "),t("p",[e._v("For participants interested in trying thing out, try logging into Terrascope openEO backend:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://docs.terrascope.be/#/Developers/WebServices/OpenEO/OpenEO",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://docs.terrascope.be/#/Developers/WebServices/OpenEO/OpenEO"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("Jupyter notebooks with the openEO Python client installed:\n"),t("a",{attrs:{href:"https://notebooks.terrascope.be",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://notebooks.terrascope.be"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("This jupyter environment also has the notebook samples in this git repository already available:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/VITObelgium/notebook-samples",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/VITObelgium/notebook-samples"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("Otherwise, git can be used to check out the notebooks, or simply download the 'ipynb' file.")]),e._v(" "),t("p",[e._v("Use 'edugain and social accounts' login to avoid having to register at Terrascope, you may still be required\nto fill in a form.")]),e._v(" "),t("h3",{attrs:{id:"openeo-in-python-intro"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#openeo-in-python-intro"}},[e._v("#")]),e._v(" openEO in Python intro")]),e._v(" "),t("p",[e._v("General Python documentation:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-python-client/",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://open-eo.github.io/openeo-python-client/"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("Basics:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/Open-EO/openeo-python-client/blob/master/examples/notebooks/openeo-terrascope-webinar.ipynb",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/Open-EO/openeo-python-client/blob/master/examples/notebooks/openeo-terrascope-webinar.ipynb"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("More advanced:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/VITObelgium/notebook-samples/blob/master/tools/openEO/openeo-showcase.ipynb",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/VITObelgium/notebook-samples/blob/master/tools/openEO/openeo-showcase.ipynb"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"r-client"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#r-client"}},[e._v("#")]),e._v(" R client")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://openeo.org/documentation/1.0/r/",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://openeo.org/documentation/1.0/r/"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("Demonstration notebook:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/VITObelgium/notebook-samples/blob/master/tools/openEO/openeo-r-client.ipynb",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/VITObelgium/notebook-samples/blob/master/tools/openEO/openeo-r-client.ipynb"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"openeo-user-interfaces"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#openeo-user-interfaces"}},[e._v("#")]),e._v(" openEO user interfaces")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://hub.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://hub.openeo.org"),t("OutboundLink")],1)]),e._v(" "),t("p",[t("a",{attrs:{href:"https://editor.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://editor.openeo.org"),t("OutboundLink")],1)]),e._v(" "),t("h2",{attrs:{id:"use-cases"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#use-cases"}},[e._v("#")]),e._v(" Use cases")]),e._v(" "),t("p",[e._v("Using predefined 'higher level' services:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/VITObelgium/notebook-samples/blob/master/Terrascope/Beginner/OpenEO_CropCalendarService.ipynb",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/VITObelgium/notebook-samples/blob/master/Terrascope/Beginner/OpenEO_CropCalendarService.ipynb"),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("Creating 'higher level' services:")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://open-eo.github.io/openeo-python-client/udp.html#building-and-storing-user-defined-process",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://open-eo.github.io/openeo-python-client/udp.html#building-and-storing-user-defined-process"),t("OutboundLink")],1)])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/97.f2e20ce1.js b/assets/js/97.b15b53e9.js similarity index 99% rename from assets/js/97.f2e20ce1.js rename to assets/js/97.b15b53e9.js index 73c41f8dc..83a2fd5d8 100644 --- a/assets/js/97.f2e20ce1.js +++ b/assets/js/97.b15b53e9.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[97],{547:function(e,t,o){"use strict";o.r(t);var n=o(4),a=Object(n.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("p",[e._v("With openEO, we are digging into new grounds regarding the interoperability of big Earth observation clouds. While we could address a lot of problems that came up, some issues remained that we couldn't solve. This article explains "),t("em",[e._v("some")]),e._v(" of the lessons learned and thus also gives an honest overview about current limitations of the openEO API.")]),e._v(" "),t("h2",{attrs:{id:"_1-collection-names"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_1-collection-names"}},[e._v("#")]),e._v(" 1. Collection Names")]),e._v(" "),t("p",[e._v("The naming of data sets (collections) is different across providers. We thought about recommending to follow lists like the "),t("a",{attrs:{href:"http://database.eohandbook.com/database/missionindex.aspx",target:"_blank",rel:"noopener noreferrer"}},[e._v("CEOS Mission Index"),t("OutboundLink")],1),e._v(", but then the question is what data does it really refer to? It lists "),t("code",[e._v("Sentinel-2 A")]),e._v(" and "),t("code",[e._v("Sentinel-2 B")]),e._v(", but would that be Level 1C or 2A or something completely different? Therefore, openEO decided to not enforce any naming scheme as data sets throughout the affiliated providers were mostly differently pre-processed anyway. To improve the situation, openEO allows to define process parameters. This allows to define algorithms independently of data set names, which can later be assigned when executing the process. Also, openEO recommends to split processing instructions into two parts: data loading/pre-processing and the actual algorithm.")]),e._v(" "),t("p",[e._v("Some more background information can be found in the corresponding "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/issues/52",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub issue"),t("OutboundLink")],1),e._v(". In general, many limitations (including the following) concern the data holdings of the providers and may hopefully be solved by initiatives that work on Analysis Ready Data (ARD).")]),e._v(" "),t("h2",{attrs:{id:"_2-other-names"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_2-other-names"}},[e._v("#")]),e._v(" 2. Other Names")]),e._v(" "),t("p",[e._v("Similarly, the naming of bands (and potentially other dimension labels, too) are inconsistent across providers, we faced names such as "),t("code",[e._v("B2")]),e._v(", "),t("code",[e._v("B02")]),e._v(", "),t("code",[e._v("2")]),e._v(" or "),t("code",[e._v("blue")]),e._v(" for Sentinel-2. openEO doesn't enforce any naming scheme, but has found ways to improve the situation for users. First, process parameters can be used (see above). Second, bands can also be specified using the "),t("a",{attrs:{href:"https://github.com/radiantearth/stac-spec/tree/v0.9.0/extensions/eo#common-band-names",target:"_blank",rel:"noopener noreferrer"}},[e._v("common names as specified by STAC"),t("OutboundLink")],1),e._v(" or wavelength ranges. openEO recommends to use common names whenever available.")]),e._v(" "),t("p",[e._v("For example, to avoid specific naming you could filter for Sentinel-2 (A and B) band 2 as follows:")]),e._v(" "),t("ul",[t("li",[e._v("by common name: "),t("code",[e._v("filter_bands(data = cube, bands = ['blue'])")]),e._v(" (blue maps to the wavelength range 0.45 - 0.50 according to STAC)")]),e._v(" "),t("li",[e._v("by wavelength, specified in μm: "),t("code",[e._v("filter_bands(data = cube, wavelength = [[0.49, 0.50]])")]),e._v(" (wavelength is 0.4966 for Sentinel-2A and 0.4921 for Sentinel-2B)")])]),e._v(" "),t("p",[e._v("In general, metadata is aligned for usage in openEO processes by using the "),t("a",{attrs:{href:"https://www.stacspec.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("STAC specification"),t("OutboundLink")],1),e._v(", which improves interoperability.")]),e._v(" "),t("h2",{attrs:{id:"_3-chunked-collections"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_3-chunked-collections"}},[e._v("#")]),e._v(" 3. Chunked Collections")]),e._v(" "),t("p",[e._v("Some providers (for example "),t("a",{attrs:{href:"https://developers.google.com/earth-engine/datasets/catalog/COPERNICUS_S2_SR",target:"_blank",rel:"noopener noreferrer"}},[e._v("Google Earth Engine"),t("OutboundLink")],1),e._v(") expose data sets such as Sentinel-2 L2A as one large collection. Other providers expose the data sets split into groups, e.g. chunked by CRS and resolution. EURAC has collections such as "),t("code",[e._v("S2_32632_60m_L2A")]),e._v(" or "),t("code",[e._v("S2_32635_10m_L2A")]),e._v(" for example. There are valid "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/issues/180",target:"_blank",rel:"noopener noreferrer"}},[e._v("reasons"),t("OutboundLink")],1),e._v(" for any of the implementations, but to explain them is too much for this article. Unfortunately, those differences decrease the interoperability and in the end the re-usability of the processes. openEO aims to make algorithms re-usable and thus recommends to split processing instructions into two parts: data loading/pre-processing and the actual algorithm. This allows greater re-usability of the algorithms.")]),e._v(" "),t("h2",{attrs:{id:"_4-what-to-specify"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_4-what-to-specify"}},[e._v("#")]),e._v(" 4. What to specify?")]),e._v(" "),t("p",[e._v("The API has a focus on Service and Data Discovery, Data Processing and Result Retrieval/Publishing. Some more customer-oriented tasks such as user registration and payments are not handled through the openEO API. These aspects are too different across providers and can be handled more efficiently through external interfaces. Most providers already offer such services independently of the openEO API implementation anyway to offer their pre-openEO services.")]),e._v(" "),t("p",[e._v("Still, the openEO API uses OpenID Connect as main Authentication and Authorization mechanism (see also point 5). "),t("a",{attrs:{href:"https://openid.net/connect/",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenID Connect"),t("OutboundLink")],1),e._v(" has a "),t("a",{attrs:{href:"https://openid.net/specs/openid-connect-prompt-create-1_0.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("User Registration extension draft"),t("OutboundLink")],1),e._v(" that can be used by back-ends and may be adopted in the future. We closely follow upcoming specifications and standards and are happy to adopt anything useful.")]),e._v(" "),t("h3",{attrs:{id:"file-formats"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#file-formats"}},[e._v("#")]),e._v(" File Formats")]),e._v(" "),t("p",[e._v("Similarly, file "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/issues/63",target:"_blank",rel:"noopener noreferrer"}},[e._v("formats"),t("OutboundLink")],1),e._v(" and their "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/issues/32",target:"_blank",rel:"noopener noreferrer"}},[e._v("options"),t("OutboundLink")],1),e._v(' are often very different between processing software. That is why GDAL exists. To improve interoperability, the openEO API just recommends to align them with GDAL, which is used in most relevant software anyway. Unfortunately, this comes with some small inconveniences. For example, most people would probably expect to just specify "GeoTiff" as file format name, but GDAL has named it "GTiff". Another idea was to use '),t("a",{attrs:{href:"https://www.iana.org/assignments/media-types/media-types.xhtml",target:"_blank",rel:"noopener noreferrer"}},[e._v("media types"),t("OutboundLink")],1),e._v(" such as "),t("code",[e._v("application/json")]),e._v(", but then we realized that these are often to broad or not even defined. For example, openEO had to "),t("a",{attrs:{href:"https://github.com/opengeospatial/geotiff/issues/34",target:"_blank",rel:"noopener noreferrer"}},[e._v("push the OGC"),t("OutboundLink")],1),e._v(" to specify an official media type for GeoTiff. But the same issue exists for other file formats, too.")]),e._v(" "),t("h2",{attrs:{id:"_5-authentication"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_5-authentication"}},[e._v("#")]),e._v(" 5. Authentication")]),e._v(" "),t("p",[e._v("One of the most complex issues we faced during the API development was actually not EO or data processing related. It was the Authentication and Authorization mechanism. We quickly decided to use one of the well-established standards available for security reasons. Unfortunately, most of them don't seem to cater very well for our use case where you have a number of different clients and back-ends communicating with each other. Usually in the Web you have multiple clients communicating with a single back-end ("),t("em",[e._v("1:n")]),e._v("), but in openEO we have a "),t("em",[e._v("n:m")]),e._v(" relation. There are CLI tools, web clients and more that need to authenticate against a growing set of independent providers. Therefore, you can't easily ship clients with security measures like Client IDs (and Client Secrets) as required by "),t("a",{attrs:{href:"https://openid.net/connect/",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenID Connect"),t("OutboundLink")],1),e._v(" (based on "),t("a",{attrs:{href:"https://oauth.net/2/",target:"_blank",rel:"noopener noreferrer"}},[e._v("OAuth 2"),t("OutboundLink")],1),e._v("). Users need to get those information by themselves and provide it to the clients, which is inconvenient and probably confusing to many non-developers. This issue is probably the thing I dislike most in the current API specification and thus would love to hear from you whether there are good solutions out there that we missed.")]),e._v(" "),t("h2",{attrs:{id:"_6-debugging-experience"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_6-debugging-experience"}},[e._v("#")]),e._v(" 6. Debugging Experience")]),e._v(" "),t("p",[e._v('The logging and debugging experience varies a lot between cloud processing and the "traditional workflow" (you download data and compute locally with your preferred tools). While it\'s "free" on a local machine to just do "trial and error" to check whether something is running, cloud processing usually comes with a cost and you likely don\'t want to work with "trial and error". Also you don\'t directly have access to the hardware and software and thus it is harder to investigate problems. openEO took several measures to mitigate these issues, but it is still a different experience for users. I guess that is a long learning process until it is adopted by users and may need additional effort to implement tools to improve the situation. While many users are getting used to it in situations where a streamlined experience is somewhat possible as only few clients communicate with a single provider (e.g. Google Earth Engine), the issue increases in openEO due to the different infrastructure and software used on back-end side.')]),e._v(" "),t("h2",{attrs:{id:"_7-defining-interoperable-processes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_7-defining-interoperable-processes"}},[e._v("#")]),e._v(" 7. Defining interoperable Processes")]),e._v(" "),t("p",[e._v("Defining a common set of pre-defined processes was a very long and challenging task.")]),e._v(" "),t("ol",[t("li",[e._v("First, we had to come up with a useful schema that allowed us to describe processes in JSON. We got inspired by different other standards such as "),t("a",{attrs:{href:"https://www.ogc.org/standards/wps",target:"_blank",rel:"noopener noreferrer"}},[e._v("WPS"),t("OutboundLink")],1),e._v(" and "),t("a",{attrs:{href:"http://spec.openapis.org/oas/v3.0.3",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenAPI"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[e._v("Second, we had to find what processes are required and which granularity they should have. That quickly led to over "),t("a",{attrs:{href:"https://processes.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("a hundred processes"),t("OutboundLink")],1),e._v(", mainly for data cube and math operations. And that was only for mostly raster operations. We still have a big hole in the processes regarding vector related operations, but we aim to close that in the next year(s).")]),e._v(" "),t("li",[e._v("Third, we had to figure out what common processing softwares offered and how to come up with process definitions than can be implemented with those softwares.")]),e._v(" "),t("li",[e._v("Last, we had to specify it in a way that is unambiguous and easy to understand by users.")])]),e._v(" "),t("p",[e._v("All of these tasks took much more time than initially expected. For example, one of the partners reported that the granularity of the processes is not really suited for the underlying processing software. While we couldn't really change the granularity, it was at least not an issue to make openEO work for them. Fortunately, the process part of the openEO API is very flexible and allows providers to change the processes according to their needs or define their own processes. Due to the fact that the actual parameters and return values are described in JSON Schema, clients and back-ends can easily re-use existing JSON Schema implementations and adopt to changes in the process specifications. Thus, if a back-end doesn't support parts of a process, it can just be changed/removed and a client can understand that and cater for it.")]),e._v(" "),t("h2",{attrs:{id:"conclusion"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#conclusion"}},[e._v("#")]),e._v(" Conclusion")]),e._v(" "),t("p",[e._v("This was a deep dive into "),t("em",[e._v("some")]),e._v(" of my challenges during the last years. I hope it is useful for others and I'm hoping to get into discussions with developers facing similar issues. Maybe with joint forces we can solve some of these for a better cloud processing experience in the future. If you have anything to say, please contact me via "),t("a",{attrs:{href:"mailto:m.mohr@uni-muenster.de"}},[e._v("e-mail")]),e._v(", GitHub issues ("),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-api",target:"_blank",rel:"noopener noreferrer"}},[e._v("API"),t("OutboundLink")],1),e._v(", "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("Processes"),t("OutboundLink")],1),e._v(") or "),t("a",{attrs:{href:"https://twitter.com/matthmohr",target:"_blank",rel:"noopener noreferrer"}},[e._v("Twitter"),t("OutboundLink")],1),e._v(". You can also "),t("RouterLink",{attrs:{to:"/contact.html"}},[e._v("contact openEO")]),e._v(".")],1)])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[97],{546:function(e,t,o){"use strict";o.r(t);var n=o(4),a=Object(n.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("p",[e._v("With openEO, we are digging into new grounds regarding the interoperability of big Earth observation clouds. While we could address a lot of problems that came up, some issues remained that we couldn't solve. This article explains "),t("em",[e._v("some")]),e._v(" of the lessons learned and thus also gives an honest overview about current limitations of the openEO API.")]),e._v(" "),t("h2",{attrs:{id:"_1-collection-names"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_1-collection-names"}},[e._v("#")]),e._v(" 1. Collection Names")]),e._v(" "),t("p",[e._v("The naming of data sets (collections) is different across providers. We thought about recommending to follow lists like the "),t("a",{attrs:{href:"http://database.eohandbook.com/database/missionindex.aspx",target:"_blank",rel:"noopener noreferrer"}},[e._v("CEOS Mission Index"),t("OutboundLink")],1),e._v(", but then the question is what data does it really refer to? It lists "),t("code",[e._v("Sentinel-2 A")]),e._v(" and "),t("code",[e._v("Sentinel-2 B")]),e._v(", but would that be Level 1C or 2A or something completely different? Therefore, openEO decided to not enforce any naming scheme as data sets throughout the affiliated providers were mostly differently pre-processed anyway. To improve the situation, openEO allows to define process parameters. This allows to define algorithms independently of data set names, which can later be assigned when executing the process. Also, openEO recommends to split processing instructions into two parts: data loading/pre-processing and the actual algorithm.")]),e._v(" "),t("p",[e._v("Some more background information can be found in the corresponding "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/issues/52",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub issue"),t("OutboundLink")],1),e._v(". In general, many limitations (including the following) concern the data holdings of the providers and may hopefully be solved by initiatives that work on Analysis Ready Data (ARD).")]),e._v(" "),t("h2",{attrs:{id:"_2-other-names"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_2-other-names"}},[e._v("#")]),e._v(" 2. Other Names")]),e._v(" "),t("p",[e._v("Similarly, the naming of bands (and potentially other dimension labels, too) are inconsistent across providers, we faced names such as "),t("code",[e._v("B2")]),e._v(", "),t("code",[e._v("B02")]),e._v(", "),t("code",[e._v("2")]),e._v(" or "),t("code",[e._v("blue")]),e._v(" for Sentinel-2. openEO doesn't enforce any naming scheme, but has found ways to improve the situation for users. First, process parameters can be used (see above). Second, bands can also be specified using the "),t("a",{attrs:{href:"https://github.com/radiantearth/stac-spec/tree/v0.9.0/extensions/eo#common-band-names",target:"_blank",rel:"noopener noreferrer"}},[e._v("common names as specified by STAC"),t("OutboundLink")],1),e._v(" or wavelength ranges. openEO recommends to use common names whenever available.")]),e._v(" "),t("p",[e._v("For example, to avoid specific naming you could filter for Sentinel-2 (A and B) band 2 as follows:")]),e._v(" "),t("ul",[t("li",[e._v("by common name: "),t("code",[e._v("filter_bands(data = cube, bands = ['blue'])")]),e._v(" (blue maps to the wavelength range 0.45 - 0.50 according to STAC)")]),e._v(" "),t("li",[e._v("by wavelength, specified in μm: "),t("code",[e._v("filter_bands(data = cube, wavelength = [[0.49, 0.50]])")]),e._v(" (wavelength is 0.4966 for Sentinel-2A and 0.4921 for Sentinel-2B)")])]),e._v(" "),t("p",[e._v("In general, metadata is aligned for usage in openEO processes by using the "),t("a",{attrs:{href:"https://www.stacspec.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("STAC specification"),t("OutboundLink")],1),e._v(", which improves interoperability.")]),e._v(" "),t("h2",{attrs:{id:"_3-chunked-collections"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_3-chunked-collections"}},[e._v("#")]),e._v(" 3. Chunked Collections")]),e._v(" "),t("p",[e._v("Some providers (for example "),t("a",{attrs:{href:"https://developers.google.com/earth-engine/datasets/catalog/COPERNICUS_S2_SR",target:"_blank",rel:"noopener noreferrer"}},[e._v("Google Earth Engine"),t("OutboundLink")],1),e._v(") expose data sets such as Sentinel-2 L2A as one large collection. Other providers expose the data sets split into groups, e.g. chunked by CRS and resolution. EURAC has collections such as "),t("code",[e._v("S2_32632_60m_L2A")]),e._v(" or "),t("code",[e._v("S2_32635_10m_L2A")]),e._v(" for example. There are valid "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/issues/180",target:"_blank",rel:"noopener noreferrer"}},[e._v("reasons"),t("OutboundLink")],1),e._v(" for any of the implementations, but to explain them is too much for this article. Unfortunately, those differences decrease the interoperability and in the end the re-usability of the processes. openEO aims to make algorithms re-usable and thus recommends to split processing instructions into two parts: data loading/pre-processing and the actual algorithm. This allows greater re-usability of the algorithms.")]),e._v(" "),t("h2",{attrs:{id:"_4-what-to-specify"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_4-what-to-specify"}},[e._v("#")]),e._v(" 4. What to specify?")]),e._v(" "),t("p",[e._v("The API has a focus on Service and Data Discovery, Data Processing and Result Retrieval/Publishing. Some more customer-oriented tasks such as user registration and payments are not handled through the openEO API. These aspects are too different across providers and can be handled more efficiently through external interfaces. Most providers already offer such services independently of the openEO API implementation anyway to offer their pre-openEO services.")]),e._v(" "),t("p",[e._v("Still, the openEO API uses OpenID Connect as main Authentication and Authorization mechanism (see also point 5). "),t("a",{attrs:{href:"https://openid.net/connect/",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenID Connect"),t("OutboundLink")],1),e._v(" has a "),t("a",{attrs:{href:"https://openid.net/specs/openid-connect-prompt-create-1_0.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("User Registration extension draft"),t("OutboundLink")],1),e._v(" that can be used by back-ends and may be adopted in the future. We closely follow upcoming specifications and standards and are happy to adopt anything useful.")]),e._v(" "),t("h3",{attrs:{id:"file-formats"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#file-formats"}},[e._v("#")]),e._v(" File Formats")]),e._v(" "),t("p",[e._v("Similarly, file "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/issues/63",target:"_blank",rel:"noopener noreferrer"}},[e._v("formats"),t("OutboundLink")],1),e._v(" and their "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/issues/32",target:"_blank",rel:"noopener noreferrer"}},[e._v("options"),t("OutboundLink")],1),e._v(' are often very different between processing software. That is why GDAL exists. To improve interoperability, the openEO API just recommends to align them with GDAL, which is used in most relevant software anyway. Unfortunately, this comes with some small inconveniences. For example, most people would probably expect to just specify "GeoTiff" as file format name, but GDAL has named it "GTiff". Another idea was to use '),t("a",{attrs:{href:"https://www.iana.org/assignments/media-types/media-types.xhtml",target:"_blank",rel:"noopener noreferrer"}},[e._v("media types"),t("OutboundLink")],1),e._v(" such as "),t("code",[e._v("application/json")]),e._v(", but then we realized that these are often to broad or not even defined. For example, openEO had to "),t("a",{attrs:{href:"https://github.com/opengeospatial/geotiff/issues/34",target:"_blank",rel:"noopener noreferrer"}},[e._v("push the OGC"),t("OutboundLink")],1),e._v(" to specify an official media type for GeoTiff. But the same issue exists for other file formats, too.")]),e._v(" "),t("h2",{attrs:{id:"_5-authentication"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_5-authentication"}},[e._v("#")]),e._v(" 5. Authentication")]),e._v(" "),t("p",[e._v("One of the most complex issues we faced during the API development was actually not EO or data processing related. It was the Authentication and Authorization mechanism. We quickly decided to use one of the well-established standards available for security reasons. Unfortunately, most of them don't seem to cater very well for our use case where you have a number of different clients and back-ends communicating with each other. Usually in the Web you have multiple clients communicating with a single back-end ("),t("em",[e._v("1:n")]),e._v("), but in openEO we have a "),t("em",[e._v("n:m")]),e._v(" relation. There are CLI tools, web clients and more that need to authenticate against a growing set of independent providers. Therefore, you can't easily ship clients with security measures like Client IDs (and Client Secrets) as required by "),t("a",{attrs:{href:"https://openid.net/connect/",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenID Connect"),t("OutboundLink")],1),e._v(" (based on "),t("a",{attrs:{href:"https://oauth.net/2/",target:"_blank",rel:"noopener noreferrer"}},[e._v("OAuth 2"),t("OutboundLink")],1),e._v("). Users need to get those information by themselves and provide it to the clients, which is inconvenient and probably confusing to many non-developers. This issue is probably the thing I dislike most in the current API specification and thus would love to hear from you whether there are good solutions out there that we missed.")]),e._v(" "),t("h2",{attrs:{id:"_6-debugging-experience"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_6-debugging-experience"}},[e._v("#")]),e._v(" 6. Debugging Experience")]),e._v(" "),t("p",[e._v('The logging and debugging experience varies a lot between cloud processing and the "traditional workflow" (you download data and compute locally with your preferred tools). While it\'s "free" on a local machine to just do "trial and error" to check whether something is running, cloud processing usually comes with a cost and you likely don\'t want to work with "trial and error". Also you don\'t directly have access to the hardware and software and thus it is harder to investigate problems. openEO took several measures to mitigate these issues, but it is still a different experience for users. I guess that is a long learning process until it is adopted by users and may need additional effort to implement tools to improve the situation. While many users are getting used to it in situations where a streamlined experience is somewhat possible as only few clients communicate with a single provider (e.g. Google Earth Engine), the issue increases in openEO due to the different infrastructure and software used on back-end side.')]),e._v(" "),t("h2",{attrs:{id:"_7-defining-interoperable-processes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_7-defining-interoperable-processes"}},[e._v("#")]),e._v(" 7. Defining interoperable Processes")]),e._v(" "),t("p",[e._v("Defining a common set of pre-defined processes was a very long and challenging task.")]),e._v(" "),t("ol",[t("li",[e._v("First, we had to come up with a useful schema that allowed us to describe processes in JSON. We got inspired by different other standards such as "),t("a",{attrs:{href:"https://www.ogc.org/standards/wps",target:"_blank",rel:"noopener noreferrer"}},[e._v("WPS"),t("OutboundLink")],1),e._v(" and "),t("a",{attrs:{href:"http://spec.openapis.org/oas/v3.0.3",target:"_blank",rel:"noopener noreferrer"}},[e._v("OpenAPI"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[e._v("Second, we had to find what processes are required and which granularity they should have. That quickly led to over "),t("a",{attrs:{href:"https://processes.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("a hundred processes"),t("OutboundLink")],1),e._v(", mainly for data cube and math operations. And that was only for mostly raster operations. We still have a big hole in the processes regarding vector related operations, but we aim to close that in the next year(s).")]),e._v(" "),t("li",[e._v("Third, we had to figure out what common processing softwares offered and how to come up with process definitions than can be implemented with those softwares.")]),e._v(" "),t("li",[e._v("Last, we had to specify it in a way that is unambiguous and easy to understand by users.")])]),e._v(" "),t("p",[e._v("All of these tasks took much more time than initially expected. For example, one of the partners reported that the granularity of the processes is not really suited for the underlying processing software. While we couldn't really change the granularity, it was at least not an issue to make openEO work for them. Fortunately, the process part of the openEO API is very flexible and allows providers to change the processes according to their needs or define their own processes. Due to the fact that the actual parameters and return values are described in JSON Schema, clients and back-ends can easily re-use existing JSON Schema implementations and adopt to changes in the process specifications. Thus, if a back-end doesn't support parts of a process, it can just be changed/removed and a client can understand that and cater for it.")]),e._v(" "),t("h2",{attrs:{id:"conclusion"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#conclusion"}},[e._v("#")]),e._v(" Conclusion")]),e._v(" "),t("p",[e._v("This was a deep dive into "),t("em",[e._v("some")]),e._v(" of my challenges during the last years. I hope it is useful for others and I'm hoping to get into discussions with developers facing similar issues. Maybe with joint forces we can solve some of these for a better cloud processing experience in the future. If you have anything to say, please contact me via "),t("a",{attrs:{href:"mailto:m.mohr@uni-muenster.de"}},[e._v("e-mail")]),e._v(", GitHub issues ("),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-api",target:"_blank",rel:"noopener noreferrer"}},[e._v("API"),t("OutboundLink")],1),e._v(", "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("Processes"),t("OutboundLink")],1),e._v(") or "),t("a",{attrs:{href:"https://twitter.com/matthmohr",target:"_blank",rel:"noopener noreferrer"}},[e._v("Twitter"),t("OutboundLink")],1),e._v(". You can also "),t("RouterLink",{attrs:{to:"/contact.html"}},[e._v("contact openEO")]),e._v(".")],1)])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/98.fa26554b.js b/assets/js/98.5d216eea.js similarity index 99% rename from assets/js/98.fa26554b.js rename to assets/js/98.5d216eea.js index 0fb478bb2..fc1f4bbfc 100644 --- a/assets/js/98.fa26554b.js +++ b/assets/js/98.5d216eea.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[98],{548:function(e,t,s){"use strict";s.r(t);var o=s(4),n=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("p",[e._v("After two release candidates in early 2020, the openEO Consortium released the first stable version of its "),t("a",{attrs:{href:"https://api.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO API"),t("OutboundLink")],1),e._v(" and their set of "),t("a",{attrs:{href:"https://processes.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("common processes"),t("OutboundLink")],1),e._v(". This blog post gives an overview of the most notable changes since "),t("RouterLink",{attrs:{to:"/news/2019-03-07-openeo-api-040.html"}},[e._v("version 0.4")]),e._v(" and provides an outlook on the next months' project activity.")],1),e._v(" "),t("p",[t("em",[e._v("For those who are new to openEO, we have developed an open API to connect R, Python, JavaScript and other clients to big Earth observation cloud back-ends in a simple and unified way. The idea is that this will make cloud-based processing of large satellite image collections, or other data cubes such as weather model data easier for data scientists. The entire development process has been open, and all "),t("RouterLink",{attrs:{to:"/software.html"}},[e._v("software")]),e._v(" developed in this project is open source and available on "),t("a",{attrs:{href:"https://github.com/open-eo",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub"),t("OutboundLink")],1),e._v(". For more information about openEO, please read "),t("RouterLink",{attrs:{to:"/about.html"}},[e._v("page about the project")]),e._v(" first.")],1)]),e._v(" "),t("h2",{attrs:{id:"processes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#processes"}},[e._v("#")]),e._v(" Processes")]),e._v(" "),t("p",[e._v("The most important change was introduced just recently in openEO API version 1.0.0 RC2. Until then, openEO process graphs allowed users to express processing algorithms and execute them on a back-end using "),t("em",[e._v("pre-defined processes")]),e._v(" exposed by a back-end provider. While this still exists, a user can now also promote a process graph to a full openEO process description, following the same schema as the pre-defined processes: it must include the processing instructions and metadata like an identifier, parameters, return values, examples etc. This allows "),t("em",[e._v("user-defined processes")]),e._v(" to be stored and used like pre-defined processes, enabling users to extend the processing capabilities of a back-end. Users can now encapsulate algorithms in separate user-defined processes and re-use these in other user-defined processes. This also allows the exchange of processes (algorithms) between users and back-ends, and creates the possibility for a repository of user-contributed processes that other users can benefit from. A place for finding and sharing such processes is (planned to be) the "),t("a",{attrs:{href:"https://hub.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO Hub"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("Through user-defined processes (and user defined functions) users may also be able to substitute processes that back-ends have not implemented. In fact, several pre-defined processes are defined with alternative processing instructions that use other openEO pre-defined processes to solve the task. For example, the pre-defined process "),t("code",[e._v("normalized_ difference")]),e._v(" can be emulated with a combination of the processes "),t("code",[e._v("add")]),e._v(", "),t("code",[e._v("subtract")]),e._v(" and "),t("code",[e._v("divide")]),e._v(". So if a back-end is missing the "),t("code",[e._v("normalized_difference")]),e._v(" process, a user can just "),t("a",{attrs:{href:"https://processes.openeo.org/#normalized_difference",target:"_blank",rel:"noopener noreferrer"}},[e._v("download it"),t("OutboundLink")],1),e._v(" and use an openEO client to push it to the back-end where it then acts as drop-in replacement for the missing pre-defined process. In the future we plan to allow just using the URL of the process, so that no download/upload would be required.")]),e._v(" "),t("p",[e._v("As mentioned above, openEO offers a set of "),t("a",{attrs:{href:"https://processes.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("common processes"),t("OutboundLink")],1),e._v(" to improve interoperability and portability between back-ends. This is not a complete list and is expected to be extended by the openEO Consortium. More than that, we would like to see that processes arise from the community and that we can take over and standardize whatever comes up and is useful for the different domains working with openEO. We can then simply use the user-defined processes as they share the same schema as the pre-defined processes.")]),e._v(" "),t("p",[e._v("The pre-defined openEO processes are released separately from the API to ensure a faster release cycle than we plan for the API. We want to be able to quickly adapt to community needs with additional processes. Future version of the processes are valid with any future API version through the specification of the process metadata standard in openEO.")]),e._v(" "),t("p",[e._v("The pre-defined processes itself also got an update just after the API release, but "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/blob/1.0.0/CHANGELOG.md#100---2020-07-31",target:"_blank",rel:"noopener noreferrer"}},[e._v("the changes"),t("OutboundLink")],1),e._v(" are relatively small compared to the API. The focus was to clarify unspecified and ambiguous parts of the specification. Some processes such as "),t("code",[e._v("apply_neighborhood")]),e._v(" and "),t("code",[e._v("constant")]),e._v(" were added for the use cases. In collaboration with "),t("a",{attrs:{href:"https://jwagemann.github.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Julia Wagemann"),t("OutboundLink")],1),e._v(" from the "),t("a",{attrs:{href:"https://www.ecmwf.int/",target:"_blank",rel:"noopener noreferrer"}},[e._v("ECMWF"),t("OutboundLink")],1),e._v(" we started defining processes such as "),t("code",[e._v("aggregate_temporal_frequency")]),e._v(", "),t("code",[e._v("anomaly")]),e._v(" and "),t("code",[e._v("climatological_normal")]),e._v(" for climatology and meteorology use-cases. Unfortunately, this effort could not be finished yet due to the COVID-19 situation. We want to continue to broaden the processes to be useful for more domains apart from core Earth Observation.")]),e._v(" "),t("h2",{attrs:{id:"stac-and-ogc-apis"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#stac-and-ogc-apis"}},[e._v("#")]),e._v(" STAC and OGC APIs")]),e._v(" "),t("p",[e._v("The openEO API now supports STAC (API) versions 0.9 and 1.x, which implements OGC API - Features. Thus, a potential integration of the openEO API with upcoming OGC API standards should be easy to establish.")]),e._v(" "),t("h2",{attrs:{id:"user-defined-functions-udfs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#user-defined-functions-udfs"}},[e._v("#")]),e._v(" User-defined Functions (UDFs)")]),e._v(" "),t("p",[t("em",[e._v("Note: Don't get confused, user-defined processes and user-defined functions describe different things.")])]),e._v(" "),t("p",[e._v("Although already foreseen in API version 0.4.0, the openEO UDF API has evolved and is better integrated in the openEO API. It now allows to run Docker containers or custom scripts in potentially any programming language. The UDF API itself is not part of the openEO API, but is a separate specification to describe the data exchange between a back-end implementing the openEO API and a UDF API instance. The UDF API is in release candidate phase and we'll likely post a separate blog post focussing solely on them. Currently, implementations in R and Python are available. It is foreseen that users could also host their own UDF API instances and call them from remote back-ends.")]),e._v(" "),t("h2",{attrs:{id:"other-improvements"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#other-improvements"}},[e._v("#")]),e._v(" Other improvements")]),e._v(" "),t("p",[e._v("Other notable changes and additions:")]),e._v(" "),t("ul",[t("li",[e._v("Support for importing user-provided data sets has been added.")]),e._v(" "),t("li",[e._v("Providers can now expose their terms of service and privacy policies.")]),e._v(" "),t("li",[e._v("The WebSocket-based Subscription API for notifications and monitoring introduced in version 0.4 has been replaced by a logging mechanism in the HTTP API. This makes implementing the API easier for clients and back-ends, but doesn't work in real-time any longer.")])]),e._v(" "),t("p",[e._v("The full set of changes can be found in the "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/blob/1.0.0/CHANGELOG.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("API's change log"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"limitations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#limitations"}},[e._v("#")]),e._v(" Limitations")]),e._v(" "),t("p",[e._v("With openEO, we are digging into new grounds regarding the interoperability of big Earth observation clouds. While we could solve a lot of issues that came up, there were some issues that we couldn't solve as part of the API and processes. We want to be honest and give some insights into the lessons learned, so I have posted these as a "),t("RouterLink",{attrs:{to:"/news/2020-07-31-lessons-learned.html"}},[e._v("separate blog post")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"next-steps"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#next-steps"}},[e._v("#")]),e._v(" Next steps")]),e._v(" "),t("p",[e._v("The API's development went through several iterations and is working well for our broad range of use cases, which we'll report soon. "),t("RouterLink",{attrs:{to:"/software.html"}},[e._v("Implementations")]),e._v(" by several organizations for several API versions provide evidence that the API and the processes are useful for a wide range of use cases. Client and back-end developers will now finish their implementations and we hope to have the first operational services this year. We will follow up with new blog posts once other releases are available. If you are interested in trying out openEO, please "),t("RouterLink",{attrs:{to:"/contact.html"}},[e._v("contact us")]),e._v(" to get more information.")],1)])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[98],{547:function(e,t,s){"use strict";s.r(t);var o=s(4),n=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("p",[e._v("After two release candidates in early 2020, the openEO Consortium released the first stable version of its "),t("a",{attrs:{href:"https://api.openeo.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO API"),t("OutboundLink")],1),e._v(" and their set of "),t("a",{attrs:{href:"https://processes.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("common processes"),t("OutboundLink")],1),e._v(". This blog post gives an overview of the most notable changes since "),t("RouterLink",{attrs:{to:"/news/2019-03-07-openeo-api-040.html"}},[e._v("version 0.4")]),e._v(" and provides an outlook on the next months' project activity.")],1),e._v(" "),t("p",[t("em",[e._v("For those who are new to openEO, we have developed an open API to connect R, Python, JavaScript and other clients to big Earth observation cloud back-ends in a simple and unified way. The idea is that this will make cloud-based processing of large satellite image collections, or other data cubes such as weather model data easier for data scientists. The entire development process has been open, and all "),t("RouterLink",{attrs:{to:"/software.html"}},[e._v("software")]),e._v(" developed in this project is open source and available on "),t("a",{attrs:{href:"https://github.com/open-eo",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub"),t("OutboundLink")],1),e._v(". For more information about openEO, please read "),t("RouterLink",{attrs:{to:"/about.html"}},[e._v("page about the project")]),e._v(" first.")],1)]),e._v(" "),t("h2",{attrs:{id:"processes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#processes"}},[e._v("#")]),e._v(" Processes")]),e._v(" "),t("p",[e._v("The most important change was introduced just recently in openEO API version 1.0.0 RC2. Until then, openEO process graphs allowed users to express processing algorithms and execute them on a back-end using "),t("em",[e._v("pre-defined processes")]),e._v(" exposed by a back-end provider. While this still exists, a user can now also promote a process graph to a full openEO process description, following the same schema as the pre-defined processes: it must include the processing instructions and metadata like an identifier, parameters, return values, examples etc. This allows "),t("em",[e._v("user-defined processes")]),e._v(" to be stored and used like pre-defined processes, enabling users to extend the processing capabilities of a back-end. Users can now encapsulate algorithms in separate user-defined processes and re-use these in other user-defined processes. This also allows the exchange of processes (algorithms) between users and back-ends, and creates the possibility for a repository of user-contributed processes that other users can benefit from. A place for finding and sharing such processes is (planned to be) the "),t("a",{attrs:{href:"https://hub.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("openEO Hub"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("Through user-defined processes (and user defined functions) users may also be able to substitute processes that back-ends have not implemented. In fact, several pre-defined processes are defined with alternative processing instructions that use other openEO pre-defined processes to solve the task. For example, the pre-defined process "),t("code",[e._v("normalized_ difference")]),e._v(" can be emulated with a combination of the processes "),t("code",[e._v("add")]),e._v(", "),t("code",[e._v("subtract")]),e._v(" and "),t("code",[e._v("divide")]),e._v(". So if a back-end is missing the "),t("code",[e._v("normalized_difference")]),e._v(" process, a user can just "),t("a",{attrs:{href:"https://processes.openeo.org/#normalized_difference",target:"_blank",rel:"noopener noreferrer"}},[e._v("download it"),t("OutboundLink")],1),e._v(" and use an openEO client to push it to the back-end where it then acts as drop-in replacement for the missing pre-defined process. In the future we plan to allow just using the URL of the process, so that no download/upload would be required.")]),e._v(" "),t("p",[e._v("As mentioned above, openEO offers a set of "),t("a",{attrs:{href:"https://processes.openeo.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("common processes"),t("OutboundLink")],1),e._v(" to improve interoperability and portability between back-ends. This is not a complete list and is expected to be extended by the openEO Consortium. More than that, we would like to see that processes arise from the community and that we can take over and standardize whatever comes up and is useful for the different domains working with openEO. We can then simply use the user-defined processes as they share the same schema as the pre-defined processes.")]),e._v(" "),t("p",[e._v("The pre-defined openEO processes are released separately from the API to ensure a faster release cycle than we plan for the API. We want to be able to quickly adapt to community needs with additional processes. Future version of the processes are valid with any future API version through the specification of the process metadata standard in openEO.")]),e._v(" "),t("p",[e._v("The pre-defined processes itself also got an update just after the API release, but "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-processes/blob/1.0.0/CHANGELOG.md#100---2020-07-31",target:"_blank",rel:"noopener noreferrer"}},[e._v("the changes"),t("OutboundLink")],1),e._v(" are relatively small compared to the API. The focus was to clarify unspecified and ambiguous parts of the specification. Some processes such as "),t("code",[e._v("apply_neighborhood")]),e._v(" and "),t("code",[e._v("constant")]),e._v(" were added for the use cases. In collaboration with "),t("a",{attrs:{href:"https://jwagemann.github.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Julia Wagemann"),t("OutboundLink")],1),e._v(" from the "),t("a",{attrs:{href:"https://www.ecmwf.int/",target:"_blank",rel:"noopener noreferrer"}},[e._v("ECMWF"),t("OutboundLink")],1),e._v(" we started defining processes such as "),t("code",[e._v("aggregate_temporal_frequency")]),e._v(", "),t("code",[e._v("anomaly")]),e._v(" and "),t("code",[e._v("climatological_normal")]),e._v(" for climatology and meteorology use-cases. Unfortunately, this effort could not be finished yet due to the COVID-19 situation. We want to continue to broaden the processes to be useful for more domains apart from core Earth Observation.")]),e._v(" "),t("h2",{attrs:{id:"stac-and-ogc-apis"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#stac-and-ogc-apis"}},[e._v("#")]),e._v(" STAC and OGC APIs")]),e._v(" "),t("p",[e._v("The openEO API now supports STAC (API) versions 0.9 and 1.x, which implements OGC API - Features. Thus, a potential integration of the openEO API with upcoming OGC API standards should be easy to establish.")]),e._v(" "),t("h2",{attrs:{id:"user-defined-functions-udfs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#user-defined-functions-udfs"}},[e._v("#")]),e._v(" User-defined Functions (UDFs)")]),e._v(" "),t("p",[t("em",[e._v("Note: Don't get confused, user-defined processes and user-defined functions describe different things.")])]),e._v(" "),t("p",[e._v("Although already foreseen in API version 0.4.0, the openEO UDF API has evolved and is better integrated in the openEO API. It now allows to run Docker containers or custom scripts in potentially any programming language. The UDF API itself is not part of the openEO API, but is a separate specification to describe the data exchange between a back-end implementing the openEO API and a UDF API instance. The UDF API is in release candidate phase and we'll likely post a separate blog post focussing solely on them. Currently, implementations in R and Python are available. It is foreseen that users could also host their own UDF API instances and call them from remote back-ends.")]),e._v(" "),t("h2",{attrs:{id:"other-improvements"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#other-improvements"}},[e._v("#")]),e._v(" Other improvements")]),e._v(" "),t("p",[e._v("Other notable changes and additions:")]),e._v(" "),t("ul",[t("li",[e._v("Support for importing user-provided data sets has been added.")]),e._v(" "),t("li",[e._v("Providers can now expose their terms of service and privacy policies.")]),e._v(" "),t("li",[e._v("The WebSocket-based Subscription API for notifications and monitoring introduced in version 0.4 has been replaced by a logging mechanism in the HTTP API. This makes implementing the API easier for clients and back-ends, but doesn't work in real-time any longer.")])]),e._v(" "),t("p",[e._v("The full set of changes can be found in the "),t("a",{attrs:{href:"https://github.com/Open-EO/openeo-api/blob/1.0.0/CHANGELOG.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("API's change log"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"limitations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#limitations"}},[e._v("#")]),e._v(" Limitations")]),e._v(" "),t("p",[e._v("With openEO, we are digging into new grounds regarding the interoperability of big Earth observation clouds. While we could solve a lot of issues that came up, there were some issues that we couldn't solve as part of the API and processes. We want to be honest and give some insights into the lessons learned, so I have posted these as a "),t("RouterLink",{attrs:{to:"/news/2020-07-31-lessons-learned.html"}},[e._v("separate blog post")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"next-steps"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#next-steps"}},[e._v("#")]),e._v(" Next steps")]),e._v(" "),t("p",[e._v("The API's development went through several iterations and is working well for our broad range of use cases, which we'll report soon. "),t("RouterLink",{attrs:{to:"/software.html"}},[e._v("Implementations")]),e._v(" by several organizations for several API versions provide evidence that the API and the processes are useful for a wide range of use cases. Client and back-end developers will now finish their implementations and we hope to have the first operational services this year. We will follow up with new blog posts once other releases are available. If you are interested in trying out openEO, please "),t("RouterLink",{attrs:{to:"/contact.html"}},[e._v("contact us")]),e._v(" to get more information.")],1)])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/99.9cd13a05.js b/assets/js/99.9dbfecc0.js similarity index 99% rename from assets/js/99.9cd13a05.js rename to assets/js/99.9dbfecc0.js index e3e3e9e84..80802bba0 100644 --- a/assets/js/99.9cd13a05.js +++ b/assets/js/99.9dbfecc0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[99],{550:function(t,e,r){"use strict";r.r(e);var s=r(4),a=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h3",{attrs:{id:"update"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update"}},[t._v("#")]),t._v(" UPDATE:")]),t._v(" "),e("p",[e("strong",[t._v("Presentations")]),t._v(" and "),e("strong",[t._v("Notebooks")]),t._v(" of the user workshop can be downloaded "),e("a",{attrs:{href:"https://owncloud.tuwien.ac.at/index.php/s/c469i4hvgaR15Ip",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("hr"),t._v(" "),e("p",[t._v("openEO hosts a (virtual) user workshop on "),e("strong",[t._v("19 October 2020")]),t._v(" (10:30 - 16:30 CEST in two parts) and encourages interested parties to register for this event at "),e("a",{attrs:{href:"https://ec.europa.eu/eusurvey/runner/openEOUserWorkshop",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://ec.europa.eu/eusurvey/runner/openEOUserWorkshop"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("p",[e("strong",[t._v("Needed preparation:")]),t._v(" Manuals for installing the various client APIs, recommended for testing openEO in guided sessions, can be found in the "),e("em",[t._v("User Documentation")]),t._v(" under "),e("em",[e("RouterLink",{attrs:{to:"/documentation/1.0/"}},[t._v("Getting Started")])],1),t._v(".")]),t._v(" "),e("p",[e("strong",[t._v("User questionnaire:")]),t._v(" Please help us also by spending some minutes for this "),e("a",{attrs:{href:"https://ec.europa.eu/eusurvey/runner/OpenEOFinalUserWorkshop",target:"_blank",rel:"noopener noreferrer"}},[t._v("user questionnaire"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("p",[e("strong",[t._v("Access details")]),t._v(": Please click the session topics below to connect to the corresponding sessions in Microsoft Teams.")]),t._v(" "),e("p",[e("strong",[t._v("Agenda:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{attrs:{colspan:"5"}},[t._v("Part 1")])]),t._v(" "),e("tr",[e("th",[t._v("No.")]),t._v(" "),e("th",[t._v("Start")]),t._v(" "),e("th",[t._v("Duration")]),t._v(" "),e("th",[t._v("Topic")]),t._v(" "),e("th",[t._v("Remark")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("1.1")]),t._v(" "),e("td",[t._v("10:30h")]),t._v(" "),e("td",[t._v("30min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Introduction into openEO + technical overview")])]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[t._v("1.2")]),t._v(" "),e("td",[t._v("11:00h")]),t._v(" "),e("td",[t._v("20min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Overview backends")])]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[t._v("1.3")]),t._v(" "),e("td",[t._v("11:20h")]),t._v(" "),e("td",[t._v("20min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Overview processes + documentation")])]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[t._v("1.4")]),t._v(" "),e("td",[t._v("11:40h")]),t._v(" "),e("td",[t._v("5min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Installation of openEO")])]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[t._v("1.5")]),t._v(" "),e("td",[t._v("11:45h")]),t._v(" "),e("td",[t._v("15min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Q/A: Backends, Installation, Q/A Chat")])]),t._v(" "),e("td",[t._v("Questionaire")])]),t._v(" "),e("tr",[e("td",{attrs:{colspan:"5"}},[e("i",[t._v("Break for users to install openEO, partners stay available in chat for answering questions on that in bilateral talks")])])]),t._v(" "),e("tr",[e("td",{attrs:{colspan:"5"}})])]),t._v(" "),e("thead",[e("tr",[e("th",{attrs:{colspan:"5"}},[t._v("Part 2")])]),t._v(" "),e("tr",[e("th",[t._v("No.")]),t._v(" "),e("th",[t._v("Start")]),t._v(" "),e("th",[t._v("Duration")]),t._v(" "),e("th",[t._v("Topic")]),t._v(" "),e("th",[t._v("Remark")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("2.1")]),t._v(" "),e("td",[t._v("14:00h")]),t._v(" "),e("td",[t._v("5min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Welcome back / Ways for users to approach to openEO")])]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("th",{attrs:{colspan:"5"}},[t._v("Live Demontrations, Part 1")])]),t._v(" "),e("tr",[e("td",[t._v("2.2a")]),t._v(" "),e("td",[t._v("14:05h")]),t._v(" "),e("td",[t._v("20min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Python Client")])]),t._v(" "),e("td",{attrs:{rowspan:"2"}},[t._v("Parallel session")])]),t._v(" "),e("tr",[e("td",[t._v("2.2b")]),t._v(" "),e("td",[t._v("14:05h")]),t._v(" "),e("td",[t._v("20min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3iWreUB",target:"_blank"}},[t._v("JavaScript Client + mobile application")])])]),t._v(" "),e("tr",[e("td"),t._v(" "),e("td",[e("i",[t._v("14:25h")])]),t._v(" "),e("td",[e("i",[t._v("5min")])]),t._v(" "),e("td",{attrs:{colspan:"2"}},[e("i",[t._v("Short break / Switching sessions")])])]),t._v(" "),e("tr",[e("th",{attrs:{colspan:"5"}},[t._v("Live Demontrations, Part 2")])]),t._v(" "),e("tr",[e("td",[t._v("2.3a")]),t._v(" "),e("td",[t._v("14:30h")]),t._v(" "),e("td",[t._v("20min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Web Editor + QGIS")])]),t._v(" "),e("td",{attrs:{rowspan:"2"}},[t._v("Parallel session")])]),t._v(" "),e("tr",[e("td",[t._v("2.3b")]),t._v(" "),e("td",[t._v("14:30h")]),t._v(" "),e("td",[t._v("20min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3iWreUB",target:"_blank"}},[t._v("R Client")])])]),t._v(" "),e("tr",[e("td"),t._v(" "),e("td",[e("i",[t._v("14:50h")])]),t._v(" "),e("td",[e("i",[t._v("5min")])]),t._v(" "),e("td",{attrs:{colspan:"2"}},[e("i",[t._v("Short break / Switching sessions")])])]),t._v(" "),e("tr",[e("th",{attrs:{colspan:"5"}},[t._v("Guided Sessions and Q/A")])]),t._v(" "),e("tr",[e("td",[t._v("2.4a")]),t._v(" "),e("td",[t._v("14:55h")]),t._v(" "),e("td",[t._v("60min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Guided room for users to test the R Client")])]),t._v(" "),e("td",{attrs:{rowspan:"3"}},[t._v("Parallel session")])]),t._v(" "),e("tr",[e("td",[t._v("2.4b")]),t._v(" "),e("td",[t._v("14:55h")]),t._v(" "),e("td",[t._v("60min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3iWreUB",target:"_blank"}},[t._v("Guided room for users to test the Python Client")])])]),t._v(" "),e("tr",[e("td",[t._v("2.4c")]),t._v(" "),e("td",[t._v("14:55h")]),t._v(" "),e("td",[t._v("60min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/31bt2mH",target:"_blank"}},[t._v("Guided room for users to test other clients")])])]),t._v(" "),e("tr",[e("td",[t._v("2.5a")]),t._v(" "),e("td",[t._v("15:55h")]),t._v(" "),e("td",[t._v("15min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Q/A and Discussions: R Client")])]),t._v(" "),e("td",{attrs:{rowspan:"3"}},[t._v("Parallel session")])]),t._v(" "),e("tr",[e("td",[t._v("2.5b")]),t._v(" "),e("td",[t._v("15:55h")]),t._v(" "),e("td",[t._v("15min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3iWreUB",target:"_blank"}},[t._v("Q/A and Discussions: Python")])])]),t._v(" "),e("tr",[e("td",[t._v("2.5c")]),t._v(" "),e("td",[t._v("15:55h")]),t._v(" "),e("td",[t._v("15min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/31bt2mH",target:"_blank"}},[t._v("Q/A and Discussions: Other clients")])])]),t._v(" "),e("tr",[e("th",{attrs:{colspan:"5"}},[t._v("Wrap up")])]),t._v(" "),e("tr",[e("td",[t._v("2.6")]),t._v(" "),e("td",[t._v("16:10h")]),t._v(" "),e("td",[t._v("20min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Q/A; Discussion on user needs, future work")])]),t._v(" "),e("td")])])]),t._v(" "),e("p",[e("strong",[t._v("Background:")]),t._v(" openEO is a user-driven open source API, which grants a uniform communication between the Earth Observation (EO) data user community and diverse EO cloud service providers. Thus, it aims for a cross-platform interoperability to ease a comparison, the cooperation and the switch between them. The project consortium (H2020 Grant No 776242) released a stable version of the openEO API, covering standardised online processing of all aspects of an EO data life cycle on diverse cloud platforms.")]),t._v(" "),e("p",[t._v("In this User Workshop, the audience is provided with insight into the functionalities of the openEO API. In various live demonstration and training sessions, real demonstration cases will be explained from the user perspective. Possible applications of the openEO API will be presented for different access levels – from the use of programming languages to browser based model builders or mobile applications. Target audience for this event are programmers, decision makers, as well as third-party cloud EO service providers.")])])}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[99],{549:function(t,e,r){"use strict";r.r(e);var s=r(4),a=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h3",{attrs:{id:"update"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update"}},[t._v("#")]),t._v(" UPDATE:")]),t._v(" "),e("p",[e("strong",[t._v("Presentations")]),t._v(" and "),e("strong",[t._v("Notebooks")]),t._v(" of the user workshop can be downloaded "),e("a",{attrs:{href:"https://owncloud.tuwien.ac.at/index.php/s/c469i4hvgaR15Ip",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("hr"),t._v(" "),e("p",[t._v("openEO hosts a (virtual) user workshop on "),e("strong",[t._v("19 October 2020")]),t._v(" (10:30 - 16:30 CEST in two parts) and encourages interested parties to register for this event at "),e("a",{attrs:{href:"https://ec.europa.eu/eusurvey/runner/openEOUserWorkshop",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://ec.europa.eu/eusurvey/runner/openEOUserWorkshop"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("p",[e("strong",[t._v("Needed preparation:")]),t._v(" Manuals for installing the various client APIs, recommended for testing openEO in guided sessions, can be found in the "),e("em",[t._v("User Documentation")]),t._v(" under "),e("em",[e("RouterLink",{attrs:{to:"/documentation/1.0/"}},[t._v("Getting Started")])],1),t._v(".")]),t._v(" "),e("p",[e("strong",[t._v("User questionnaire:")]),t._v(" Please help us also by spending some minutes for this "),e("a",{attrs:{href:"https://ec.europa.eu/eusurvey/runner/OpenEOFinalUserWorkshop",target:"_blank",rel:"noopener noreferrer"}},[t._v("user questionnaire"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("p",[e("strong",[t._v("Access details")]),t._v(": Please click the session topics below to connect to the corresponding sessions in Microsoft Teams.")]),t._v(" "),e("p",[e("strong",[t._v("Agenda:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{attrs:{colspan:"5"}},[t._v("Part 1")])]),t._v(" "),e("tr",[e("th",[t._v("No.")]),t._v(" "),e("th",[t._v("Start")]),t._v(" "),e("th",[t._v("Duration")]),t._v(" "),e("th",[t._v("Topic")]),t._v(" "),e("th",[t._v("Remark")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("1.1")]),t._v(" "),e("td",[t._v("10:30h")]),t._v(" "),e("td",[t._v("30min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Introduction into openEO + technical overview")])]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[t._v("1.2")]),t._v(" "),e("td",[t._v("11:00h")]),t._v(" "),e("td",[t._v("20min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Overview backends")])]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[t._v("1.3")]),t._v(" "),e("td",[t._v("11:20h")]),t._v(" "),e("td",[t._v("20min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Overview processes + documentation")])]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[t._v("1.4")]),t._v(" "),e("td",[t._v("11:40h")]),t._v(" "),e("td",[t._v("5min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Installation of openEO")])]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[t._v("1.5")]),t._v(" "),e("td",[t._v("11:45h")]),t._v(" "),e("td",[t._v("15min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Q/A: Backends, Installation, Q/A Chat")])]),t._v(" "),e("td",[t._v("Questionaire")])]),t._v(" "),e("tr",[e("td",{attrs:{colspan:"5"}},[e("i",[t._v("Break for users to install openEO, partners stay available in chat for answering questions on that in bilateral talks")])])]),t._v(" "),e("tr",[e("td",{attrs:{colspan:"5"}})])]),t._v(" "),e("thead",[e("tr",[e("th",{attrs:{colspan:"5"}},[t._v("Part 2")])]),t._v(" "),e("tr",[e("th",[t._v("No.")]),t._v(" "),e("th",[t._v("Start")]),t._v(" "),e("th",[t._v("Duration")]),t._v(" "),e("th",[t._v("Topic")]),t._v(" "),e("th",[t._v("Remark")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("2.1")]),t._v(" "),e("td",[t._v("14:00h")]),t._v(" "),e("td",[t._v("5min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Welcome back / Ways for users to approach to openEO")])]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("th",{attrs:{colspan:"5"}},[t._v("Live Demontrations, Part 1")])]),t._v(" "),e("tr",[e("td",[t._v("2.2a")]),t._v(" "),e("td",[t._v("14:05h")]),t._v(" "),e("td",[t._v("20min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Python Client")])]),t._v(" "),e("td",{attrs:{rowspan:"2"}},[t._v("Parallel session")])]),t._v(" "),e("tr",[e("td",[t._v("2.2b")]),t._v(" "),e("td",[t._v("14:05h")]),t._v(" "),e("td",[t._v("20min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3iWreUB",target:"_blank"}},[t._v("JavaScript Client + mobile application")])])]),t._v(" "),e("tr",[e("td"),t._v(" "),e("td",[e("i",[t._v("14:25h")])]),t._v(" "),e("td",[e("i",[t._v("5min")])]),t._v(" "),e("td",{attrs:{colspan:"2"}},[e("i",[t._v("Short break / Switching sessions")])])]),t._v(" "),e("tr",[e("th",{attrs:{colspan:"5"}},[t._v("Live Demontrations, Part 2")])]),t._v(" "),e("tr",[e("td",[t._v("2.3a")]),t._v(" "),e("td",[t._v("14:30h")]),t._v(" "),e("td",[t._v("20min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Web Editor + QGIS")])]),t._v(" "),e("td",{attrs:{rowspan:"2"}},[t._v("Parallel session")])]),t._v(" "),e("tr",[e("td",[t._v("2.3b")]),t._v(" "),e("td",[t._v("14:30h")]),t._v(" "),e("td",[t._v("20min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3iWreUB",target:"_blank"}},[t._v("R Client")])])]),t._v(" "),e("tr",[e("td"),t._v(" "),e("td",[e("i",[t._v("14:50h")])]),t._v(" "),e("td",[e("i",[t._v("5min")])]),t._v(" "),e("td",{attrs:{colspan:"2"}},[e("i",[t._v("Short break / Switching sessions")])])]),t._v(" "),e("tr",[e("th",{attrs:{colspan:"5"}},[t._v("Guided Sessions and Q/A")])]),t._v(" "),e("tr",[e("td",[t._v("2.4a")]),t._v(" "),e("td",[t._v("14:55h")]),t._v(" "),e("td",[t._v("60min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Guided room for users to test the R Client")])]),t._v(" "),e("td",{attrs:{rowspan:"3"}},[t._v("Parallel session")])]),t._v(" "),e("tr",[e("td",[t._v("2.4b")]),t._v(" "),e("td",[t._v("14:55h")]),t._v(" "),e("td",[t._v("60min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3iWreUB",target:"_blank"}},[t._v("Guided room for users to test the Python Client")])])]),t._v(" "),e("tr",[e("td",[t._v("2.4c")]),t._v(" "),e("td",[t._v("14:55h")]),t._v(" "),e("td",[t._v("60min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/31bt2mH",target:"_blank"}},[t._v("Guided room for users to test other clients")])])]),t._v(" "),e("tr",[e("td",[t._v("2.5a")]),t._v(" "),e("td",[t._v("15:55h")]),t._v(" "),e("td",[t._v("15min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Q/A and Discussions: R Client")])]),t._v(" "),e("td",{attrs:{rowspan:"3"}},[t._v("Parallel session")])]),t._v(" "),e("tr",[e("td",[t._v("2.5b")]),t._v(" "),e("td",[t._v("15:55h")]),t._v(" "),e("td",[t._v("15min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3iWreUB",target:"_blank"}},[t._v("Q/A and Discussions: Python")])])]),t._v(" "),e("tr",[e("td",[t._v("2.5c")]),t._v(" "),e("td",[t._v("15:55h")]),t._v(" "),e("td",[t._v("15min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/31bt2mH",target:"_blank"}},[t._v("Q/A and Discussions: Other clients")])])]),t._v(" "),e("tr",[e("th",{attrs:{colspan:"5"}},[t._v("Wrap up")])]),t._v(" "),e("tr",[e("td",[t._v("2.6")]),t._v(" "),e("td",[t._v("16:10h")]),t._v(" "),e("td",[t._v("20min")]),t._v(" "),e("td",[e("a",{attrs:{href:"https://bit.ly/3lLblSX",target:"_blank"}},[t._v("Q/A; Discussion on user needs, future work")])]),t._v(" "),e("td")])])]),t._v(" "),e("p",[e("strong",[t._v("Background:")]),t._v(" openEO is a user-driven open source API, which grants a uniform communication between the Earth Observation (EO) data user community and diverse EO cloud service providers. Thus, it aims for a cross-platform interoperability to ease a comparison, the cooperation and the switch between them. The project consortium (H2020 Grant No 776242) released a stable version of the openEO API, covering standardised online processing of all aspects of an EO data life cycle on diverse cloud platforms.")]),t._v(" "),e("p",[t._v("In this User Workshop, the audience is provided with insight into the functionalities of the openEO API. In various live demonstration and training sessions, real demonstration cases will be explained from the user perspective. Possible applications of the openEO API will be presented for different access levels – from the use of programming languages to browser based model builders or mobile applications. Target audience for this event are programmers, decision makers, as well as third-party cloud EO service providers.")])])}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/app.61d0536c.js b/assets/js/app.c6bd9fb9.js similarity index 83% rename from assets/js/app.61d0536c.js rename to assets/js/app.c6bd9fb9.js index 66876bd51..f038dfd65 100644 --- a/assets/js/app.61d0536c.js +++ b/assets/js/app.c6bd9fb9.js @@ -1,4 +1,4 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[0],[]]);!function(e){function t(t){for(var r,i,s=t[0],l=t[1],c=t[2],p=0,d=[];p=0&&(t=e.slice(r),e=e.slice(0,r));var o=e.indexOf("?");return o>=0&&(n=e.slice(o+1),e=e.slice(0,o)),{path:e,query:n,hash:t}}(a.path||""),d=t&&t.path||"/",f=c.path?k(c.path,d,n||a.append):d,h=function(e,t,n){void 0===t&&(t={});var r,o=n||p;try{r=o(e||"")}catch(e){r={}}for(var a in t){var i=t[a];r[a]=Array.isArray(i)?i.map(u):u(i)}return r}(c.query,a.query,r&&r.options.parseQuery),v=a.hash||c.hash;return v&&"#"!==v.charAt(0)&&(v="#"+v),{_normalized:!0,path:f,query:h,hash:v}}var q,G=function(){},W={name:"RouterLink",props:{to:{type:[String,Object],required:!0},tag:{type:String,default:"a"},custom:Boolean,exact:Boolean,exactPath:Boolean,append:Boolean,replace:Boolean,activeClass:String,exactActiveClass:String,ariaCurrentValue:{type:String,default:"page"},event:{type:[String,Array],default:"click"}},render:function(e){var t=this,n=this.$router,r=this.$route,a=n.resolve(this.to,r,this.append),i=a.location,s=a.route,l=a.href,c={},u=n.options.linkActiveClass,p=n.options.linkExactActiveClass,d=null==u?"router-link-active":u,v=null==p?"router-link-exact-active":p,m=null==this.activeClass?d:this.activeClass,g=null==this.exactActiveClass?v:this.exactActiveClass,y=s.redirectedFrom?h(null,z(s.redirectedFrom),null,n):s;c[g]=b(r,y,this.exactPath),c[m]=this.exact||this.exactPath?c[g]:function(e,t){return 0===e.path.replace(f,"/").indexOf(t.path.replace(f,"/"))&&(!t.hash||e.hash===t.hash)&&function(e,t){for(var n in t)if(!(n in e))return!1;return!0}(e.query,t.query)}(r,y);var w=c[g]?this.ariaCurrentValue:null,_=function(e){H(e)&&(t.replace?n.replace(i,G):n.push(i,G))},x={click:H};Array.isArray(this.event)?this.event.forEach((function(e){x[e]=_})):x[this.event]=_;var P={class:c},k=!this.$scopedSlots.$hasNormal&&this.$scopedSlots.default&&this.$scopedSlots.default({href:l,route:s,navigate:_,isActive:c[m],isExactActive:c[g]});if(k){if(1===k.length)return k[0];if(k.length>1||!k.length)return 0===k.length?e():e("span",{},k)}if("a"===this.tag)P.on=x,P.attrs={href:l,"aria-current":w};else{var S=function e(t){var n;if(t)for(var r=0;r-1&&(s.params[d]=n.params[d]);return s.path=V(u.path,s.params),l(u,s,i)}if(s.path){s.params={};for(var f=0;f-1}function Se(e,t){return ke(e)&&e._isRouter&&(null==t||e.type===t)}function Oe(e,t,n){var r=function(o){o>=e.length?n():e[o]?t(e[o],(function(){r(o+1)})):r(o+1)};r(0)}function Ce(e){return function(t,n,r){var o=!1,a=0,i=null;Ee(e,(function(e,t,n,s){if("function"==typeof e&&void 0===e.cid){o=!0,a++;var l,c=Te((function(t){var o;((o=t).__esModule||$e&&"Module"===o[Symbol.toStringTag])&&(t=t.default),e.resolved="function"==typeof t?t:q.extend(t),n.components[s]=t,--a<=0&&r()})),u=Te((function(e){var t="Failed to resolve async component "+s+": "+e;i||(i=ke(e)?e:new Error(t),r(i))}));try{l=e(c,u)}catch(e){u(e)}if(l)if("function"==typeof l.then)l.then(c,u);else{var p=l.component;p&&"function"==typeof p.then&&p.then(c,u)}}})),o||r()}}function Ee(e,t){return je(e.map((function(e){return Object.keys(e.components).map((function(n){return t(e.components[n],e.instances[n],e,n)}))})))}function je(e){return Array.prototype.concat.apply([],e)}var $e="function"==typeof Symbol&&"symbol"==typeof Symbol.toStringTag;function Te(e){var t=!1;return function(){for(var n=[],r=arguments.length;r--;)n[r]=arguments[r];if(!t)return t=!0,e.apply(this,n)}}var Ae=function(e,t){this.router=e,this.base=function(e){if(!e)if(Z){var t=document.querySelector("base");e=(e=t&&t.getAttribute("href")||"/").replace(/^https?:\/\/[^\/]+/,"")}else e="/";"/"!==e.charAt(0)&&(e="/"+e);return e.replace(/\/$/,"")}(t),this.current=m,this.pending=null,this.ready=!1,this.readyCbs=[],this.readyErrorCbs=[],this.errorCbs=[],this.listeners=[]};function Re(e,t,n,r){var o=Ee(e,(function(e,r,o,a){var i=function(e,t){"function"!=typeof e&&(e=q.extend(e));return e.options[t]}(e,t);if(i)return Array.isArray(i)?i.map((function(e){return n(e,r,o,a)})):n(i,r,o,a)}));return je(r?o.reverse():o)}function Ue(e,t){if(t)return function(){return e.apply(t,arguments)}}Ae.prototype.listen=function(e){this.cb=e},Ae.prototype.onReady=function(e,t){this.ready?e():(this.readyCbs.push(e),t&&this.readyErrorCbs.push(t))},Ae.prototype.onError=function(e){this.errorCbs.push(e)},Ae.prototype.transitionTo=function(e,t,n){var r,o=this;try{r=this.router.match(e,this.current)}catch(e){throw this.errorCbs.forEach((function(t){t(e)})),e}var a=this.current;this.confirmTransition(r,(function(){o.updateRoute(r),t&&t(r),o.ensureURL(),o.router.afterHooks.forEach((function(e){e&&e(r,a)})),o.ready||(o.ready=!0,o.readyCbs.forEach((function(e){e(r)})))}),(function(e){n&&n(e),e&&!o.ready&&(Se(e,be.redirected)&&a===m||(o.ready=!0,o.readyErrorCbs.forEach((function(t){t(e)}))))}))},Ae.prototype.confirmTransition=function(e,t,n){var r=this,o=this.current;this.pending=e;var a,i,s=function(e){!Se(e)&&ke(e)&&(r.errorCbs.length?r.errorCbs.forEach((function(t){t(e)})):console.error(e)),n&&n(e)},l=e.matched.length-1,c=o.matched.length-1;if(b(e,o)&&l===c&&e.matched[l]===o.matched[c])return this.ensureURL(),e.hash&&se(this.router,o,e,!1),s(((i=xe(a=o,e,be.duplicated,'Avoided redundant navigation to current location: "'+a.fullPath+'".')).name="NavigationDuplicated",i));var u=function(e,t){var n,r=Math.max(e.length,t.length);for(n=0;n0)){var t=this.router,n=t.options.scrollBehavior,r=me&&n;r&&this.listeners.push(ie());var o=function(){var n=e.current,o=Le(e.base);e.current===m&&o===e._startLocation||e.transitionTo(o,(function(e){r&&se(t,e,n,!0)}))};window.addEventListener("popstate",o),this.listeners.push((function(){window.removeEventListener("popstate",o)}))}},t.prototype.go=function(e){window.history.go(e)},t.prototype.push=function(e,t,n){var r=this,o=this.current;this.transitionTo(e,(function(e){ge(S(r.base+e.fullPath)),se(r.router,e,o,!1),t&&t(e)}),n)},t.prototype.replace=function(e,t,n){var r=this,o=this.current;this.transitionTo(e,(function(e){ye(S(r.base+e.fullPath)),se(r.router,e,o,!1),t&&t(e)}),n)},t.prototype.ensureURL=function(e){if(Le(this.base)!==this.current.fullPath){var t=S(this.base+this.current.fullPath);e?ge(t):ye(t)}},t.prototype.getCurrentLocation=function(){return Le(this.base)},t}(Ae);function Le(e){var t=window.location.pathname,n=t.toLowerCase(),r=e.toLowerCase();return!e||n!==r&&0!==n.indexOf(S(r+"/"))||(t=t.slice(e.length)),(t||"/")+window.location.search+window.location.hash}var Ie=function(e){function t(t,n,r){e.call(this,t,n),r&&function(e){var t=Le(e);if(!/^\/#/.test(t))return window.location.replace(S(e+"/#"+t)),!0}(this.base)||De()}return e&&(t.__proto__=e),t.prototype=Object.create(e&&e.prototype),t.prototype.constructor=t,t.prototype.setupListeners=function(){var e=this;if(!(this.listeners.length>0)){var t=this.router.options.scrollBehavior,n=me&&t;n&&this.listeners.push(ie());var r=function(){var t=e.current;De()&&e.transitionTo(Ne(),(function(r){n&&se(e.router,r,t,!0),me||Be(r.fullPath)}))},o=me?"popstate":"hashchange";window.addEventListener(o,r),this.listeners.push((function(){window.removeEventListener(o,r)}))}},t.prototype.push=function(e,t,n){var r=this,o=this.current;this.transitionTo(e,(function(e){Je(e.fullPath),se(r.router,e,o,!1),t&&t(e)}),n)},t.prototype.replace=function(e,t,n){var r=this,o=this.current;this.transitionTo(e,(function(e){Be(e.fullPath),se(r.router,e,o,!1),t&&t(e)}),n)},t.prototype.go=function(e){window.history.go(e)},t.prototype.ensureURL=function(e){var t=this.current.fullPath;Ne()!==t&&(e?Je(t):Be(t))},t.prototype.getCurrentLocation=function(){return Ne()},t}(Ae);function De(){var e=Ne();return"/"===e.charAt(0)||(Be("/"+e),!1)}function Ne(){var e=window.location.href,t=e.indexOf("#");return t<0?"":e=e.slice(t+1)}function Fe(e){var t=window.location.href,n=t.indexOf("#");return(n>=0?t.slice(0,n):t)+"#"+e}function Je(e){me?ge(Fe(e)):window.location.hash=e}function Be(e){me?ye(Fe(e)):window.location.replace(Fe(e))}var Ve=function(e){function t(t,n){e.call(this,t,n),this.stack=[],this.index=-1}return e&&(t.__proto__=e),t.prototype=Object.create(e&&e.prototype),t.prototype.constructor=t,t.prototype.push=function(e,t,n){var r=this;this.transitionTo(e,(function(e){r.stack=r.stack.slice(0,r.index+1).concat(e),r.index++,t&&t(e)}),n)},t.prototype.replace=function(e,t,n){var r=this;this.transitionTo(e,(function(e){r.stack=r.stack.slice(0,r.index).concat(e),t&&t(e)}),n)},t.prototype.go=function(e){var t=this,n=this.index+e;if(!(n<0||n>=this.stack.length)){var r=this.stack[n];this.confirmTransition(r,(function(){var e=t.current;t.index=n,t.updateRoute(r),t.router.afterHooks.forEach((function(t){t&&t(r,e)}))}),(function(e){Se(e,be.duplicated)&&(t.index=n)}))}},t.prototype.getCurrentLocation=function(){var e=this.stack[this.stack.length-1];return e?e.fullPath:"/"},t.prototype.ensureURL=function(){},t}(Ae),ze=function(e){void 0===e&&(e={}),this.app=null,this.apps=[],this.options=e,this.beforeHooks=[],this.resolveHooks=[],this.afterHooks=[],this.matcher=Q(e.routes||[],this);var t=e.mode||"hash";switch(this.fallback="history"===t&&!me&&!1!==e.fallback,this.fallback&&(t="hash"),Z||(t="abstract"),this.mode=t,t){case"history":this.history=new Me(this,e.base);break;case"hash":this.history=new Ie(this,e.base,this.fallback);break;case"abstract":this.history=new Ve(this,e.base);break;default:0}},qe={currentRoute:{configurable:!0}};ze.prototype.match=function(e,t,n){return this.matcher.match(e,t,n)},qe.currentRoute.get=function(){return this.history&&this.history.current},ze.prototype.init=function(e){var t=this;if(this.apps.push(e),e.$once("hook:destroyed",(function(){var n=t.apps.indexOf(e);n>-1&&t.apps.splice(n,1),t.app===e&&(t.app=t.apps[0]||null),t.app||t.history.teardown()})),!this.app){this.app=e;var n=this.history;if(n instanceof Me||n instanceof Ie){var r=function(e){n.setupListeners(),function(e){var r=n.current,o=t.options.scrollBehavior;me&&o&&"fullPath"in e&&se(t,e,r,!1)}(e)};n.transitionTo(n.getCurrentLocation(),r,r)}n.listen((function(e){t.apps.forEach((function(t){t._route=e}))}))}},ze.prototype.beforeEach=function(e){return We(this.beforeHooks,e)},ze.prototype.beforeResolve=function(e){return We(this.resolveHooks,e)},ze.prototype.afterEach=function(e){return We(this.afterHooks,e)},ze.prototype.onReady=function(e,t){this.history.onReady(e,t)},ze.prototype.onError=function(e){this.history.onError(e)},ze.prototype.push=function(e,t,n){var r=this;if(!t&&!n&&"undefined"!=typeof Promise)return new Promise((function(t,n){r.history.push(e,t,n)}));this.history.push(e,t,n)},ze.prototype.replace=function(e,t,n){var r=this;if(!t&&!n&&"undefined"!=typeof Promise)return new Promise((function(t,n){r.history.replace(e,t,n)}));this.history.replace(e,t,n)},ze.prototype.go=function(e){this.history.go(e)},ze.prototype.back=function(){this.go(-1)},ze.prototype.forward=function(){this.go(1)},ze.prototype.getMatchedComponents=function(e){var t=e?e.matched?e:this.resolve(e).route:this.currentRoute;return t?[].concat.apply([],t.matched.map((function(e){return Object.keys(e.components).map((function(t){return e.components[t]}))}))):[]},ze.prototype.resolve=function(e,t,n){var r=z(e,t=t||this.history.current,n,this),o=this.match(r,t),a=o.redirectedFrom||o.fullPath;return{location:r,route:o,href:function(e,t,n){var r="hash"===n?"#"+t:t;return e?S(e+"/"+r):r}(this.history.base,a,this.mode),normalizedTo:r,resolved:o}},ze.prototype.getRoutes=function(){return this.matcher.getRoutes()},ze.prototype.addRoute=function(e,t){this.matcher.addRoute(e,t),this.history.current!==m&&this.history.transitionTo(this.history.getCurrentLocation())},ze.prototype.addRoutes=function(e){this.matcher.addRoutes(e),this.history.current!==m&&this.history.transitionTo(this.history.getCurrentLocation())},Object.defineProperties(ze.prototype,qe);var Ge=ze;function We(e,t){return e.push(t),function(){var n=e.indexOf(t);n>-1&&e.splice(n,1)}}ze.install=function e(t){if(!e.installed||q!==t){e.installed=!0,q=t;var n=function(e){return void 0!==e},r=function(e,t){var r=e.$options._parentVnode;n(r)&&n(r=r.data)&&n(r=r.registerRouteInstance)&&r(e,t)};t.mixin({beforeCreate:function(){n(this.$options.router)?(this._routerRoot=this,this._router=this.$options.router,this._router.init(this),t.util.defineReactive(this,"_route",this._router.history.current)):this._routerRoot=this.$parent&&this.$parent._routerRoot||this,r(this,this)},destroyed:function(){r(this)}}),Object.defineProperty(t.prototype,"$router",{get:function(){return this._routerRoot._router}}),Object.defineProperty(t.prototype,"$route",{get:function(){return this._routerRoot._route}}),t.component("RouterView",x),t.component("RouterLink",W);var o=t.config.optionMergeStrategies;o.beforeRouteEnter=o.beforeRouteLeave=o.beforeRouteUpdate=o.created}},ze.version="3.6.5",ze.isNavigationFailure=Se,ze.NavigationFailureType=be,ze.START_LOCATION=m,Z&&window.Vue&&window.Vue.use(ze);var He={"components/AlgoliaSearchBox":()=>Promise.all([n.e(0),n.e(29)]).then(n.bind(null,290)),"components/DropdownLink":()=>Promise.all([n.e(0),n.e(17)]).then(n.bind(null,180)),"components/DropdownTransition":()=>Promise.all([n.e(0),n.e(30)]).then(n.bind(null,160)),"components/Home":()=>Promise.all([n.e(0),n.e(23)]).then(n.bind(null,291)),"components/NavLink":()=>n.e(38).then(n.bind(null,159)),"components/NavLinks":()=>Promise.all([n.e(0),n.e(16)]).then(n.bind(null,200)),"components/Navbar":()=>Promise.all([n.e(0),n.e(1)]).then(n.bind(null,465)),"components/Page":()=>Promise.all([n.e(0),n.e(14)]).then(n.bind(null,292)),"components/PageEdit":()=>Promise.all([n.e(0),n.e(24)]).then(n.bind(null,205)),"components/PageNav":()=>Promise.all([n.e(0),n.e(21)]).then(n.bind(null,206)),"components/Sidebar":()=>Promise.all([n.e(0),n.e(12)]).then(n.bind(null,293)),"components/SidebarButton":()=>Promise.all([n.e(0),n.e(31)]).then(n.bind(null,296)),"components/SidebarGroup":()=>Promise.all([n.e(0),n.e(3)]).then(n.bind(null,201)),"components/SidebarLink":()=>Promise.all([n.e(0),n.e(25)]).then(n.bind(null,181)),"components/SidebarLinks":()=>Promise.all([n.e(0),n.e(3)]).then(n.bind(null,176)),"components/VersionChooser":()=>Promise.all([n.e(0),n.e(20)]).then(n.bind(null,294)),"components/VersioningMixin":()=>n.e(52).then(n.bind(null,164)),"global-components/Badge":()=>Promise.all([n.e(0),n.e(4)]).then(n.bind(null,490)),"layouts/404":()=>n.e(7).then(n.bind(null,477)),"layouts/Layout":()=>Promise.all([n.e(0),n.e(1),n.e(2)]).then(n.bind(null,478)),NotFound:()=>n.e(7).then(n.bind(null,477)),Layout:()=>Promise.all([n.e(0),n.e(1),n.e(2)]).then(n.bind(null,478))},Ze={"v-3ec20de4":()=>n.e(54).then(n.bind(null,491)),"v-31596d2d":()=>n.e(55).then(n.bind(null,492)),"v-26232766":()=>n.e(56).then(n.bind(null,493)),"v-5e94256a":()=>n.e(57).then(n.bind(null,494)),"v-5e0de9fe":()=>n.e(59).then(n.bind(null,495)),"v-4155eb1e":()=>n.e(58).then(n.bind(null,496)),"v-418e1b4d":()=>n.e(60).then(n.bind(null,497)),"v-6bf62e0d":()=>n.e(41).then(n.bind(null,498)),"v-63a2d53d":()=>n.e(61).then(n.bind(null,499)),"v-d80ea866":()=>n.e(62).then(n.bind(null,500)),"v-4899abd1":()=>n.e(63).then(n.bind(null,501)),"v-4081eb72":()=>n.e(64).then(n.bind(null,502)),"v-5e5c94cd":()=>n.e(65).then(n.bind(null,503)),"v-0059cb2a":()=>n.e(66).then(n.bind(null,504)),"v-25dd3de6":()=>n.e(67).then(n.bind(null,505)),"v-6993aee6":()=>n.e(68).then(n.bind(null,506)),"v-3359623e":()=>n.e(42).then(n.bind(null,507)),"v-6aca4be5":()=>n.e(70).then(n.bind(null,508)),"v-cfac61a6":()=>n.e(69).then(n.bind(null,509)),"v-37dbaaa0":()=>n.e(71).then(n.bind(null,510)),"v-7758ae27":()=>n.e(72).then(n.bind(null,511)),"v-9f635184":()=>n.e(18).then(n.bind(null,512)),"v-5fd8f1ad":()=>n.e(13).then(n.bind(null,513)),"v-8d587926":()=>n.e(76).then(n.bind(null,514)),"v-f5de2fb4":()=>n.e(73).then(n.bind(null,515)),"v-43de507e":()=>n.e(74).then(n.bind(null,516)),"v-654015de":()=>n.e(75).then(n.bind(null,517)),"v-dc734f12":()=>n.e(77).then(n.bind(null,518)),"v-75018026":()=>n.e(43).then(n.bind(null,519)),"v-253cefad":()=>n.e(79).then(n.bind(null,520)),"v-1772ad2d":()=>n.e(78).then(n.bind(null,521)),"v-2840d4fe":()=>n.e(80).then(n.bind(null,522)),"v-1b45967e":()=>n.e(81).then(n.bind(null,523)),"v-021062ed":()=>n.e(82).then(n.bind(null,524)),"v-e35c5e24":()=>n.e(83).then(n.bind(null,525)),"v-97aa86e6":()=>n.e(44).then(n.bind(null,526)),"v-04d2236d":()=>n.e(45).then(n.bind(null,527)),"v-4af2bfca":()=>n.e(84).then(n.bind(null,528)),"v-1a823cb0":()=>n.e(46).then(n.bind(null,529)),"v-00153acd":()=>n.e(85).then(n.bind(null,530)),"v-9a2a2626":()=>n.e(86).then(n.bind(null,531)),"v-560d08d2":()=>n.e(47).then(n.bind(null,532)),"v-592eaa86":()=>n.e(48).then(n.bind(null,533)),"v-ef2073ec":()=>n.e(15).then(n.bind(null,534)),"v-ffc79ec2":()=>n.e(87).then(n.bind(null,535)),"v-c71b5aa6":()=>n.e(88).then(n.bind(null,536)),"v-1005bb66":()=>n.e(89).then(n.bind(null,537)),"v-186cd6ed":()=>n.e(90).then(n.bind(null,538)),"v-0ee3f026":()=>n.e(91).then(n.bind(null,539)),"v-2997b752":()=>n.e(92).then(n.bind(null,540)),"v-24966ce6":()=>n.e(49).then(n.bind(null,541)),"v-4fe4e126":()=>n.e(93).then(n.bind(null,542)),"v-f9778ae6":()=>n.e(94).then(n.bind(null,543)),"v-d2a018a6":()=>n.e(95).then(n.bind(null,544)),"v-9ddae032":()=>n.e(96).then(n.bind(null,545)),"v-45d803ab":()=>n.e(50).then(n.bind(null,546)),"v-3f85032d":()=>n.e(97).then(n.bind(null,547)),"v-2fcee9ad":()=>n.e(98).then(n.bind(null,548)),"v-0e5e57cd":()=>n.e(100).then(n.bind(null,549)),"v-525dec3e":()=>n.e(99).then(n.bind(null,550)),"v-6e6b7e2d":()=>n.e(101).then(n.bind(null,551)),"v-06e0a8ca":()=>n.e(102).then(n.bind(null,552)),"v-1227575e":()=>n.e(103).then(n.bind(null,553)),"v-59d340ad":()=>n.e(51).then(n.bind(null,554)),"v-221bfb8d":()=>n.e(105).then(n.bind(null,555)),"v-00d62ee6":()=>n.e(104).then(n.bind(null,556)),"v-857a96a6":()=>n.e(107).then(n.bind(null,557)),"v-10d9ffb7":()=>n.e(108).then(n.bind(null,558)),"v-3eeef04a":()=>n.e(106).then(n.bind(null,559)),"v-d5007282":()=>n.e(109).then(n.bind(null,560)),"v-8850e2c4":()=>n.e(110).then(n.bind(null,561)),"v-64c18f4d":()=>n.e(111).then(n.bind(null,562)),"v-9adb302a":()=>n.e(112).then(n.bind(null,563))};function Ke(e){const t=Object.create(null);return function(n){return t[n]||(t[n]=e(n))}}const Xe=/-(\w)/g,Qe=Ke(e=>e.replace(Xe,(e,t)=>t?t.toUpperCase():"")),Ye=/\B([A-Z])/g,et=Ke(e=>e.replace(Ye,"-$1").toLowerCase()),tt=Ke(e=>e.charAt(0).toUpperCase()+e.slice(1));function nt(e,t){if(!t)return;if(e(t))return e(t);return t.includes("-")?e(tt(Qe(t))):e(tt(t))||e(et(t))}const rt=Object.assign({},He,Ze),ot=e=>rt[e],at=e=>Ze[e],it=e=>He[e],st=e=>r.a.component(e);function lt(e){return nt(at,e)}function ct(e){return nt(it,e)}function ut(e){return nt(ot,e)}function pt(e){return nt(st,e)}function dt(...e){return Promise.all(e.filter(e=>e).map(async e=>{if(!pt(e)&&ut(e)){const t=await ut(e)();r.a.component(e,t.default)}}))}function ft(e,t){"undefined"!=typeof window&&window.__VUEPRESS__&&(window.__VUEPRESS__[e]=t)}var ht=n(47),vt=n.n(ht),mt=n(48),gt=n.n(mt),yt={created(){if(this.siteMeta=this.$site.headTags.filter(([e])=>"meta"===e).map(([e,t])=>t),this.$ssrContext){const t=this.getMergedMetaTags();this.$ssrContext.title=this.$title,this.$ssrContext.lang=this.$lang,this.$ssrContext.pageMeta=(e=t)?e.map(e=>{let t="{t+=` ${n}="${gt()(e[n])}"`}),t+">"}).join("\n "):"",this.$ssrContext.canonicalLink=wt(this.$canonicalUrl)}var e},mounted(){this.currentMetaTags=[...document.querySelectorAll("meta")],this.updateMeta(),this.updateCanonicalLink()},methods:{updateMeta(){document.title=this.$title,document.documentElement.lang=this.$lang;const e=this.getMergedMetaTags();this.currentMetaTags=_t(e,this.currentMetaTags)},getMergedMetaTags(){const e=this.$page.frontmatter.meta||[];return vt()([{name:"description",content:this.$description}],e,this.siteMeta,xt)},updateCanonicalLink(){bt(),this.$canonicalUrl&&document.head.insertAdjacentHTML("beforeend",wt(this.$canonicalUrl))}},watch:{$page(){this.updateMeta(),this.updateCanonicalLink()}},beforeDestroy(){_t(null,this.currentMetaTags),bt()}};function bt(){const e=document.querySelector("link[rel='canonical']");e&&e.remove()}function wt(e=""){return e?``:""}function _t(e,t){if(t&&[...t].filter(e=>e.parentNode===document.head).forEach(e=>document.head.removeChild(e)),e)return e.map(e=>{const t=document.createElement("meta");return Object.keys(e).forEach(n=>{t.setAttribute(n,e[n])}),document.head.appendChild(t),t})}function xt(e){for(const t of["name","property","itemprop"])if(e.hasOwnProperty(t))return e[t]+t;return JSON.stringify(e)}var Pt=n(13),kt=n.n(Pt),St={mounted(){kt.a.configure({showSpinner:!1}),this.$router.beforeEach((e,t,n)=>{e.path===t.path||r.a.component(e.name)||kt.a.start(),n()}),this.$router.afterEach(()=>{kt.a.done(),this.isSidebarOpen=!1})}},Ot=n(49),Ct={mounted(){window.addEventListener("scroll",this.onScroll)},methods:{onScroll:n.n(Ot)()((function(){this.setActiveHash()}),300),setActiveHash(){const e=[].slice.call(document.querySelectorAll(".sidebar-link")),t=[].slice.call(document.querySelectorAll(".header-anchor")).filter(t=>e.some(e=>e.hash===t.hash)),n=Math.max(window.pageYOffset,document.documentElement.scrollTop,document.body.scrollTop),r=Math.max(document.documentElement.scrollHeight,document.body.scrollHeight),o=window.innerHeight+n;for(let e=0;e=a.parentElement.offsetTop+10&&(!i||n{this.$nextTick(()=>{this.$vuepress.$set("disableScrollBehavior",!1)})})}}}},beforeDestroy(){window.removeEventListener("scroll",this.onScroll)}},Et={props:{parent:Object,code:String,options:{align:String,color:String,backgroundTransition:Boolean,backgroundColor:String,successText:String,staticIcon:Boolean}},data:()=>({success:!1,originalBackground:null,originalTransition:null}),computed:{alignStyle(){let e={};return e[this.options.align]="7.5px",e},iconClass(){return this.options.staticIcon?"":"hover"}},mounted(){this.originalTransition=this.parent.style.transition,this.originalBackground=this.parent.style.background},beforeDestroy(){this.parent.style.transition=this.originalTransition,this.parent.style.background=this.originalBackground},methods:{hexToRgb(e){let t=/^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(e);return t?{r:parseInt(t[1],16),g:parseInt(t[2],16),b:parseInt(t[3],16)}:null},copyToClipboard(e){if(navigator.clipboard)navigator.clipboard.writeText(this.code).then(()=>{this.setSuccessTransitions()},()=>{});else{let e=document.createElement("textarea");document.body.appendChild(e),e.value=this.code,e.select(),document.execCommand("Copy"),e.remove(),this.setSuccessTransitions()}},setSuccessTransitions(){if(clearTimeout(this.successTimeout),this.options.backgroundTransition){this.parent.style.transition="background 350ms";let e=this.hexToRgb(this.options.backgroundColor);this.parent.style.background=`rgba(${e.r}, ${e.g}, ${e.b}, 0.1)`}this.success=!0,this.successTimeout=setTimeout(()=>{this.options.backgroundTransition&&(this.parent.style.background=this.originalBackground,this.parent.style.transition=this.originalTransition),this.success=!1},500)}}},jt=(n(146),n(4)),$t=Object(jt.a)(Et,(function(){var e=this,t=e._self._c;return t("div",{staticClass:"code-copy"},[t("svg",{class:e.iconClass,style:e.alignStyle,attrs:{xmlns:"http://www.w3.org/2000/svg",width:"24",height:"24",viewBox:"0 0 24 24"},on:{click:e.copyToClipboard}},[t("path",{attrs:{fill:"none",d:"M0 0h24v24H0z"}}),e._v(" "),t("path",{attrs:{fill:e.options.color,d:"M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4l6 6v10c0 1.1-.9 2-2 2H7.99C6.89 23 6 22.1 6 21l.01-14c0-1.1.89-2 1.99-2h7zm-1 7h5.5L14 6.5V12z"}})]),e._v(" "),t("span",{class:e.success?"success":"",style:e.alignStyle},[e._v("\n "+e._s(e.options.successText)+"\n ")])])}),[],!1,null,"49140617",null).exports,Tt=(n(147),[yt,St,Ct,{updated(){this.update()},methods:{update(){setTimeout(()=>{document.querySelectorAll('div[class*="language-"] pre').forEach(e=>{if(e.classList.contains("code-copy-added"))return;let t=new(r.a.extend($t));t.options={align:"bottom",color:"#27b1ff",backgroundTransition:!0,backgroundColor:"#0075b8",successText:"Copied!",staticIcon:!1},t.code=e.innerText,t.parent=e,t.$mount(),e.classList.add("code-copy-added"),e.appendChild(t.$el)})},100)}}}]),At={name:"GlobalLayout",computed:{layout(){const e=this.getLayout();return ft("layout",e),r.a.component(e)}},methods:{getLayout(){if(this.$page.path){const e=this.$page.frontmatter.layout;return e&&(this.$vuepress.getLayoutAsyncComponent(e)||this.$vuepress.getVueComponent(e))?e:"Layout"}return"NotFound"}}},Rt=Object(jt.a)(At,(function(){return(0,this._self._c)(this.layout,{tag:"component"})}),[],!1,null,null,null).exports;!function(e,t,n){switch(t){case"components":e[t]||(e[t]={}),Object.assign(e[t],n);break;case"mixins":e[t]||(e[t]=[]),e[t].push(...n);break;default:throw new Error("Unknown option name.")}}(Rt,"mixins",Tt);const Ut=[{name:"v-3ec20de4",path:"/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-3ec20de4").then(n)}},{path:"/index.html",redirect:"/"},{name:"v-31596d2d",path:"/about.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-31596d2d").then(n)}},{name:"v-26232766",path:"/contact.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-26232766").then(n)}},{name:"v-5e94256a",path:"/documentation/0.4/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-5e94256a").then(n)}},{path:"/documentation/0.4/index.html",redirect:"/documentation/0.4/"},{name:"v-5e0de9fe",path:"/documentation/0.4/developers/api/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-5e0de9fe").then(n)}},{path:"/documentation/0.4/developers/api/index.html",redirect:"/documentation/0.4/developers/api/"},{name:"v-4155eb1e",path:"/documentation/0.4/developers/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-4155eb1e").then(n)}},{path:"/documentation/0.4/developers/index.html",redirect:"/documentation/0.4/developers/"},{name:"v-418e1b4d",path:"/documentation/0.4/developers/api/errors.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-418e1b4d").then(n)}},{name:"v-6bf62e0d",path:"/documentation/0.4/developers/arch.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-6bf62e0d").then(n)}},{name:"v-63a2d53d",path:"/documentation/0.4/developers/api/reference.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-63a2d53d").then(n)}},{name:"v-d80ea866",path:"/documentation/0.4/developers/backends/getting-started.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-d80ea866").then(n)}},{name:"v-4899abd1",path:"/documentation/0.4/developers/backends/udfs.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-4899abd1").then(n)}},{name:"v-4081eb72",path:"/documentation/0.4/developers/clients/getting-started.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-4081eb72").then(n)}},{name:"v-5e5c94cd",path:"/documentation/0.4/developers/clients/library-guidelines.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-5e5c94cd").then(n)}},{name:"v-0059cb2a",path:"/documentation/0.4/developers/examples/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-0059cb2a").then(n)}},{path:"/documentation/0.4/developers/examples/index.html",redirect:"/documentation/0.4/developers/examples/"},{name:"v-25dd3de6",path:"/documentation/0.4/developers/examples/poc.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-25dd3de6").then(n)}},{name:"v-6993aee6",path:"/documentation/0.4/getting-started.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-6993aee6").then(n)}},{name:"v-3359623e",path:"/documentation/0.4/glossary.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-3359623e").then(n)}},{name:"v-6aca4be5",path:"/documentation/0.4/udfs.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-6aca4be5").then(n)}},{name:"v-cfac61a6",path:"/documentation/0.4/processes.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-cfac61a6").then(n)}},{name:"v-37dbaaa0",path:"/documentation/1.0/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-37dbaaa0").then(n)}},{path:"/documentation/1.0/index.html",redirect:"/documentation/1.0/"},{name:"v-7758ae27",path:"/documentation/1.0/authentication.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-7758ae27").then(n)}},{name:"v-9f635184",path:"/documentation/1.0/cookbook/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-9f635184").then(n)}},{path:"/documentation/1.0/cookbook/index.html",redirect:"/documentation/1.0/cookbook/"},{name:"v-5fd8f1ad",path:"/documentation/1.0/datacubes.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-5fd8f1ad").then(n)}},{name:"v-8d587926",path:"/documentation/1.0/developers/api/errors.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-8d587926").then(n)}},{name:"v-f5de2fb4",path:"/documentation/1.0/datacubes/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-f5de2fb4").then(n)}},{path:"/documentation/1.0/datacubes/index.html",redirect:"/documentation/1.0/datacubes/"},{name:"v-43de507e",path:"/documentation/1.0/developers/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-43de507e").then(n)}},{path:"/documentation/1.0/developers/index.html",redirect:"/documentation/1.0/developers/"},{name:"v-654015de",path:"/documentation/1.0/developers/api/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-654015de").then(n)}},{path:"/documentation/1.0/developers/api/index.html",redirect:"/documentation/1.0/developers/api/"},{name:"v-dc734f12",path:"/documentation/1.0/developers/api/reference.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-dc734f12").then(n)}},{name:"v-75018026",path:"/documentation/1.0/developers/arch.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-75018026").then(n)}},{name:"v-253cefad",path:"/documentation/1.0/developers/backends/performance.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-253cefad").then(n)}},{name:"v-1772ad2d",path:"/documentation/1.0/developers/backends/getting-started.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-1772ad2d").then(n)}},{name:"v-2840d4fe",path:"/documentation/1.0/developers/backends/xarray.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-2840d4fe").then(n)}},{name:"v-1b45967e",path:"/documentation/1.0/developers/clients/getting-started.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-1b45967e").then(n)}},{name:"v-021062ed",path:"/documentation/1.0/developers/clients/library-guidelines.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-021062ed").then(n)}},{name:"v-e35c5e24",path:"/documentation/1.0/developers/profiles/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-e35c5e24").then(n)}},{path:"/documentation/1.0/developers/profiles/index.html",redirect:"/documentation/1.0/developers/profiles/"},{name:"v-97aa86e6",path:"/documentation/1.0/developers/profiles/api.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-97aa86e6").then(n)}},{name:"v-04d2236d",path:"/documentation/1.0/developers/profiles/processes.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-04d2236d").then(n)}},{name:"v-4af2bfca",path:"/documentation/1.0/glossary.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-4af2bfca").then(n)}},{name:"v-1a823cb0",path:"/documentation/1.0/javascript/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-1a823cb0").then(n)}},{path:"/documentation/1.0/javascript/index.html",redirect:"/documentation/1.0/javascript/"},{name:"v-00153acd",path:"/documentation/1.0/processes.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-00153acd").then(n)}},{name:"v-9a2a2626",path:"/documentation/1.0/python/client-side-processing.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-9a2a2626").then(n)}},{name:"v-560d08d2",path:"/documentation/1.0/python/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-560d08d2").then(n)}},{path:"/documentation/1.0/python/index.html",redirect:"/documentation/1.0/python/"},{name:"v-592eaa86",path:"/documentation/1.0/r/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-592eaa86").then(n)}},{path:"/documentation/1.0/r/index.html",redirect:"/documentation/1.0/r/"},{name:"v-ef2073ec",path:"/documentation/1.0/qgis/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-ef2073ec").then(n)}},{path:"/documentation/1.0/qgis/index.html",redirect:"/documentation/1.0/qgis/"},{name:"v-ffc79ec2",path:"/documentation/1.0/udfs.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-ffc79ec2").then(n)}},{name:"v-c71b5aa6",path:"/documentation/code-of-conduct.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-c71b5aa6").then(n)}},{name:"v-1005bb66",path:"/documentation/software-guidelines.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-1005bb66").then(n)}},{name:"v-186cd6ed",path:"/events/igarrs2021.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-186cd6ed").then(n)}},{name:"v-0ee3f026",path:"/news/2017-12-05-welcome.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-0ee3f026").then(n)}},{name:"v-2997b752",path:"/news/2017-12-18-VITO_meeting.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-2997b752").then(n)}},{name:"v-24966ce6",path:"/news/2018-01-31-WWU_meeting.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-24966ce6").then(n)}},{name:"v-4fe4e126",path:"/news/2018-03-15-poc.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-4fe4e126").then(n)}},{name:"v-f9778ae6",path:"/news/2018-05-23-user-requirements-survey-launched.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-f9778ae6").then(n)}},{name:"v-d2a018a6",path:"/news/2018-10-30-year-one-review-meeting.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-d2a018a6").then(n)}},{name:"v-9ddae032",path:"/news/2019-10-07-EO-big-data-hackaton.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-9ddae032").then(n)}},{name:"v-45d803ab",path:"/news/2019-03-07-openeo-api-040.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-45d803ab").then(n)}},{name:"v-3f85032d",path:"/news/2020-07-31-lessons-learned.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-3f85032d").then(n)}},{name:"v-2fcee9ad",path:"/news/2020-07-31-openeo-api-released.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-2fcee9ad").then(n)}},{name:"v-0e5e57cd",path:"/news/2020-11-30-openeo-api-101-released.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-0e5e57cd").then(n)}},{name:"v-525dec3e",path:"/news/2020-09-02-openeo-user-workshop.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-525dec3e").then(n)}},{name:"v-6e6b7e2d",path:"/news/2021-05-17-openeo-api-110-released.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-6e6b7e2d").then(n)}},{name:"v-06e0a8ca",path:"/news/2021-11-08-r-client-on-cran.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-06e0a8ca").then(n)}},{name:"v-1227575e",path:"/news/2022-04-08-psc-meetings.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-1227575e").then(n)}},{name:"v-59d340ad",path:"/news/2022-05-12-r-client-v120.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-59d340ad").then(n)}},{name:"v-221bfb8d",path:"/news/2022-11-17-r-client-v130.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-221bfb8d").then(n)}},{name:"v-00d62ee6",path:"/news/2022-07-07-monthly-dev-calls.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-00d62ee6").then(n)}},{name:"v-857a96a6",path:"/news/2023-12-06-openeo-submitted-to-ogc.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-857a96a6").then(n)}},{name:"v-10d9ffb7",path:"/news/2024-02-06-openeo-ogc-rfc.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-10d9ffb7").then(n)}},{name:"v-3eeef04a",path:"/news/2023-05-25-new-openeo-versions-120-200rc1%20copy.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-3eeef04a").then(n)}},{path:"/news/2023-05-25-new-openeo-versions-120-200rc1 copy.html",redirect:"/news/2023-05-25-new-openeo-versions-120-200rc1%20copy.html"},{path:"/news/2023-05-25-new-openeo-versions-120-200rc1 copy.html",redirect:"/news/2023-05-25-new-openeo-versions-120-200rc1%20copy.html"},{name:"v-d5007282",path:"/news/2024-03-22_mooc_cubeandclouds.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-d5007282").then(n)}},{name:"v-8850e2c4",path:"/news/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-8850e2c4").then(n)}},{path:"/news/index.html",redirect:"/news/"},{name:"v-64c18f4d",path:"/psc.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-64c18f4d").then(n)}},{name:"v-9adb302a",path:"/software.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-9adb302a").then(n)}},{path:"*",component:Rt}],Mt={title:"openEO",description:"openEO develops an open API to connect various clients to big EO cloud back-ends in a simple and unified way.",base:"/",headTags:[],pages:[{title:"Home",frontmatter:{home:!0},regularPath:"/",relativePath:"README.md",key:"v-3ec20de4",path:"/",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"About",frontmatter:{},regularPath:"/about.html",relativePath:"about.md",key:"v-31596d2d",path:"/about.html",headers:[{level:2,title:"openEO?",slug:"openeo"},{level:2,title:"Why an API?",slug:"why-an-api"},{level:2,title:"More information",slug:"more-information"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Contact",frontmatter:{sidebar:!1},regularPath:"/contact.html",relativePath:"contact.md",key:"v-26232766",path:"/contact.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO Documentation",frontmatter:{},regularPath:"/documentation/0.4/",relativePath:"documentation/0.4/README.md",key:"v-5e94256a",path:"/documentation/0.4/",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{frontmatter:{iframe:"https://api.openeo.org/v/0.4.2/"},regularPath:"/documentation/0.4/developers/api/",relativePath:"documentation/0.4/developers/api/README.md",key:"v-5e0de9fe",path:"/documentation/0.4/developers/api/",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Introduction",frontmatter:{},regularPath:"/documentation/0.4/developers/",relativePath:"documentation/0.4/developers/README.md",key:"v-4155eb1e",path:"/documentation/0.4/developers/",headers:[{level:2,title:"Additional information",slug:"additional-information"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Status and error handling",frontmatter:{},regularPath:"/documentation/0.4/developers/api/errors.html",relativePath:"documentation/0.4/developers/api/errors.md",key:"v-418e1b4d",path:"/documentation/0.4/developers/api/errors.html",headers:[{level:2,title:"JSON error object",slug:"json-error-object"},{level:2,title:"Standardized status codes",slug:"standardized-status-codes"},{level:2,title:"openEO error codes",slug:"openeo-error-codes"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Architecture",frontmatter:{},regularPath:"/documentation/0.4/developers/arch.html",relativePath:"documentation/0.4/developers/arch.md",key:"v-6bf62e0d",path:"/documentation/0.4/developers/arch.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{frontmatter:{fullpage:!0,stripCSS:!0},regularPath:"/documentation/0.4/developers/api/reference.html",relativePath:"documentation/0.4/developers/api/reference.md",key:"v-63a2d53d",path:"/documentation/0.4/developers/api/reference.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Getting started for back-end providers",frontmatter:{},regularPath:"/documentation/0.4/developers/backends/getting-started.html",relativePath:"documentation/0.4/developers/backends/getting-started.md",key:"v-d80ea866",path:"/documentation/0.4/developers/backends/getting-started.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"User-defined functions",frontmatter:{},regularPath:"/documentation/0.4/developers/backends/udfs.html",relativePath:"documentation/0.4/developers/backends/udfs.md",key:"v-4899abd1",path:"/documentation/0.4/developers/backends/udfs.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Getting started for client developers",frontmatter:{},regularPath:"/documentation/0.4/developers/clients/getting-started.html",relativePath:"documentation/0.4/developers/clients/getting-started.md",key:"v-4081eb72",path:"/documentation/0.4/developers/clients/getting-started.html",headers:[{level:2,title:"Client library developers",slug:"client-library-developers"},{level:2,title:"Applications and Software plugins",slug:"applications-and-software-plugins"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Client library development guidelines",frontmatter:{},regularPath:"/documentation/0.4/developers/clients/library-guidelines.html",relativePath:"documentation/0.4/developers/clients/library-guidelines.md",key:"v-5e5c94cd",path:"/documentation/0.4/developers/clients/library-guidelines.html",headers:[{level:2,title:"Conventions",slug:"conventions"},{level:3,title:"Casing",slug:"casing"},{level:3,title:"Scopes",slug:"scopes"},{level:3,title:"Scope categories",slug:"scope-categories"},{level:3,title:"Parameters",slug:"parameters"},{level:2,title:"Method mappings",slug:"method-mappings"},{level:3,title:"Scope: openEO (root category)",slug:"scope-openeo-root-category"},{level:4,title:"Parameters",slug:"parameters-2"},{level:3,title:"Scope: Connection (API category)",slug:"scope-connection-api-category"},{level:4,title:"Parameters",slug:"parameters-3"},{level:3,title:"Scope Capabilities (Content category)",slug:"scope-capabilities-content-category"},{level:4,title:"Parameters",slug:"parameters-4"},{level:3,title:"Scope: File (API category)",slug:"scope-file-api-category"},{level:4,title:"Parameters",slug:"parameters-5"},{level:3,title:"Scope: Job (API category)",slug:"scope-job-api-category"},{level:4,title:"Parameters",slug:"parameters-6"},{level:3,title:"Scope: ProcessGraph (API category)",slug:"scope-processgraph-api-category"},{level:3,title:"Scope: Service (API category)",slug:"scope-service-api-category"},{level:2,title:"Processes",slug:"processes"},{level:2,title:"Workflow example",slug:"workflow-example"},{level:3,title:"R (functional style)",slug:"r-functional-style"},{level:3,title:"Python (mixed style)",slug:"python-mixed-style"},{level:3,title:"Java (object oriented style)",slug:"java-object-oriented-style"},{level:3,title:"PHP (procedural style)",slug:"php-procedural-style"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Examples",frontmatter:{},regularPath:"/documentation/0.4/developers/examples/",relativePath:"documentation/0.4/developers/examples/README.md",key:"v-0059cb2a",path:"/documentation/0.4/developers/examples/",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Examples (proof of concept)",frontmatter:{},regularPath:"/documentation/0.4/developers/examples/poc.html",relativePath:"documentation/0.4/developers/examples/poc.md",key:"v-25dd3de6",path:"/documentation/0.4/developers/examples/poc.html",headers:[{level:2,title:"Use Case 1",slug:"use-case-1"},{level:2,title:"Use Case 2",slug:"use-case-2"},{level:2,title:"Use Case 3",slug:"use-case-3"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Getting started for users",frontmatter:{},regularPath:"/documentation/0.4/getting-started.html",relativePath:"documentation/0.4/getting-started.md",key:"v-6993aee6",path:"/documentation/0.4/getting-started.html",headers:[{level:2,title:"Contribute",slug:"contribute"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Glossary",frontmatter:{},regularPath:"/documentation/0.4/glossary.html",relativePath:"documentation/0.4/glossary.md",key:"v-3359623e",path:"/documentation/0.4/glossary.html",headers:[{level:2,title:"General terms",slug:"general-terms"},{level:2,title:"Processes and process graphs",slug:"processes-and-process-graphs"},{level:2,title:"EO data (Collections)",slug:"eo-data-collections"},{level:2,title:"Spatial data cubes",slug:"spatial-data-cubes"},{level:3,title:"apply: processes that do not change dimensions",slug:"apply-processes-that-do-not-change-dimensions"},{level:3,title:"filter: subsetting dimensions by dimension value selection",slug:"filter-subsetting-dimensions-by-dimension-value-selection"},{level:3,title:"reduce: removing dimensions entirely by computation",slug:"reduce-removing-dimensions-entirely-by-computation"},{level:3,title:"aggregate: reducing resolution",slug:"aggregate-reducing-resolution"},{level:3,title:"resample: changing data cube geometry",slug:"resample-changing-data-cube-geometry"},{level:2,title:"User-defined function (UDF)",slug:"user-defined-function-udf"},{level:2,title:"Data Processing modes",slug:"data-processing-modes"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"User-defined functions",frontmatter:{},regularPath:"/documentation/0.4/udfs.html",relativePath:"documentation/0.4/udfs.md",key:"v-6aca4be5",path:"/documentation/0.4/udfs.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{frontmatter:{fullpage:!0,stripCSS:!0},regularPath:"/documentation/0.4/processes.html",relativePath:"documentation/0.4/processes.md",key:"v-cfac61a6",path:"/documentation/0.4/processes.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Introduction",frontmatter:{},regularPath:"/documentation/1.0/",relativePath:"documentation/1.0/README.md",key:"v-37dbaaa0",path:"/documentation/1.0/",headers:[{level:2,title:"Contribute",slug:"contribute"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Authentication",frontmatter:{},regularPath:"/documentation/1.0/authentication.html",relativePath:"documentation/1.0/authentication.md",key:"v-7758ae27",path:"/documentation/1.0/authentication.html",headers:[{level:2,title:"HTTP Basic",slug:"http-basic"},{level:2,title:"OpenID Connect",slug:"openid-connect"},{level:3,title:"Authorization Code Flow",slug:"authorization-code-flow"},{level:3,title:"Device Flow",slug:"device-flow"},{level:3,title:"Client Credentials Flow",slug:"client-credentials-flow"},{level:3,title:"Resource Owner Password flow",slug:"resource-owner-password-flow"},{level:3,title:"Refresh Token Flow",slug:"refresh-token-flow"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO Cookbook",frontmatter:{sidebarDepth:3},regularPath:"/documentation/1.0/cookbook/",relativePath:"documentation/1.0/cookbook/README.md",key:"v-9f635184",path:"/documentation/1.0/cookbook/",headers:[{level:2,title:"Chapter 1",slug:"chapter-1"},{level:3,title:"Connecting to a back-end",slug:"connecting-to-a-back-end"},{level:3,title:"Input: load_collection",slug:"input-load-collection"},{level:3,title:"Filter Bands: filter_bands",slug:"filter-bands-filter-bands"},{level:3,title:"Temporal Mean: reduce_dimension",slug:"temporal-mean-reduce-dimension"},{level:3,title:"Scale All Pixels Linearly: apply, linear_scale_range",slug:"scale-all-pixels-linearly-apply-linear-scale-range"},{level:3,title:"Spatial Aggregation: aggregate_spatial",slug:"spatial-aggregation-aggregate-spatial"},{level:3,title:"Output: save_result",slug:"output-save-result"},{level:4,title:"Raster Formats: GTiff, NetCDF",slug:"raster-formats-gtiff-netcdf"},{level:4,title:"Raster Formats: PNG",slug:"raster-formats-png"},{level:4,title:"Text Formats: JSON, CSV",slug:"text-formats-json-csv"},{level:3,title:"Output: Process as JSON",slug:"output-process-as-json"},{level:2,title:"Chapter 2",slug:"chapter-2"},{level:3,title:"Bandmath",slug:"bandmath"},{level:4,title:"Example 1: NDVI",slug:"example-1-ndvi"},{level:4,title:"Example 2: EVI",slug:"example-2-evi"},{level:3,title:"Masks: mask",slug:"masks-mask"},{level:4,title:"Mask Out Specific Values",slug:"mask-out-specific-values"},{level:4,title:"Thresholds",slug:"thresholds"},{level:3,title:"Pixel Operations: apply",slug:"pixel-operations-apply"},{level:3,title:"Image Kernels: apply_kernel",slug:"image-kernels-apply-kernel"},{level:2,title:"Endnote",slug:"endnote"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Datacubes",frontmatter:{},regularPath:"/documentation/1.0/datacubes.html",relativePath:"documentation/1.0/datacubes.md",key:"v-5fd8f1ad",path:"/documentation/1.0/datacubes.html",headers:[{level:2,title:"What are Datacubes?",slug:"what-are-datacubes"},{level:2,title:"Dimensions",slug:"dimensions"},{level:3,title:"Applying Processes on Dimensions",slug:"applying-processes-on-dimensions"},{level:3,title:"Resolution",slug:"resolution"},{level:3,title:"Coordinate Reference System as a Dimension",slug:"coordinate-reference-system-as-a-dimension"},{level:2,title:"Values in a datacube",slug:"values-in-a-datacube"},{level:2,title:"Processes on Datacubes",slug:"processes-on-datacubes"},{level:3,title:"Filter",slug:"filter"},{level:3,title:"Apply",slug:"apply"},{level:3,title:"Resample",slug:"resample"},{level:3,title:"Reduce",slug:"reduce"},{level:3,title:"Aggregate",slug:"aggregate"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO error codes",frontmatter:{},regularPath:"/documentation/1.0/developers/api/errors.html",relativePath:"documentation/1.0/developers/api/errors.md",key:"v-8d587926",path:"/documentation/1.0/developers/api/errors.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Datacube Documentation",frontmatter:{},regularPath:"/documentation/1.0/datacubes/",relativePath:"documentation/1.0/datacubes/README.md",key:"v-f5de2fb4",path:"/documentation/1.0/datacubes/",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Introduction",frontmatter:{},regularPath:"/documentation/1.0/developers/",relativePath:"documentation/1.0/developers/README.md",key:"v-43de507e",path:"/documentation/1.0/developers/",headers:[{level:2,title:"Additional information",slug:"additional-information"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{frontmatter:{},regularPath:"/documentation/1.0/developers/api/",relativePath:"documentation/1.0/developers/api/README.md",key:"v-654015de",path:"/documentation/1.0/developers/api/",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{frontmatter:{fullpage:!0,stripCSS:!0},regularPath:"/documentation/1.0/developers/api/reference.html",relativePath:"documentation/1.0/developers/api/reference.md",key:"v-dc734f12",path:"/documentation/1.0/developers/api/reference.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Architecture",frontmatter:{},regularPath:"/documentation/1.0/developers/arch.html",relativePath:"documentation/1.0/developers/arch.md",key:"v-75018026",path:"/documentation/1.0/developers/arch.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Performance guide for openEO backends",frontmatter:{},regularPath:"/documentation/1.0/developers/backends/performance.html",relativePath:"documentation/1.0/developers/backends/performance.md",key:"v-253cefad",path:"/documentation/1.0/developers/backends/performance.html",headers:[{level:2,title:"openEO API vision on performance & scalability",slug:"openeo-api-vision-on-performance-scalability"},{level:3,title:"Bringing the processing to the data",slug:"bringing-the-processing-to-the-data"},{level:3,title:"Datacube processing",slug:"datacube-processing"},{level:2,title:"Process graph execution",slug:"process-graph-execution"},{level:2,title:"Performance FAQ",slug:"performance-faq"},{level:3,title:"I have a highly optimized workflow, can openEO expose it?",slug:"i-have-a-highly-optimized-workflow-can-openeo-expose-it"},{level:3,title:"Can openEO be as fast as a hand-written workflow?",slug:"can-openeo-be-as-fast-as-a-hand-written-workflow"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Getting started for service (back-end) providers",frontmatter:{},regularPath:"/documentation/1.0/developers/backends/getting-started.html",relativePath:"documentation/1.0/developers/backends/getting-started.md",key:"v-1772ad2d",path:"/documentation/1.0/developers/backends/getting-started.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Getting started with openEO and Xarray and Dask",frontmatter:{},regularPath:"/documentation/1.0/developers/backends/xarray.html",relativePath:"documentation/1.0/developers/backends/xarray.md",key:"v-2840d4fe",path:"/documentation/1.0/developers/backends/xarray.html",headers:[{level:2,title:"Process Graph Parser for Python",slug:"process-graph-parser-for-python"},{level:2,title:"Python Processes for openEO",slug:"python-processes-for-openeo"},{level:2,title:"The loadcollection and saveresult process",slug:"the-load-collection-and-save-result-process"},{level:3,title:"Connection to ODC and STAC",slug:"connection-to-odc-and-stac"},{level:2,title:"openEO Client Side Processing",slug:"openeo-client-side-processing"},{level:2,title:"Adding a new process",slug:"adding-a-new-process"},{level:3,title:"Add the process spec",slug:"add-the-process-spec"},{level:3,title:"Add the process implementation",slug:"add-the-process-implementation"},{level:2,title:"HTTP REST Interface",slug:"http-rest-interface"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Getting started for client developers",frontmatter:{},regularPath:"/documentation/1.0/developers/clients/getting-started.html",relativePath:"documentation/1.0/developers/clients/getting-started.md",key:"v-1b45967e",path:"/documentation/1.0/developers/clients/getting-started.html",headers:[{level:2,title:"Client library developers",slug:"client-library-developers"},{level:2,title:"Applications and Software plugins",slug:"applications-and-software-plugins"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Client library development guidelines",frontmatter:{},regularPath:"/documentation/1.0/developers/clients/library-guidelines.html",relativePath:"documentation/1.0/developers/clients/library-guidelines.md",key:"v-021062ed",path:"/documentation/1.0/developers/clients/library-guidelines.html",headers:[{level:2,title:"Conventions",slug:"conventions"},{level:3,title:"Casing",slug:"casing"},{level:3,title:"Scopes",slug:"scopes"},{level:3,title:"Scope categories",slug:"scope-categories"},{level:3,title:"Parameters",slug:"parameters"},{level:2,title:"Method mappings",slug:"method-mappings"},{level:3,title:"Scope: openEO (root category)",slug:"scope-openeo-root-category"},{level:4,title:"Parameters",slug:"parameters-2"},{level:3,title:"Scope: Connection (API category)",slug:"scope-connection-api-category"},{level:4,title:"Parameters",slug:"parameters-3"},{level:3,title:"Scope Capabilities (Content category)",slug:"scope-capabilities-content-category"},{level:4,title:"Parameters",slug:"parameters-4"},{level:3,title:"Scope: File (API category)",slug:"scope-file-api-category"},{level:4,title:"Parameters",slug:"parameters-5"},{level:3,title:"Scope: Job (API category)",slug:"scope-job-api-category"},{level:4,title:"Parameters",slug:"parameters-6"},{level:3,title:"Scope: UserProcess (API category)",slug:"scope-userprocess-api-category"},{level:3,title:"Scope: Service (API category)",slug:"scope-service-api-category"},{level:2,title:"Processes",slug:"processes"},{level:2,title:"Workflow example",slug:"workflow-example"},{level:3,title:"R (functional style)",slug:"r-functional-style"},{level:3,title:"Python (mixed style)",slug:"python-mixed-style"},{level:3,title:"Java (object oriented style)",slug:"java-object-oriented-style"},{level:3,title:"PHP (procedural style)",slug:"php-procedural-style"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO Profiles",frontmatter:{},regularPath:"/documentation/1.0/developers/profiles/",relativePath:"documentation/1.0/developers/profiles/README.md",key:"v-e35c5e24",path:"/documentation/1.0/developers/profiles/",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"API Profiles",frontmatter:{},regularPath:"/documentation/1.0/developers/profiles/api.html",relativePath:"documentation/1.0/developers/profiles/api.md",key:"v-97aa86e6",path:"/documentation/1.0/developers/profiles/api.html",headers:[{level:2,title:"Requirements per Profile",slug:"requirements-per-profile"},{level:3,title:"L1: Minimal",slug:"l1-minimal"},{level:4,title:"API fundamentals",slug:"api-fundamentals"},{level:4,title:"Well-known Discovery",slug:"well-known-discovery"},{level:4,title:"Capabilities",slug:"capabilities"},{level:4,title:"File Formats",slug:"file-formats"},{level:4,title:"Authentication",slug:"authentication"},{level:4,title:"Pre-defined Processes",slug:"pre-defined-processes"},{level:4,title:"Collections",slug:"collections"},{level:4,title:"Data Processing",slug:"data-processing"},{level:3,title:"L1A: Minimal - Synchronous Processing",slug:"l1a-minimal-synchronous-processing"},{level:4,title:"Synchronous Processing",slug:"synchronous-processing"},{level:3,title:"L1B: Minimal - Batch Jobs",slug:"l1b-minimal-batch-jobs"},{level:4,title:"Batch Jobs",slug:"batch-jobs"},{level:4,title:"Batch Jobs > Results",slug:"batch-jobs-results"},{level:3,title:"L1C: Minimal - Secondary Web Services",slug:"l1c-minimal-secondary-web-services"},{level:4,title:"Secondary Web Service Discovery",slug:"secondary-web-service-discovery"},{level:4,title:"Secondary Web Services",slug:"secondary-web-services"},{level:3,title:"L2: Recommended",slug:"l2-recommended"},{level:4,title:"API fundamentals",slug:"api-fundamentals-2"},{level:4,title:"Well-known Discovery",slug:"well-known-discovery-2"},{level:4,title:"Capabilities",slug:"capabilities-2"},{level:4,title:"File Formats",slug:"file-formats-2"},{level:4,title:"Authentication",slug:"authentication-2"},{level:4,title:"User Account",slug:"user-account"},{level:4,title:"Pre-defined Processes",slug:"pre-defined-processes-2"},{level:4,title:"Collections",slug:"collections-2"},{level:4,title:"User-defined processes",slug:"user-defined-processes"},{level:4,title:"Data Processing",slug:"data-processing-2"},{level:4,title:"Batch Jobs",slug:"batch-jobs-2"},{level:4,title:"Batch Jobs > Logs",slug:"batch-jobs-logs"},{level:4,title:"Batch Jobs > Results",slug:"batch-jobs-results-2"},{level:4,title:"Synchronous Processing",slug:"synchronous-processing-2"},{level:3,title:"L3: Advanced",slug:"l3-advanced"},{level:4,title:"API fundamentals",slug:"api-fundamentals-3"},{level:4,title:"Well-known Discovery",slug:"well-known-discovery-3"},{level:4,title:"Conformance Classes",slug:"conformance-classes"},{level:4,title:"Authentication",slug:"authentication-3"},{level:4,title:"Pre-defined Processes",slug:"pre-defined-processes-3"},{level:4,title:"Collections",slug:"collections-3"},{level:4,title:"User-defined processes",slug:"user-defined-processes-2"},{level:4,title:"Validation",slug:"validation"},{level:4,title:"Batch Jobs",slug:"batch-jobs-3"},{level:4,title:"Batch Jobs > Logs",slug:"batch-jobs-logs-2"},{level:4,title:"Batch Jobs > Estimates",slug:"batch-jobs-estimates"},{level:4,title:"Batch Jobs > Results",slug:"batch-jobs-results-3"},{level:4,title:"Synchronous Processing",slug:"synchronous-processing-3"},{level:3,title:"L3-UDF: UDF",slug:"l3-udf-udf"},{level:4,title:"UDF Runtimes",slug:"udf-runtimes"},{level:3,title:"L3-FS: File Storage",slug:"l3-fs-file-storage"},{level:4,title:"File Storage",slug:"file-storage"},{level:3,title:"L3-SWS: Secondary Web Services",slug:"l3-sws-secondary-web-services"},{level:4,title:"Secondary Web Service Discovery",slug:"secondary-web-service-discovery-2"},{level:4,title:"Secondary Web Services",slug:"secondary-web-services-2"},{level:3,title:"L4: Above and Beyond",slug:"l4-above-and-beyond"},{level:4,title:"Secondary Web Services",slug:"secondary-web-services-3"},{level:4,title:"Secondary Web Services > Logs",slug:"secondary-web-services-logs"},{level:4,title:"Batch Jobs",slug:"batch-jobs-4"},{level:4,title:"Batch Jobs > Estimates",slug:"batch-jobs-estimates-2"},{level:4,title:"Batch Jobs > Results",slug:"batch-jobs-results-4"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Process Profiles",frontmatter:{},regularPath:"/documentation/1.0/developers/profiles/processes.html",relativePath:"documentation/1.0/developers/profiles/processes.md",key:"v-04d2236d",path:"/documentation/1.0/developers/profiles/processes.html",headers:[{level:2,title:"Requirements per Profile",slug:"requirements-per-profile"},{level:3,title:"L1: Minimal",slug:"l1-minimal"},{level:3,title:"L2: Recommended",slug:"l2-recommended"},{level:3,title:"L2A: Recommended Raster",slug:"l2a-recommended-raster"},{level:3,title:"L2B: Recommended Vector",slug:"l2b-recommended-vector"},{level:3,title:"L2-Date: Date & Time manipulation",slug:"l2-date-date-time-manipulation"},{level:3,title:"L2-Text: Text manipulation",slug:"l2-text-text-manipulation"},{level:3,title:"L3: Advanced",slug:"l3-advanced"},{level:3,title:"L3-ML: Machine Learning",slug:"l3-ml-machine-learning"},{level:3,title:"L3-UDF: User-Defined Functions",slug:"l3-udf-user-defined-functions"},{level:3,title:"L3-Clim: Cimatology",slug:"l3-clim-cimatology"},{level:3,title:"L3-ARD: Analysis-Ready Data",slug:"l3-ard-analysis-ready-data"},{level:3,title:"L4: Above and Beyond",slug:"l4-above-and-beyond"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Glossary",frontmatter:{},regularPath:"/documentation/1.0/glossary.html",relativePath:"documentation/1.0/glossary.md",key:"v-4af2bfca",path:"/documentation/1.0/glossary.html",headers:[{level:2,title:"General terms",slug:"general-terms"},{level:2,title:"Processes",slug:"processes"},{level:2,title:"EO data (Collections)",slug:"eo-data-collections"},{level:2,title:"Spatial datacubes",slug:"spatial-datacubes"},{level:2,title:"Vector data",slug:"vector-data"},{level:2,title:"User-defined function (UDF)",slug:"user-defined-function-udf"},{level:2,title:"Data Processing modes",slug:"data-processing-modes"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"JavaScript Client",frontmatter:{},regularPath:"/documentation/1.0/javascript/",relativePath:"documentation/1.0/javascript/index.md",key:"v-1a823cb0",path:"/documentation/1.0/javascript/",headers:[{level:2,title:"Installation",slug:"installation"},{level:2,title:"Exploring a back-end",slug:"exploring-a-back-end"},{level:3,title:"Collections",slug:"collections"},{level:3,title:"Processes",slug:"processes"},{level:2,title:"Authentication",slug:"authentication"},{level:3,title:"Basic Authentication",slug:"basic-authentication"},{level:3,title:"OpenID Connect Authentication",slug:"openid-connect-authentication"},{level:2,title:"Creating a (user-defined) process",slug:"creating-a-user-defined-process"},{level:2,title:"Batch Job Management",slug:"batch-job-management"},{level:2,title:"Full Example",slug:"full-example"},{level:2,title:"User Defined Functions",slug:"user-defined-functions"},{level:2,title:"Additional Information",slug:"additional-information"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{frontmatter:{fullpage:!0,stripCSS:!0},regularPath:"/documentation/1.0/processes.html",relativePath:"documentation/1.0/processes.md",key:"v-00153acd",path:"/documentation/1.0/processes.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Get started with the openEO Python Client Client Side Processing",frontmatter:{},regularPath:"/documentation/1.0/python/client-side-processing.html",relativePath:"documentation/1.0/python/client-side-processing.md",key:"v-9a2a2626",path:"/documentation/1.0/python/client-side-processing.html",headers:[{level:2,title:"Background",slug:"background"},{level:2,title:"Installation",slug:"installation"},{level:2,title:"Usage",slug:"usage"},{level:3,title:"STAC Collections and Items",slug:"stac-collections-and-items"},{level:3,title:"Local Collections",slug:"local-collections"},{level:3,title:"Local Processing",slug:"local-processing"},{level:2,title:"Client-Side Processing Example Notebooks",slug:"client-side-processing-example-notebooks"},{level:2,title:"Additional Information",slug:"additional-information"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Python Client",frontmatter:{},regularPath:"/documentation/1.0/python/",relativePath:"documentation/1.0/python/index.md",key:"v-560d08d2",path:"/documentation/1.0/python/",headers:[{level:2,title:"Installation",slug:"installation"},{level:2,title:"Exploring a back-end",slug:"exploring-a-back-end"},{level:3,title:"Collections",slug:"collections"},{level:3,title:"Processes",slug:"processes"},{level:2,title:"Authentication",slug:"authentication"},{level:3,title:"Basic Authentication",slug:"basic-authentication"},{level:3,title:"OpenID Connect Authentication",slug:"openid-connect-authentication"},{level:2,title:"Working with Datacube",slug:"working-with-datacube"},{level:3,title:"Creating a Datacube",slug:"creating-a-datacube"},{level:3,title:"Applying processes",slug:"applying-processes"},{level:3,title:"Defining output format",slug:"defining-output-format"},{level:2,title:"Execution",slug:"execution"},{level:3,title:"Batch job execution",slug:"batch-job-execution"},{level:2,title:"Full Example",slug:"full-example"},{level:2,title:"User Defined Functions",slug:"user-defined-functions"},{level:2,title:"Additional Information",slug:"additional-information"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"R Client",frontmatter:{},regularPath:"/documentation/1.0/r/",relativePath:"documentation/1.0/r/index.md",key:"v-592eaa86",path:"/documentation/1.0/r/",headers:[{level:2,title:"Useful links",slug:"useful-links"},{level:2,title:"Installation",slug:"installation"},{level:2,title:"Exploring a back-end",slug:"exploring-a-back-end"},{level:3,title:"Collections",slug:"collections"},{level:3,title:"Processes",slug:"processes"},{level:2,title:"Authentication",slug:"authentication"},{level:3,title:"Basic Authentication",slug:"basic-authentication"},{level:3,title:"OpenID Connect Authentication",slug:"openid-connect-authentication"},{level:2,title:"Creating a (user-defined) process",slug:"creating-a-user-defined-process"},{level:2,title:"Batch Job Management",slug:"batch-job-management"},{level:2,title:"Full Example",slug:"full-example"},{level:2,title:"User Defined Functions",slug:"user-defined-functions"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"QGIS Plugin",frontmatter:{},regularPath:"/documentation/1.0/qgis/",relativePath:"documentation/1.0/qgis/index.md",key:"v-ef2073ec",path:"/documentation/1.0/qgis/",headers:[{level:2,title:"Installation",slug:"installation"},{level:2,title:"Connecting",slug:"connecting"},{level:2,title:"Exploring a backend",slug:"exploring-a-backend"},{level:2,title:"Job Management",slug:"job-management"},{level:3,title:"Creating new Jobs",slug:"creating-new-jobs"},{level:3,title:"Adapting existing Jobs",slug:"adapting-existing-jobs"},{level:4,title:"Process Argument Helper",slug:"process-argument-helper"},{level:2,title:"Service Management",slug:"service-management"},{level:2,title:"Additional Information",slug:"additional-information"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"User-defined functions",frontmatter:{},regularPath:"/documentation/1.0/udfs.html",relativePath:"documentation/1.0/udfs.md",key:"v-ffc79ec2",path:"/documentation/1.0/udfs.html",headers:[{level:2,title:"Users",slug:"users"},{level:3,title:"JavaScript",slug:"javascript"},{level:3,title:"Python",slug:"python"},{level:3,title:"QGIS",slug:"qgis"},{level:3,title:"R",slug:"r"},{level:3,title:"Web Editor",slug:"web-editor"},{level:2,title:"Back-ends",slug:"back-ends"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Contributor Code of Conduct",frontmatter:{},regularPath:"/documentation/code-of-conduct.html",relativePath:"documentation/code-of-conduct.md",key:"v-c71b5aa6",path:"/documentation/code-of-conduct.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Software Development Guidelines",frontmatter:{},regularPath:"/documentation/software-guidelines.html",relativePath:"documentation/software-guidelines.md",key:"v-1005bb66",path:"/documentation/software-guidelines.html",headers:[{level:2,title:"Software quality guidelines",slug:"software-quality-guidelines"},{level:2,title:"Software documentation guidelines",slug:"software-documentation-guidelines"},{level:2,title:"Software review",slug:"software-review"},{level:2,title:"Test-driven development",slug:"test-driven-development"},{level:2,title:"Continuous integration",slug:"continuous-integration"},{level:2,title:"Additional guidelines",slug:"additional-guidelines"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"IEEE IGARRS 2021 HD-3: Hands-on openEO: access cloud platforms using your preferred programming language",frontmatter:{},regularPath:"/events/igarrs2021.html",relativePath:"events/igarrs2021.md",key:"v-186cd6ed",path:"/events/igarrs2021.html",headers:[{level:2,title:"Agenda",slug:"agenda"},{level:2,title:"Python client",slug:"python-client"},{level:3,title:"Logging in",slug:"logging-in"},{level:3,title:"openEO in Python intro",slug:"openeo-in-python-intro"},{level:2,title:"R client",slug:"r-client"},{level:2,title:"openEO user interfaces",slug:"openeo-user-interfaces"},{level:2,title:"Use cases",slug:"use-cases"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Welcome to openEO!",frontmatter:{news:!0,title:"Welcome to openEO!",date:"2017-12-05T00:00:00.000Z",author:"Edzer Pebesma"},regularPath:"/news/2017-12-05-welcome.html",relativePath:"news/2017-12-05-welcome.md",key:"v-0ee3f026",path:"/news/2017-12-05-welcome.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"First week of intensive collaboration: Dec 4-6, 2017",frontmatter:{news:!0,title:"First week of intensive collaboration: Dec 4-6, 2017",date:"2017-12-18T00:00:00.000Z",author:"Edzer Pebesma"},regularPath:"/news/2017-12-18-VITO_meeting.html",relativePath:"news/2017-12-18-VITO_meeting.md",key:"v-2997b752",path:"/news/2017-12-18-VITO_meeting.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Second week of intensive collaboration: Jan 22-24, 2018",frontmatter:{news:!0,title:"Second week of intensive collaboration: Jan 22-24, 2018",date:"2018-01-31T00:00:00.000Z",author:"Marius Appel"},regularPath:"/news/2018-01-31-WWU_meeting.html",relativePath:"news/2018-01-31-WWU_meeting.md",key:"v-24966ce6",path:"/news/2018-01-31-WWU_meeting.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO proves its concept",frontmatter:{news:!0,title:"openEO proves its concept",date:"2018-03-17T00:00:00.000Z",author:"Edzer Pebesma, the openEO consortium"},regularPath:"/news/2018-03-15-poc.html",relativePath:"news/2018-03-15-poc.md",key:"v-4fe4e126",path:"/news/2018-03-15-poc.html",headers:[{level:2,title:"The problem",slug:"the-problem"},{level:2,title:"Why an API?",slug:"why-an-api"},{level:2,title:"First results",slug:"first-results"},{level:2,title:"The three use cases",slug:"the-three-use-cases"},{level:2,title:"Links to the client and back-end implementations",slug:"links-to-the-client-and-back-end-implementations"},{level:2,title:"Proof-of-concept videos",slug:"proof-of-concept-videos"},{level:3,title:"R client and WCPS back-end, use case 1",slug:"r-client-and-wcps-back-end-use-case-1"},{level:3,title:"Grass GIS back-end, use cases 1, 2 and 3",slug:"grass-gis-back-end-use-cases-1-2-and-3"},{level:3,title:"R client and R back-end, use-case 1",slug:"r-client-and-r-back-end-use-case-1"},{level:3,title:"R client and R back-end, use case 3",slug:"r-client-and-r-back-end-use-case-3"},{level:3,title:"openEO Web Editor (JS client) with three back-ends (use case 1)",slug:"openeo-web-editor-js-client-with-three-back-ends-use-case-1"},{level:3,title:"openEO Web Editor (JS client) with R back-end (use case 3)",slug:"openeo-web-editor-js-client-with-r-back-end-use-case-3"},{level:3,title:"Python client with GeoPySpark back-end (use case 1)",slug:"python-client-with-geopyspark-back-end-use-case-1"},{level:3,title:"openEO Web Editor (JS client) with Google Earth Engine back-end (use case 1)",slug:"openeo-web-editor-js-client-with-google-earth-engine-back-end-use-case-1"},{level:2,title:"Links to documents",slug:"links-to-documents"},{level:2,title:"Next steps",slug:"next-steps"},{level:2,title:"Getting involved",slug:"getting-involved"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"User Requirements Survey for openEO launched",frontmatter:{news:!0,title:"User Requirements Survey for openEO launched",date:"2018-05-23T00:00:00.000Z",author:"Sarah Carter"},regularPath:"/news/2018-05-23-user-requirements-survey-launched.html",relativePath:"news/2018-05-23-user-requirements-survey-launched.md",key:"v-f9778ae6",path:"/news/2018-05-23-user-requirements-survey-launched.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO year one review meeting",frontmatter:{news:!0,title:"openEO year one review meeting",date:"2018-10-30T00:00:00.000Z",author:"Matthias Schramm"},regularPath:"/news/2018-10-30-year-one-review-meeting.html",relativePath:"news/2018-10-30-year-one-review-meeting.md",key:"v-d2a018a6",path:"/news/2018-10-30-year-one-review-meeting.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"H2020 EO Big Data Hackathon Nov 7-8",frontmatter:{news:!0,title:"H2020 EO Big Data Hackathon Nov 7-8",date:"2019-10-07T00:00:00.000Z",author:"Edzer Pebesma"},regularPath:"/news/2019-10-07-EO-big-data-hackaton.html",relativePath:"news/2019-10-07-EO-big-data-hackaton.md",key:"v-9ddae032",path:"/news/2019-10-07-EO-big-data-hackaton.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO API v0.4.0 released",frontmatter:{news:!0,title:"openEO API v0.4.0 released",date:"2019-03-07T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2019-03-07-openeo-api-040.html",relativePath:"news/2019-03-07-openeo-api-040.md",key:"v-45d803ab",path:"/news/2019-03-07-openeo-api-040.html",headers:[{level:2,title:"New process catalogue and process graph changes",slug:"new-process-catalogue-and-process-graph-changes"},{level:2,title:"Other improvements",slug:"other-improvements"},{level:2,title:"Next steps",slug:"next-steps"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Lessons learned while developing the openEO API",frontmatter:{news:!0,title:"Lessons learned while developing the openEO API",date:"2020-07-31T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2020-07-31-lessons-learned.html",relativePath:"news/2020-07-31-lessons-learned.md",key:"v-3f85032d",path:"/news/2020-07-31-lessons-learned.html",headers:[{level:2,title:"1. Collection Names",slug:"_1-collection-names"},{level:2,title:"2. Other Names",slug:"_2-other-names"},{level:2,title:"3. Chunked Collections",slug:"_3-chunked-collections"},{level:2,title:"4. What to specify?",slug:"_4-what-to-specify"},{level:3,title:"File Formats",slug:"file-formats"},{level:2,title:"5. Authentication",slug:"_5-authentication"},{level:2,title:"6. Debugging Experience",slug:"_6-debugging-experience"},{level:2,title:"7. Defining interoperable Processes",slug:"_7-defining-interoperable-processes"},{level:2,title:"Conclusion",slug:"conclusion"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Stable release of the openEO API and Processes (v1.0.0)",frontmatter:{news:!0,title:"Stable release of the openEO API and Processes (v1.0.0)",date:"2020-07-31T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2020-07-31-openeo-api-released.html",relativePath:"news/2020-07-31-openeo-api-released.md",key:"v-2fcee9ad",path:"/news/2020-07-31-openeo-api-released.html",headers:[{level:2,title:"Processes",slug:"processes"},{level:2,title:"STAC and OGC APIs",slug:"stac-and-ogc-apis"},{level:2,title:"User-defined Functions (UDFs)",slug:"user-defined-functions-udfs"},{level:2,title:"Other improvements",slug:"other-improvements"},{level:2,title:"Limitations",slug:"limitations"},{level:2,title:"Next steps",slug:"next-steps"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO API v1.0.1 released",frontmatter:{news:!0,title:"openEO API v1.0.1 released",date:"2020-11-30T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2020-11-30-openeo-api-101-released.html",relativePath:"news/2020-11-30-openeo-api-101-released.md",key:"v-0e5e57cd",path:"/news/2020-11-30-openeo-api-101-released.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO Virtual User Workshop",frontmatter:{news:!0,title:"openEO Virtual User Workshop",date:"2020-09-02T00:00:00.000Z",author:"Matthias Schramm"},regularPath:"/news/2020-09-02-openeo-user-workshop.html",relativePath:"news/2020-09-02-openeo-user-workshop.md",key:"v-525dec3e",path:"/news/2020-09-02-openeo-user-workshop.html",headers:[{level:3,title:"UPDATE:",slug:"update"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO API v1.1.0 released",frontmatter:{news:!0,title:"openEO API v1.1.0 released",date:"2021-05-17T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2021-05-17-openeo-api-110-released.html",relativePath:"news/2021-05-17-openeo-api-110-released.md",key:"v-6e6b7e2d",path:"/news/2021-05-17-openeo-api-110-released.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"R Client on CRAN",frontmatter:{news:!0,title:"R Client on CRAN",date:"2021-11-08T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2021-11-08-r-client-on-cran.html",relativePath:"news/2021-11-08-r-client-on-cran.md",key:"v-06e0a8ca",path:"/news/2021-11-08-r-client-on-cran.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO PSC meetings",frontmatter:{news:!0,title:"openEO PSC meetings",date:"2022-04-08T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2022-04-08-psc-meetings.html",relativePath:"news/2022-04-08-psc-meetings.md",key:"v-1227575e",path:"/news/2022-04-08-psc-meetings.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"R Client v1.2.0 has been released",frontmatter:{news:!0,title:"R Client v1.2.0 has been released",date:"2022-05-12T00:00:00.000Z",author:"Matthias Mohr, Florian Lahn"},regularPath:"/news/2022-05-12-r-client-v120.html",relativePath:"news/2022-05-12-r-client-v120.md",key:"v-59d340ad",path:"/news/2022-05-12-r-client-v120.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"R Client v1.3.0 has been released",frontmatter:{news:!0,title:"R Client v1.3.0 has been released",date:"2022-11-17T00:00:00.000Z",author:"Matthias Mohr, Peter J. Zellner, Florian Lahn"},regularPath:"/news/2022-11-17-r-client-v130.html",relativePath:"news/2022-11-17-r-client-v130.md",key:"v-221bfb8d",path:"/news/2022-11-17-r-client-v130.html",headers:[{level:2,title:"Better support for sf",slug:"better-support-for-sf"},{level:2,title:"New Vignettes",slug:"new-vignettes"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Monthly openEO community meeting",frontmatter:{news:!0,title:"Monthly openEO community meeting",date:"2022-07-07T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2022-07-07-monthly-dev-calls.html",relativePath:"news/2022-07-07-monthly-dev-calls.md",key:"v-00d62ee6",path:"/news/2022-07-07-monthly-dev-calls.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO submitted to OGC for consideration as an OGC community standard",frontmatter:{news:!0,title:"openEO submitted to OGC for consideration as an OGC community standard",date:"2023-12-06T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2023-12-06-openeo-submitted-to-ogc.html",relativePath:"news/2023-12-06-openeo-submitted-to-ogc.md",key:"v-857a96a6",path:"/news/2023-12-06-openeo-submitted-to-ogc.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"OGC seeks public comment on the adoption of openEO as a Community Standard",frontmatter:{news:!0,title:"OGC seeks public comment on the adoption of openEO as a Community Standard",date:"2024-02-06T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2024-02-06-openeo-ogc-rfc.html",relativePath:"news/2024-02-06-openeo-ogc-rfc.md",key:"v-10d9ffb7",path:"/news/2024-02-06-openeo-ogc-rfc.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"New releases for openEO API and openEO Processes, focus on vector data",frontmatter:{news:!0,title:"New releases for openEO API and openEO Processes, focus on vector data",date:"2023-05-25T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2023-05-25-new-openeo-versions-120-200rc1%20copy.html",relativePath:"news/2023-05-25-new-openeo-versions-120-200rc1 copy.md",key:"v-3eeef04a",path:"/news/2023-05-25-new-openeo-versions-120-200rc1%20copy.html",headers:[{level:2,title:"openEO API v1.2.0",slug:"openeo-api-v1-2-0"},{level:2,title:"openEO Processes v2.0.0-rc.1",slug:"openeo-processes-v2-0-0-rc-1"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"MOOC Cubes and Clouds - open for registration",frontmatter:{news:!0,title:"MOOC Cubes and Clouds - open for registration",date:"2024-03-22T00:00:00.000Z",author:"Peter Zellner"},regularPath:"/news/2024-03-22_mooc_cubeandclouds.html",relativePath:"news/2024-03-22_mooc_cubeandclouds.md",key:"v-d5007282",path:"/news/2024-03-22_mooc_cubeandclouds.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"News",frontmatter:{sidebar:!1},regularPath:"/news/",relativePath:"news/README.md",key:"v-8850e2c4",path:"/news/",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO Project Steering Committee",frontmatter:{},regularPath:"/psc.html",relativePath:"psc.md",key:"v-64c18f4d",path:"/psc.html",headers:[{level:2,title:"Members",slug:"members"},{level:2,title:"Detailed Process",slug:"detailed-process"},{level:3,title:"When is Vote Required?",slug:"when-is-vote-required"},{level:3,title:"Final remarks",slug:"final-remarks"},{level:2,title:"Committee Membership",slug:"committee-membership"},{level:3,title:"Adding Members",slug:"adding-members"},{level:3,title:"Stepping Down",slug:"stepping-down"},{level:2,title:"History",slug:"history"}],codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Software",frontmatter:{},regularPath:"/software.html",relativePath:"software.md",key:"v-9adb302a",path:"/software.html",headers:[{level:2,title:"Clients",slug:"clients"},{level:2,title:"Back-ends",slug:"back-ends"},{level:2,title:"Specification",slug:"specification"},{level:2,title:"Ecosystem",slug:"ecosystem"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}}],themeConfig:{apiVersion:"1.2.0",versions:[{folder:"1.0",path:"/documentation/1.0/",title:"1.x",apiTag:"1.2.0",processesTag:"2.0.0-rc.1",apiVersions:["1.0.0","1.0.1","1.1.0","1.2.0"],userNav:[{text:"Introduction",link:"index.html"},{text:"Glossary",link:"glossary.html"},{text:"Datacubes",link:"datacubes.html"},{text:"Getting Started",items:[{text:"JavaScript",link:"javascript/index.html"},{text:"Python",link:"python/index.html"},{text:"QGIS",link:"qgis/index.html"},{text:"R",link:"r/index.html"},{text:"Client-Side Processing (Python)",link:"python/client-side-processing.html"}]},{text:"Processes",link:"processes.html"},{text:"Cookbook",link:"cookbook/index.html"},{text:"Authentication",link:"authentication.html"},{text:"UDFs",link:"udfs.html"}],devNav:[{text:"Introduction",link:"developers/index.html"},{text:"Glossary",link:"glossary.html"},{text:"Architecture",link:"developers/arch.html"},{text:"Service Providers",items:[{text:"Getting Started",link:"developers/backends/getting-started.html"},{text:"Performance Guide",link:"developers/backends/performance.html"},{text:"Xarray / Dask Guide",link:"developers/backends/xarray.html"},{text:"Profiles",link:"developers/profiles/index.html"}]},{text:"Client Developers",items:[{text:"Getting Started",link:"developers/clients/getting-started.html"},{text:"Library Guidelines",link:"developers/clients/library-guidelines.html"}]},{text:"API",items:[{text:"Reference",link:"developers/api/reference.html"},{text:"Profiles",link:"developers/profiles/api.html"}]},{text:"Processes",items:[{text:"Reference",link:"processes.html"},{text:"Profiles",link:"developers/profiles/processes.html"}]},{text:"Error Codes",link:"developers/api/errors.html"},{text:"Authentication",link:"authentication.html"},{text:"UDFs",link:"udfs.html"}]},{folder:"0.4",path:"/documentation/0.4/",title:"0.4",apiTag:"0.4.2",apiFormat:"json",processesTag:"0.4.2",apiVersions:["0.4.0","0.4.1","0.4.2"],userNav:[{text:"Getting Started",link:"getting-started.html"},{text:"Glossary",link:"glossary.html"},{text:"Processes",link:"processes.html"},{text:"UDFs",link:"udfs.html"}],devNav:[{text:"Introduction",link:"developers/index.html"},{text:"Glossary",link:"glossary.html"},{text:"Architecture",link:"developers/arch.html"},{text:"Service Providers",items:[{text:"Getting Started",link:"developers/backends/getting-started.html"},{text:"UDFs",link:"developers/backends/udfs.html"}]},{text:"Client Developers",items:[{text:"Getting Started",link:"developers/clients/getting-started.html"},{text:"Library Guidelines",link:"developers/clients/library-guidelines.html"}]},{text:"API",items:[{text:"Specification",link:"developers/api/reference.html"},{text:"Further documentation",link:"developers/api/index.html"}]},{text:"Processes",link:"processes.html"},{text:"Error Codes",link:"developers/api/errors.html"},{text:"Examples",link:"developers/examples/"}]}],defaultVersion:0,docPath:"/documentation/1.0/",logo:"/images/openeo_navbar_logo.png",editLinks:!0,docsRepo:"Open-EO/openeo.org",algolia:{appId:"3J2STFK847",apiKey:"b12d6cb143c2ddadfa8989c962d1a049",indexName:"openeo"},nav:[{text:"Home",link:"/"},{text:"About",link:"/about.html"},{text:"News",link:"/news/"},{text:"Software",link:"/software.html"},{text:"Services / Hub",link:"https://hub.openeo.org"},{text:"User Documentation",userNav:!0,items:[]},{text:"Developers",devNav:!0,items:[]},{text:"PSC",link:"/psc.html"},{text:"Contact",link:"/contact.html"}],sidebar:"auto"}},Lt=n(148),It=Lt.themeConfig.versions[Lt.themeConfig.defaultVersion];"undefined"!=typeof window&&(window.global=window);n(149);r.a.component("ApiSpec",()=>n.e(39).then(n.bind(null,479))),r.a.component("Channels",()=>Promise.all([n.e(0),n.e(27)]).then(n.bind(null,480))),r.a.component("ErrorCodes",()=>n.e(19).then(n.bind(null,481))),r.a.component("News",()=>n.e(40).then(n.bind(null,482))),r.a.component("InlineFrame",()=>Promise.all([n.e(0),n.e(28)]).then(n.bind(null,483))),r.a.component("ProcessesSpec",()=>Promise.all([n.e(0),n.e(26)]).then(n.bind(null,484))),r.a.component("Badge",()=>Promise.all([n.e(0),n.e(4)]).then(n.bind(null,490)));n(150),n(151);r.a.component("CodeSwitcher",()=>n.e(53).then(n.bind(null,485)));var Dt=[({router:e,Vue:t})=>{t.config.ignoredElements=["redoc"],e.addRoutes([{path:"/documentation",redirect:It.path},{path:"/about",redirect:"about.html"},{path:"/software",redirect:"software.html"},{path:"/contact",redirect:"contact.html"},{path:"/glossary",redirect:It.path+"glossary.html"},{path:"/documentation/1.0/developers/backends/opendatacube.html",redirect:"/documentation/1.0/developers/backends/xarray.html"}])},{},({Vue:e})=>{e.mixin({computed:{$dataBlock(){return this.$options.__data__block__}}})},{},{},{},{},{},({Vue:e})=>{e.component("CodeCopy",$t)}],Nt=[];class Ft extends class{constructor(){this.store=new r.a({data:{state:{}}})}$get(e){return this.store.state[e]}$set(e,t){r.a.set(this.store.state,e,t)}$emit(...e){this.store.$emit(...e)}$on(...e){this.store.$on(...e)}}{}Object.assign(Ft.prototype,{getPageAsyncComponent:lt,getLayoutAsyncComponent:ct,getAsyncComponent:ut,getVueComponent:pt});var Jt={install(e){const t=new Ft;e.$vuepress=t,e.prototype.$vuepress=t}};function Bt(e,t){const n=t.toLowerCase();return e.options.routes.some(e=>e.path.toLowerCase()===n)}var Vt={props:{pageKey:String,slotKey:{type:String,default:"default"}},render(e){const t=this.pageKey||this.$parent.$page.key;return ft("pageKey",t),r.a.component(t)||r.a.component(t,lt(t)),r.a.component(t)?e(t):e("")}},zt={functional:!0,props:{slotKey:String,required:!0},render:(e,{props:t,slots:n})=>e("div",{class:["content__"+t.slotKey]},n()[t.slotKey])},qt={computed:{openInNewWindowTitle(){return this.$themeLocaleConfig.openNewWindowText||"(opens new window)"}}},Gt=(n(152),n(153),Object(jt.a)(qt,(function(){var e=this._self._c;return e("span",[e("svg",{staticClass:"icon outbound",attrs:{xmlns:"http://www.w3.org/2000/svg","aria-hidden":"true",focusable:"false",x:"0px",y:"0px",viewBox:"0 0 100 100",width:"15",height:"15"}},[e("path",{attrs:{fill:"currentColor",d:"M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"}}),this._v(" "),e("polygon",{attrs:{fill:"currentColor",points:"45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"}})]),this._v(" "),e("span",{staticClass:"sr-only"},[this._v(this._s(this.openInNewWindowTitle))])])}),[],!1,null,null,null).exports),Wt={functional:!0,render(e,{parent:t,children:n}){if(t._isMounted)return n;t.$once("hook:mounted",()=>{t.$forceUpdate()})}};r.a.config.productionTip=!1,r.a.use(Ge),r.a.use(Jt),r.a.mixin(function(e,t,n=r.a){!function(e){e.locales&&Object.keys(e.locales).forEach(t=>{e.locales[t].path=t});Object.freeze(e)}(t),n.$vuepress.$set("siteData",t);const o=new(e(n.$vuepress.$get("siteData"))),a=Object.getOwnPropertyDescriptors(Object.getPrototypeOf(o)),i={};return Object.keys(a).reduce((e,t)=>(t.startsWith("$")&&(e[t]=a[t].get),e),i),{computed:i}}(e=>class{setPage(e){this.__page=e}get $site(){return e}get $themeConfig(){return this.$site.themeConfig}get $frontmatter(){return this.$page.frontmatter}get $localeConfig(){const{locales:e={}}=this.$site;let t,n;for(const r in e)"/"===r?n=e[r]:0===this.$page.path.indexOf(r)&&(t=e[r]);return t||n||{}}get $siteTitle(){return this.$localeConfig.title||this.$site.title||""}get $canonicalUrl(){const{canonicalUrl:e}=this.$page.frontmatter;return"string"==typeof e&&e}get $title(){const e=this.$page,{metaTitle:t}=this.$page.frontmatter;if("string"==typeof t)return t;const n=this.$siteTitle,r=e.frontmatter.home?null:e.frontmatter.title||e.title;return n?r?r+" | "+n:n:r||"VuePress"}get $description(){const e=function(e){if(e){const t=e.filter(e=>"description"===e.name)[0];if(t)return t.content}}(this.$page.frontmatter.meta);return e||(this.$page.frontmatter.description||this.$localeConfig.description||this.$site.description||"")}get $lang(){return this.$page.frontmatter.lang||this.$localeConfig.lang||"en-US"}get $localePath(){return this.$localeConfig.path||"/"}get $themeLocaleConfig(){return(this.$site.themeConfig.locales||{})[this.$localePath]||{}}get $page(){return this.__page?this.__page:function(e,t){for(let n=0;nn||(e.hash?!r.a.$vuepress.$get("disableScrollBehavior")&&{selector:decodeURIComponent(e.hash)}:{x:0,y:0})});!function(e){e.beforeEach((t,n,r)=>{if(Bt(e,t.path))r();else if(/(\/|\.html)$/.test(t.path))if(/\/$/.test(t.path)){const n=t.path.replace(/\/$/,"")+".html";Bt(e,n)?r(n):r()}else r();else{const n=t.path+"/",o=t.path+".html";Bt(e,o)?r(o):Bt(e,n)?r(n):r()}})}(n);const o={};try{await Promise.all(Dt.filter(e=>"function"==typeof e).map(t=>t({Vue:r.a,options:o,router:n,siteData:Mt,isServer:e})))}catch(e){console.error(e)}return{app:new r.a(Object.assign(o,{router:n,render:e=>e("div",{attrs:{id:"app"}},[e("RouterView",{ref:"layout"}),e("div",{class:"global-ui"},Nt.map(t=>e(t)))])})),router:n}}(!1).then(({app:e,router:t})=>{t.onReady(()=>{e.$mount("#app")})})}]); \ No newline at end of file + */function o(e,t){for(var n in t)e[n]=t[n];return e}var a=/[!'()*]/g,i=function(e){return"%"+e.charCodeAt(0).toString(16)},s=/%2C/g,l=function(e){return encodeURIComponent(e).replace(a,i).replace(s,",")};function c(e){try{return decodeURIComponent(e)}catch(e){0}return e}var u=function(e){return null==e||"object"==typeof e?e:String(e)};function p(e){var t={};return(e=e.trim().replace(/^(\?|#|&)/,""))?(e.split("&").forEach((function(e){var n=e.replace(/\+/g," ").split("="),r=c(n.shift()),o=n.length>0?c(n.join("=")):null;void 0===t[r]?t[r]=o:Array.isArray(t[r])?t[r].push(o):t[r]=[t[r],o]})),t):t}function d(e){var t=e?Object.keys(e).map((function(t){var n=e[t];if(void 0===n)return"";if(null===n)return l(t);if(Array.isArray(n)){var r=[];return n.forEach((function(e){void 0!==e&&(null===e?r.push(l(t)):r.push(l(t)+"="+l(e)))})),r.join("&")}return l(t)+"="+l(n)})).filter((function(e){return e.length>0})).join("&"):null;return t?"?"+t:""}var f=/\/?$/;function h(e,t,n,r){var o=r&&r.options.stringifyQuery,a=t.query||{};try{a=v(a)}catch(e){}var i={name:t.name||e&&e.name,meta:e&&e.meta||{},path:t.path||"/",hash:t.hash||"",query:a,params:t.params||{},fullPath:y(t,o),matched:e?g(e):[]};return n&&(i.redirectedFrom=y(n,o)),Object.freeze(i)}function v(e){if(Array.isArray(e))return e.map(v);if(e&&"object"==typeof e){var t={};for(var n in e)t[n]=v(e[n]);return t}return e}var m=h(null,{path:"/"});function g(e){for(var t=[];e;)t.unshift(e),e=e.parent;return t}function y(e,t){var n=e.path,r=e.query;void 0===r&&(r={});var o=e.hash;return void 0===o&&(o=""),(n||"/")+(t||d)(r)+o}function b(e,t,n){return t===m?e===t:!!t&&(e.path&&t.path?e.path.replace(f,"")===t.path.replace(f,"")&&(n||e.hash===t.hash&&w(e.query,t.query)):!(!e.name||!t.name)&&(e.name===t.name&&(n||e.hash===t.hash&&w(e.query,t.query)&&w(e.params,t.params))))}function w(e,t){if(void 0===e&&(e={}),void 0===t&&(t={}),!e||!t)return e===t;var n=Object.keys(e).sort(),r=Object.keys(t).sort();return n.length===r.length&&n.every((function(n,o){var a=e[n];if(r[o]!==n)return!1;var i=t[n];return null==a||null==i?a===i:"object"==typeof a&&"object"==typeof i?w(a,i):String(a)===String(i)}))}function _(e){for(var t=0;t=0&&(t=e.slice(r),e=e.slice(0,r));var o=e.indexOf("?");return o>=0&&(n=e.slice(o+1),e=e.slice(0,o)),{path:e,query:n,hash:t}}(a.path||""),d=t&&t.path||"/",f=c.path?k(c.path,d,n||a.append):d,h=function(e,t,n){void 0===t&&(t={});var r,o=n||p;try{r=o(e||"")}catch(e){r={}}for(var a in t){var i=t[a];r[a]=Array.isArray(i)?i.map(u):u(i)}return r}(c.query,a.query,r&&r.options.parseQuery),v=a.hash||c.hash;return v&&"#"!==v.charAt(0)&&(v="#"+v),{_normalized:!0,path:f,query:h,hash:v}}var q,G=function(){},W={name:"RouterLink",props:{to:{type:[String,Object],required:!0},tag:{type:String,default:"a"},custom:Boolean,exact:Boolean,exactPath:Boolean,append:Boolean,replace:Boolean,activeClass:String,exactActiveClass:String,ariaCurrentValue:{type:String,default:"page"},event:{type:[String,Array],default:"click"}},render:function(e){var t=this,n=this.$router,r=this.$route,a=n.resolve(this.to,r,this.append),i=a.location,s=a.route,l=a.href,c={},u=n.options.linkActiveClass,p=n.options.linkExactActiveClass,d=null==u?"router-link-active":u,v=null==p?"router-link-exact-active":p,m=null==this.activeClass?d:this.activeClass,g=null==this.exactActiveClass?v:this.exactActiveClass,y=s.redirectedFrom?h(null,z(s.redirectedFrom),null,n):s;c[g]=b(r,y,this.exactPath),c[m]=this.exact||this.exactPath?c[g]:function(e,t){return 0===e.path.replace(f,"/").indexOf(t.path.replace(f,"/"))&&(!t.hash||e.hash===t.hash)&&function(e,t){for(var n in t)if(!(n in e))return!1;return!0}(e.query,t.query)}(r,y);var w=c[g]?this.ariaCurrentValue:null,_=function(e){H(e)&&(t.replace?n.replace(i,G):n.push(i,G))},x={click:H};Array.isArray(this.event)?this.event.forEach((function(e){x[e]=_})):x[this.event]=_;var P={class:c},k=!this.$scopedSlots.$hasNormal&&this.$scopedSlots.default&&this.$scopedSlots.default({href:l,route:s,navigate:_,isActive:c[m],isExactActive:c[g]});if(k){if(1===k.length)return k[0];if(k.length>1||!k.length)return 0===k.length?e():e("span",{},k)}if("a"===this.tag)P.on=x,P.attrs={href:l,"aria-current":w};else{var S=function e(t){var n;if(t)for(var r=0;r-1&&(s.params[d]=n.params[d]);return s.path=V(u.path,s.params),l(u,s,i)}if(s.path){s.params={};for(var f=0;f-1}function Se(e,t){return ke(e)&&e._isRouter&&(null==t||e.type===t)}function Oe(e,t,n){var r=function(o){o>=e.length?n():e[o]?t(e[o],(function(){r(o+1)})):r(o+1)};r(0)}function Ce(e){return function(t,n,r){var o=!1,a=0,i=null;Ee(e,(function(e,t,n,s){if("function"==typeof e&&void 0===e.cid){o=!0,a++;var l,c=Te((function(t){var o;((o=t).__esModule||$e&&"Module"===o[Symbol.toStringTag])&&(t=t.default),e.resolved="function"==typeof t?t:q.extend(t),n.components[s]=t,--a<=0&&r()})),u=Te((function(e){var t="Failed to resolve async component "+s+": "+e;i||(i=ke(e)?e:new Error(t),r(i))}));try{l=e(c,u)}catch(e){u(e)}if(l)if("function"==typeof l.then)l.then(c,u);else{var p=l.component;p&&"function"==typeof p.then&&p.then(c,u)}}})),o||r()}}function Ee(e,t){return je(e.map((function(e){return Object.keys(e.components).map((function(n){return t(e.components[n],e.instances[n],e,n)}))})))}function je(e){return Array.prototype.concat.apply([],e)}var $e="function"==typeof Symbol&&"symbol"==typeof Symbol.toStringTag;function Te(e){var t=!1;return function(){for(var n=[],r=arguments.length;r--;)n[r]=arguments[r];if(!t)return t=!0,e.apply(this,n)}}var Ae=function(e,t){this.router=e,this.base=function(e){if(!e)if(Z){var t=document.querySelector("base");e=(e=t&&t.getAttribute("href")||"/").replace(/^https?:\/\/[^\/]+/,"")}else e="/";"/"!==e.charAt(0)&&(e="/"+e);return e.replace(/\/$/,"")}(t),this.current=m,this.pending=null,this.ready=!1,this.readyCbs=[],this.readyErrorCbs=[],this.errorCbs=[],this.listeners=[]};function Re(e,t,n,r){var o=Ee(e,(function(e,r,o,a){var i=function(e,t){"function"!=typeof e&&(e=q.extend(e));return e.options[t]}(e,t);if(i)return Array.isArray(i)?i.map((function(e){return n(e,r,o,a)})):n(i,r,o,a)}));return je(r?o.reverse():o)}function Ue(e,t){if(t)return function(){return e.apply(t,arguments)}}Ae.prototype.listen=function(e){this.cb=e},Ae.prototype.onReady=function(e,t){this.ready?e():(this.readyCbs.push(e),t&&this.readyErrorCbs.push(t))},Ae.prototype.onError=function(e){this.errorCbs.push(e)},Ae.prototype.transitionTo=function(e,t,n){var r,o=this;try{r=this.router.match(e,this.current)}catch(e){throw this.errorCbs.forEach((function(t){t(e)})),e}var a=this.current;this.confirmTransition(r,(function(){o.updateRoute(r),t&&t(r),o.ensureURL(),o.router.afterHooks.forEach((function(e){e&&e(r,a)})),o.ready||(o.ready=!0,o.readyCbs.forEach((function(e){e(r)})))}),(function(e){n&&n(e),e&&!o.ready&&(Se(e,be.redirected)&&a===m||(o.ready=!0,o.readyErrorCbs.forEach((function(t){t(e)}))))}))},Ae.prototype.confirmTransition=function(e,t,n){var r=this,o=this.current;this.pending=e;var a,i,s=function(e){!Se(e)&&ke(e)&&(r.errorCbs.length?r.errorCbs.forEach((function(t){t(e)})):console.error(e)),n&&n(e)},l=e.matched.length-1,c=o.matched.length-1;if(b(e,o)&&l===c&&e.matched[l]===o.matched[c])return this.ensureURL(),e.hash&&se(this.router,o,e,!1),s(((i=xe(a=o,e,be.duplicated,'Avoided redundant navigation to current location: "'+a.fullPath+'".')).name="NavigationDuplicated",i));var u=function(e,t){var n,r=Math.max(e.length,t.length);for(n=0;n0)){var t=this.router,n=t.options.scrollBehavior,r=me&&n;r&&this.listeners.push(ie());var o=function(){var n=e.current,o=Le(e.base);e.current===m&&o===e._startLocation||e.transitionTo(o,(function(e){r&&se(t,e,n,!0)}))};window.addEventListener("popstate",o),this.listeners.push((function(){window.removeEventListener("popstate",o)}))}},t.prototype.go=function(e){window.history.go(e)},t.prototype.push=function(e,t,n){var r=this,o=this.current;this.transitionTo(e,(function(e){ge(S(r.base+e.fullPath)),se(r.router,e,o,!1),t&&t(e)}),n)},t.prototype.replace=function(e,t,n){var r=this,o=this.current;this.transitionTo(e,(function(e){ye(S(r.base+e.fullPath)),se(r.router,e,o,!1),t&&t(e)}),n)},t.prototype.ensureURL=function(e){if(Le(this.base)!==this.current.fullPath){var t=S(this.base+this.current.fullPath);e?ge(t):ye(t)}},t.prototype.getCurrentLocation=function(){return Le(this.base)},t}(Ae);function Le(e){var t=window.location.pathname,n=t.toLowerCase(),r=e.toLowerCase();return!e||n!==r&&0!==n.indexOf(S(r+"/"))||(t=t.slice(e.length)),(t||"/")+window.location.search+window.location.hash}var Ie=function(e){function t(t,n,r){e.call(this,t,n),r&&function(e){var t=Le(e);if(!/^\/#/.test(t))return window.location.replace(S(e+"/#"+t)),!0}(this.base)||De()}return e&&(t.__proto__=e),t.prototype=Object.create(e&&e.prototype),t.prototype.constructor=t,t.prototype.setupListeners=function(){var e=this;if(!(this.listeners.length>0)){var t=this.router.options.scrollBehavior,n=me&&t;n&&this.listeners.push(ie());var r=function(){var t=e.current;De()&&e.transitionTo(Ne(),(function(r){n&&se(e.router,r,t,!0),me||Be(r.fullPath)}))},o=me?"popstate":"hashchange";window.addEventListener(o,r),this.listeners.push((function(){window.removeEventListener(o,r)}))}},t.prototype.push=function(e,t,n){var r=this,o=this.current;this.transitionTo(e,(function(e){Je(e.fullPath),se(r.router,e,o,!1),t&&t(e)}),n)},t.prototype.replace=function(e,t,n){var r=this,o=this.current;this.transitionTo(e,(function(e){Be(e.fullPath),se(r.router,e,o,!1),t&&t(e)}),n)},t.prototype.go=function(e){window.history.go(e)},t.prototype.ensureURL=function(e){var t=this.current.fullPath;Ne()!==t&&(e?Je(t):Be(t))},t.prototype.getCurrentLocation=function(){return Ne()},t}(Ae);function De(){var e=Ne();return"/"===e.charAt(0)||(Be("/"+e),!1)}function Ne(){var e=window.location.href,t=e.indexOf("#");return t<0?"":e=e.slice(t+1)}function Fe(e){var t=window.location.href,n=t.indexOf("#");return(n>=0?t.slice(0,n):t)+"#"+e}function Je(e){me?ge(Fe(e)):window.location.hash=e}function Be(e){me?ye(Fe(e)):window.location.replace(Fe(e))}var Ve=function(e){function t(t,n){e.call(this,t,n),this.stack=[],this.index=-1}return e&&(t.__proto__=e),t.prototype=Object.create(e&&e.prototype),t.prototype.constructor=t,t.prototype.push=function(e,t,n){var r=this;this.transitionTo(e,(function(e){r.stack=r.stack.slice(0,r.index+1).concat(e),r.index++,t&&t(e)}),n)},t.prototype.replace=function(e,t,n){var r=this;this.transitionTo(e,(function(e){r.stack=r.stack.slice(0,r.index).concat(e),t&&t(e)}),n)},t.prototype.go=function(e){var t=this,n=this.index+e;if(!(n<0||n>=this.stack.length)){var r=this.stack[n];this.confirmTransition(r,(function(){var e=t.current;t.index=n,t.updateRoute(r),t.router.afterHooks.forEach((function(t){t&&t(r,e)}))}),(function(e){Se(e,be.duplicated)&&(t.index=n)}))}},t.prototype.getCurrentLocation=function(){var e=this.stack[this.stack.length-1];return e?e.fullPath:"/"},t.prototype.ensureURL=function(){},t}(Ae),ze=function(e){void 0===e&&(e={}),this.app=null,this.apps=[],this.options=e,this.beforeHooks=[],this.resolveHooks=[],this.afterHooks=[],this.matcher=Q(e.routes||[],this);var t=e.mode||"hash";switch(this.fallback="history"===t&&!me&&!1!==e.fallback,this.fallback&&(t="hash"),Z||(t="abstract"),this.mode=t,t){case"history":this.history=new Me(this,e.base);break;case"hash":this.history=new Ie(this,e.base,this.fallback);break;case"abstract":this.history=new Ve(this,e.base);break;default:0}},qe={currentRoute:{configurable:!0}};ze.prototype.match=function(e,t,n){return this.matcher.match(e,t,n)},qe.currentRoute.get=function(){return this.history&&this.history.current},ze.prototype.init=function(e){var t=this;if(this.apps.push(e),e.$once("hook:destroyed",(function(){var n=t.apps.indexOf(e);n>-1&&t.apps.splice(n,1),t.app===e&&(t.app=t.apps[0]||null),t.app||t.history.teardown()})),!this.app){this.app=e;var n=this.history;if(n instanceof Me||n instanceof Ie){var r=function(e){n.setupListeners(),function(e){var r=n.current,o=t.options.scrollBehavior;me&&o&&"fullPath"in e&&se(t,e,r,!1)}(e)};n.transitionTo(n.getCurrentLocation(),r,r)}n.listen((function(e){t.apps.forEach((function(t){t._route=e}))}))}},ze.prototype.beforeEach=function(e){return We(this.beforeHooks,e)},ze.prototype.beforeResolve=function(e){return We(this.resolveHooks,e)},ze.prototype.afterEach=function(e){return We(this.afterHooks,e)},ze.prototype.onReady=function(e,t){this.history.onReady(e,t)},ze.prototype.onError=function(e){this.history.onError(e)},ze.prototype.push=function(e,t,n){var r=this;if(!t&&!n&&"undefined"!=typeof Promise)return new Promise((function(t,n){r.history.push(e,t,n)}));this.history.push(e,t,n)},ze.prototype.replace=function(e,t,n){var r=this;if(!t&&!n&&"undefined"!=typeof Promise)return new Promise((function(t,n){r.history.replace(e,t,n)}));this.history.replace(e,t,n)},ze.prototype.go=function(e){this.history.go(e)},ze.prototype.back=function(){this.go(-1)},ze.prototype.forward=function(){this.go(1)},ze.prototype.getMatchedComponents=function(e){var t=e?e.matched?e:this.resolve(e).route:this.currentRoute;return t?[].concat.apply([],t.matched.map((function(e){return Object.keys(e.components).map((function(t){return e.components[t]}))}))):[]},ze.prototype.resolve=function(e,t,n){var r=z(e,t=t||this.history.current,n,this),o=this.match(r,t),a=o.redirectedFrom||o.fullPath;return{location:r,route:o,href:function(e,t,n){var r="hash"===n?"#"+t:t;return e?S(e+"/"+r):r}(this.history.base,a,this.mode),normalizedTo:r,resolved:o}},ze.prototype.getRoutes=function(){return this.matcher.getRoutes()},ze.prototype.addRoute=function(e,t){this.matcher.addRoute(e,t),this.history.current!==m&&this.history.transitionTo(this.history.getCurrentLocation())},ze.prototype.addRoutes=function(e){this.matcher.addRoutes(e),this.history.current!==m&&this.history.transitionTo(this.history.getCurrentLocation())},Object.defineProperties(ze.prototype,qe);var Ge=ze;function We(e,t){return e.push(t),function(){var n=e.indexOf(t);n>-1&&e.splice(n,1)}}ze.install=function e(t){if(!e.installed||q!==t){e.installed=!0,q=t;var n=function(e){return void 0!==e},r=function(e,t){var r=e.$options._parentVnode;n(r)&&n(r=r.data)&&n(r=r.registerRouteInstance)&&r(e,t)};t.mixin({beforeCreate:function(){n(this.$options.router)?(this._routerRoot=this,this._router=this.$options.router,this._router.init(this),t.util.defineReactive(this,"_route",this._router.history.current)):this._routerRoot=this.$parent&&this.$parent._routerRoot||this,r(this,this)},destroyed:function(){r(this)}}),Object.defineProperty(t.prototype,"$router",{get:function(){return this._routerRoot._router}}),Object.defineProperty(t.prototype,"$route",{get:function(){return this._routerRoot._route}}),t.component("RouterView",x),t.component("RouterLink",W);var o=t.config.optionMergeStrategies;o.beforeRouteEnter=o.beforeRouteLeave=o.beforeRouteUpdate=o.created}},ze.version="3.6.5",ze.isNavigationFailure=Se,ze.NavigationFailureType=be,ze.START_LOCATION=m,Z&&window.Vue&&window.Vue.use(ze);var He={"components/AlgoliaSearchBox":()=>Promise.all([n.e(0),n.e(29)]).then(n.bind(null,290)),"components/DropdownLink":()=>Promise.all([n.e(0),n.e(17)]).then(n.bind(null,180)),"components/DropdownTransition":()=>Promise.all([n.e(0),n.e(30)]).then(n.bind(null,160)),"components/Home":()=>Promise.all([n.e(0),n.e(23)]).then(n.bind(null,291)),"components/NavLink":()=>n.e(38).then(n.bind(null,159)),"components/NavLinks":()=>Promise.all([n.e(0),n.e(16)]).then(n.bind(null,200)),"components/Navbar":()=>Promise.all([n.e(0),n.e(1)]).then(n.bind(null,465)),"components/Page":()=>Promise.all([n.e(0),n.e(14)]).then(n.bind(null,292)),"components/PageEdit":()=>Promise.all([n.e(0),n.e(24)]).then(n.bind(null,205)),"components/PageNav":()=>Promise.all([n.e(0),n.e(21)]).then(n.bind(null,206)),"components/Sidebar":()=>Promise.all([n.e(0),n.e(12)]).then(n.bind(null,293)),"components/SidebarButton":()=>Promise.all([n.e(0),n.e(31)]).then(n.bind(null,296)),"components/SidebarGroup":()=>Promise.all([n.e(0),n.e(3)]).then(n.bind(null,201)),"components/SidebarLink":()=>Promise.all([n.e(0),n.e(25)]).then(n.bind(null,181)),"components/SidebarLinks":()=>Promise.all([n.e(0),n.e(3)]).then(n.bind(null,176)),"components/VersionChooser":()=>Promise.all([n.e(0),n.e(20)]).then(n.bind(null,294)),"components/VersioningMixin":()=>n.e(52).then(n.bind(null,164)),"global-components/Badge":()=>Promise.all([n.e(0),n.e(4)]).then(n.bind(null,490)),"layouts/404":()=>n.e(7).then(n.bind(null,477)),"layouts/Layout":()=>Promise.all([n.e(0),n.e(1),n.e(2)]).then(n.bind(null,478)),NotFound:()=>n.e(7).then(n.bind(null,477)),Layout:()=>Promise.all([n.e(0),n.e(1),n.e(2)]).then(n.bind(null,478))},Ze={"v-3ec20de4":()=>n.e(54).then(n.bind(null,491)),"v-31596d2d":()=>n.e(55).then(n.bind(null,492)),"v-26232766":()=>n.e(56).then(n.bind(null,493)),"v-5e94256a":()=>n.e(57).then(n.bind(null,494)),"v-5e0de9fe":()=>n.e(59).then(n.bind(null,495)),"v-418e1b4d":()=>n.e(60).then(n.bind(null,496)),"v-4155eb1e":()=>n.e(58).then(n.bind(null,497)),"v-6bf62e0d":()=>n.e(41).then(n.bind(null,498)),"v-63a2d53d":()=>n.e(61).then(n.bind(null,499)),"v-d80ea866":()=>n.e(62).then(n.bind(null,500)),"v-4899abd1":()=>n.e(63).then(n.bind(null,501)),"v-5e5c94cd":()=>n.e(65).then(n.bind(null,502)),"v-4081eb72":()=>n.e(64).then(n.bind(null,503)),"v-0059cb2a":()=>n.e(66).then(n.bind(null,504)),"v-6993aee6":()=>n.e(68).then(n.bind(null,505)),"v-3359623e":()=>n.e(42).then(n.bind(null,506)),"v-cfac61a6":()=>n.e(69).then(n.bind(null,507)),"v-6aca4be5":()=>n.e(70).then(n.bind(null,508)),"v-37dbaaa0":()=>n.e(71).then(n.bind(null,509)),"v-7758ae27":()=>n.e(72).then(n.bind(null,510)),"v-25dd3de6":()=>n.e(67).then(n.bind(null,511)),"v-9f635184":()=>n.e(18).then(n.bind(null,512)),"v-5fd8f1ad":()=>n.e(13).then(n.bind(null,513)),"v-43de507e":()=>n.e(74).then(n.bind(null,514)),"v-f5de2fb4":()=>n.e(73).then(n.bind(null,515)),"v-654015de":()=>n.e(75).then(n.bind(null,516)),"v-8d587926":()=>n.e(76).then(n.bind(null,517)),"v-dc734f12":()=>n.e(77).then(n.bind(null,518)),"v-1772ad2d":()=>n.e(78).then(n.bind(null,519)),"v-75018026":()=>n.e(43).then(n.bind(null,520)),"v-253cefad":()=>n.e(79).then(n.bind(null,521)),"v-2840d4fe":()=>n.e(80).then(n.bind(null,522)),"v-1b45967e":()=>n.e(81).then(n.bind(null,523)),"v-e35c5e24":()=>n.e(83).then(n.bind(null,524)),"v-021062ed":()=>n.e(82).then(n.bind(null,525)),"v-97aa86e6":()=>n.e(44).then(n.bind(null,526)),"v-04d2236d":()=>n.e(45).then(n.bind(null,527)),"v-1a823cb0":()=>n.e(46).then(n.bind(null,528)),"v-00153acd":()=>n.e(85).then(n.bind(null,529)),"v-4af2bfca":()=>n.e(84).then(n.bind(null,530)),"v-9a2a2626":()=>n.e(86).then(n.bind(null,531)),"v-560d08d2":()=>n.e(47).then(n.bind(null,532)),"v-ef2073ec":()=>n.e(15).then(n.bind(null,533)),"v-592eaa86":()=>n.e(48).then(n.bind(null,534)),"v-ffc79ec2":()=>n.e(87).then(n.bind(null,535)),"v-c71b5aa6":()=>n.e(88).then(n.bind(null,536)),"v-186cd6ed":()=>n.e(90).then(n.bind(null,537)),"v-1005bb66":()=>n.e(89).then(n.bind(null,538)),"v-0ee3f026":()=>n.e(91).then(n.bind(null,539)),"v-2997b752":()=>n.e(92).then(n.bind(null,540)),"v-24966ce6":()=>n.e(49).then(n.bind(null,541)),"v-4fe4e126":()=>n.e(93).then(n.bind(null,542)),"v-f9778ae6":()=>n.e(94).then(n.bind(null,543)),"v-d2a018a6":()=>n.e(95).then(n.bind(null,544)),"v-9ddae032":()=>n.e(96).then(n.bind(null,545)),"v-3f85032d":()=>n.e(97).then(n.bind(null,546)),"v-2fcee9ad":()=>n.e(98).then(n.bind(null,547)),"v-45d803ab":()=>n.e(50).then(n.bind(null,548)),"v-525dec3e":()=>n.e(99).then(n.bind(null,549)),"v-0e5e57cd":()=>n.e(100).then(n.bind(null,550)),"v-6e6b7e2d":()=>n.e(101).then(n.bind(null,551)),"v-1227575e":()=>n.e(103).then(n.bind(null,552)),"v-06e0a8ca":()=>n.e(102).then(n.bind(null,553)),"v-00d62ee6":()=>n.e(104).then(n.bind(null,554)),"v-59d340ad":()=>n.e(51).then(n.bind(null,555)),"v-221bfb8d":()=>n.e(105).then(n.bind(null,556)),"v-3eeef04a":()=>n.e(106).then(n.bind(null,557)),"v-857a96a6":()=>n.e(107).then(n.bind(null,558)),"v-10d9ffb7":()=>n.e(108).then(n.bind(null,559)),"v-d5007282":()=>n.e(109).then(n.bind(null,560)),"v-64c18f4d":()=>n.e(111).then(n.bind(null,561)),"v-9adb302a":()=>n.e(112).then(n.bind(null,562)),"v-8850e2c4":()=>n.e(110).then(n.bind(null,563))};function Ke(e){const t=Object.create(null);return function(n){return t[n]||(t[n]=e(n))}}const Xe=/-(\w)/g,Qe=Ke(e=>e.replace(Xe,(e,t)=>t?t.toUpperCase():"")),Ye=/\B([A-Z])/g,et=Ke(e=>e.replace(Ye,"-$1").toLowerCase()),tt=Ke(e=>e.charAt(0).toUpperCase()+e.slice(1));function nt(e,t){if(!t)return;if(e(t))return e(t);return t.includes("-")?e(tt(Qe(t))):e(tt(t))||e(et(t))}const rt=Object.assign({},He,Ze),ot=e=>rt[e],at=e=>Ze[e],it=e=>He[e],st=e=>r.a.component(e);function lt(e){return nt(at,e)}function ct(e){return nt(it,e)}function ut(e){return nt(ot,e)}function pt(e){return nt(st,e)}function dt(...e){return Promise.all(e.filter(e=>e).map(async e=>{if(!pt(e)&&ut(e)){const t=await ut(e)();r.a.component(e,t.default)}}))}function ft(e,t){"undefined"!=typeof window&&window.__VUEPRESS__&&(window.__VUEPRESS__[e]=t)}var ht=n(47),vt=n.n(ht),mt=n(48),gt=n.n(mt),yt={created(){if(this.siteMeta=this.$site.headTags.filter(([e])=>"meta"===e).map(([e,t])=>t),this.$ssrContext){const t=this.getMergedMetaTags();this.$ssrContext.title=this.$title,this.$ssrContext.lang=this.$lang,this.$ssrContext.pageMeta=(e=t)?e.map(e=>{let t="{t+=` ${n}="${gt()(e[n])}"`}),t+">"}).join("\n "):"",this.$ssrContext.canonicalLink=wt(this.$canonicalUrl)}var e},mounted(){this.currentMetaTags=[...document.querySelectorAll("meta")],this.updateMeta(),this.updateCanonicalLink()},methods:{updateMeta(){document.title=this.$title,document.documentElement.lang=this.$lang;const e=this.getMergedMetaTags();this.currentMetaTags=_t(e,this.currentMetaTags)},getMergedMetaTags(){const e=this.$page.frontmatter.meta||[];return vt()([{name:"description",content:this.$description}],e,this.siteMeta,xt)},updateCanonicalLink(){bt(),this.$canonicalUrl&&document.head.insertAdjacentHTML("beforeend",wt(this.$canonicalUrl))}},watch:{$page(){this.updateMeta(),this.updateCanonicalLink()}},beforeDestroy(){_t(null,this.currentMetaTags),bt()}};function bt(){const e=document.querySelector("link[rel='canonical']");e&&e.remove()}function wt(e=""){return e?``:""}function _t(e,t){if(t&&[...t].filter(e=>e.parentNode===document.head).forEach(e=>document.head.removeChild(e)),e)return e.map(e=>{const t=document.createElement("meta");return Object.keys(e).forEach(n=>{t.setAttribute(n,e[n])}),document.head.appendChild(t),t})}function xt(e){for(const t of["name","property","itemprop"])if(e.hasOwnProperty(t))return e[t]+t;return JSON.stringify(e)}var Pt=n(13),kt=n.n(Pt),St={mounted(){kt.a.configure({showSpinner:!1}),this.$router.beforeEach((e,t,n)=>{e.path===t.path||r.a.component(e.name)||kt.a.start(),n()}),this.$router.afterEach(()=>{kt.a.done(),this.isSidebarOpen=!1})}},Ot=n(49),Ct={mounted(){window.addEventListener("scroll",this.onScroll)},methods:{onScroll:n.n(Ot)()((function(){this.setActiveHash()}),300),setActiveHash(){const e=[].slice.call(document.querySelectorAll(".sidebar-link")),t=[].slice.call(document.querySelectorAll(".header-anchor")).filter(t=>e.some(e=>e.hash===t.hash)),n=Math.max(window.pageYOffset,document.documentElement.scrollTop,document.body.scrollTop),r=Math.max(document.documentElement.scrollHeight,document.body.scrollHeight),o=window.innerHeight+n;for(let e=0;e=a.parentElement.offsetTop+10&&(!i||n{this.$nextTick(()=>{this.$vuepress.$set("disableScrollBehavior",!1)})})}}}},beforeDestroy(){window.removeEventListener("scroll",this.onScroll)}},Et={props:{parent:Object,code:String,options:{align:String,color:String,backgroundTransition:Boolean,backgroundColor:String,successText:String,staticIcon:Boolean}},data:()=>({success:!1,originalBackground:null,originalTransition:null}),computed:{alignStyle(){let e={};return e[this.options.align]="7.5px",e},iconClass(){return this.options.staticIcon?"":"hover"}},mounted(){this.originalTransition=this.parent.style.transition,this.originalBackground=this.parent.style.background},beforeDestroy(){this.parent.style.transition=this.originalTransition,this.parent.style.background=this.originalBackground},methods:{hexToRgb(e){let t=/^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(e);return t?{r:parseInt(t[1],16),g:parseInt(t[2],16),b:parseInt(t[3],16)}:null},copyToClipboard(e){if(navigator.clipboard)navigator.clipboard.writeText(this.code).then(()=>{this.setSuccessTransitions()},()=>{});else{let e=document.createElement("textarea");document.body.appendChild(e),e.value=this.code,e.select(),document.execCommand("Copy"),e.remove(),this.setSuccessTransitions()}},setSuccessTransitions(){if(clearTimeout(this.successTimeout),this.options.backgroundTransition){this.parent.style.transition="background 350ms";let e=this.hexToRgb(this.options.backgroundColor);this.parent.style.background=`rgba(${e.r}, ${e.g}, ${e.b}, 0.1)`}this.success=!0,this.successTimeout=setTimeout(()=>{this.options.backgroundTransition&&(this.parent.style.background=this.originalBackground,this.parent.style.transition=this.originalTransition),this.success=!1},500)}}},jt=(n(146),n(4)),$t=Object(jt.a)(Et,(function(){var e=this,t=e._self._c;return t("div",{staticClass:"code-copy"},[t("svg",{class:e.iconClass,style:e.alignStyle,attrs:{xmlns:"http://www.w3.org/2000/svg",width:"24",height:"24",viewBox:"0 0 24 24"},on:{click:e.copyToClipboard}},[t("path",{attrs:{fill:"none",d:"M0 0h24v24H0z"}}),e._v(" "),t("path",{attrs:{fill:e.options.color,d:"M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4l6 6v10c0 1.1-.9 2-2 2H7.99C6.89 23 6 22.1 6 21l.01-14c0-1.1.89-2 1.99-2h7zm-1 7h5.5L14 6.5V12z"}})]),e._v(" "),t("span",{class:e.success?"success":"",style:e.alignStyle},[e._v("\n "+e._s(e.options.successText)+"\n ")])])}),[],!1,null,"49140617",null).exports,Tt=(n(147),[yt,St,Ct,{updated(){this.update()},methods:{update(){setTimeout(()=>{document.querySelectorAll('div[class*="language-"] pre').forEach(e=>{if(e.classList.contains("code-copy-added"))return;let t=new(r.a.extend($t));t.options={align:"bottom",color:"#27b1ff",backgroundTransition:!0,backgroundColor:"#0075b8",successText:"Copied!",staticIcon:!1},t.code=e.innerText,t.parent=e,t.$mount(),e.classList.add("code-copy-added"),e.appendChild(t.$el)})},100)}}}]),At={name:"GlobalLayout",computed:{layout(){const e=this.getLayout();return ft("layout",e),r.a.component(e)}},methods:{getLayout(){if(this.$page.path){const e=this.$page.frontmatter.layout;return e&&(this.$vuepress.getLayoutAsyncComponent(e)||this.$vuepress.getVueComponent(e))?e:"Layout"}return"NotFound"}}},Rt=Object(jt.a)(At,(function(){return(0,this._self._c)(this.layout,{tag:"component"})}),[],!1,null,null,null).exports;!function(e,t,n){switch(t){case"components":e[t]||(e[t]={}),Object.assign(e[t],n);break;case"mixins":e[t]||(e[t]=[]),e[t].push(...n);break;default:throw new Error("Unknown option name.")}}(Rt,"mixins",Tt);const Ut=[{name:"v-3ec20de4",path:"/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-3ec20de4").then(n)}},{path:"/index.html",redirect:"/"},{name:"v-31596d2d",path:"/about.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-31596d2d").then(n)}},{name:"v-26232766",path:"/contact.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-26232766").then(n)}},{name:"v-5e94256a",path:"/documentation/0.4/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-5e94256a").then(n)}},{path:"/documentation/0.4/index.html",redirect:"/documentation/0.4/"},{name:"v-5e0de9fe",path:"/documentation/0.4/developers/api/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-5e0de9fe").then(n)}},{path:"/documentation/0.4/developers/api/index.html",redirect:"/documentation/0.4/developers/api/"},{name:"v-418e1b4d",path:"/documentation/0.4/developers/api/errors.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-418e1b4d").then(n)}},{name:"v-4155eb1e",path:"/documentation/0.4/developers/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-4155eb1e").then(n)}},{path:"/documentation/0.4/developers/index.html",redirect:"/documentation/0.4/developers/"},{name:"v-6bf62e0d",path:"/documentation/0.4/developers/arch.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-6bf62e0d").then(n)}},{name:"v-63a2d53d",path:"/documentation/0.4/developers/api/reference.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-63a2d53d").then(n)}},{name:"v-d80ea866",path:"/documentation/0.4/developers/backends/getting-started.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-d80ea866").then(n)}},{name:"v-4899abd1",path:"/documentation/0.4/developers/backends/udfs.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-4899abd1").then(n)}},{name:"v-5e5c94cd",path:"/documentation/0.4/developers/clients/library-guidelines.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-5e5c94cd").then(n)}},{name:"v-4081eb72",path:"/documentation/0.4/developers/clients/getting-started.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-4081eb72").then(n)}},{name:"v-0059cb2a",path:"/documentation/0.4/developers/examples/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-0059cb2a").then(n)}},{path:"/documentation/0.4/developers/examples/index.html",redirect:"/documentation/0.4/developers/examples/"},{name:"v-6993aee6",path:"/documentation/0.4/getting-started.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-6993aee6").then(n)}},{name:"v-3359623e",path:"/documentation/0.4/glossary.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-3359623e").then(n)}},{name:"v-cfac61a6",path:"/documentation/0.4/processes.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-cfac61a6").then(n)}},{name:"v-6aca4be5",path:"/documentation/0.4/udfs.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-6aca4be5").then(n)}},{name:"v-37dbaaa0",path:"/documentation/1.0/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-37dbaaa0").then(n)}},{path:"/documentation/1.0/index.html",redirect:"/documentation/1.0/"},{name:"v-7758ae27",path:"/documentation/1.0/authentication.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-7758ae27").then(n)}},{name:"v-25dd3de6",path:"/documentation/0.4/developers/examples/poc.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-25dd3de6").then(n)}},{name:"v-9f635184",path:"/documentation/1.0/cookbook/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-9f635184").then(n)}},{path:"/documentation/1.0/cookbook/index.html",redirect:"/documentation/1.0/cookbook/"},{name:"v-5fd8f1ad",path:"/documentation/1.0/datacubes.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-5fd8f1ad").then(n)}},{name:"v-43de507e",path:"/documentation/1.0/developers/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-43de507e").then(n)}},{path:"/documentation/1.0/developers/index.html",redirect:"/documentation/1.0/developers/"},{name:"v-f5de2fb4",path:"/documentation/1.0/datacubes/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-f5de2fb4").then(n)}},{path:"/documentation/1.0/datacubes/index.html",redirect:"/documentation/1.0/datacubes/"},{name:"v-654015de",path:"/documentation/1.0/developers/api/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-654015de").then(n)}},{path:"/documentation/1.0/developers/api/index.html",redirect:"/documentation/1.0/developers/api/"},{name:"v-8d587926",path:"/documentation/1.0/developers/api/errors.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-8d587926").then(n)}},{name:"v-dc734f12",path:"/documentation/1.0/developers/api/reference.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-dc734f12").then(n)}},{name:"v-1772ad2d",path:"/documentation/1.0/developers/backends/getting-started.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-1772ad2d").then(n)}},{name:"v-75018026",path:"/documentation/1.0/developers/arch.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-75018026").then(n)}},{name:"v-253cefad",path:"/documentation/1.0/developers/backends/performance.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-253cefad").then(n)}},{name:"v-2840d4fe",path:"/documentation/1.0/developers/backends/xarray.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-2840d4fe").then(n)}},{name:"v-1b45967e",path:"/documentation/1.0/developers/clients/getting-started.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-1b45967e").then(n)}},{name:"v-e35c5e24",path:"/documentation/1.0/developers/profiles/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-e35c5e24").then(n)}},{path:"/documentation/1.0/developers/profiles/index.html",redirect:"/documentation/1.0/developers/profiles/"},{name:"v-021062ed",path:"/documentation/1.0/developers/clients/library-guidelines.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-021062ed").then(n)}},{name:"v-97aa86e6",path:"/documentation/1.0/developers/profiles/api.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-97aa86e6").then(n)}},{name:"v-04d2236d",path:"/documentation/1.0/developers/profiles/processes.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-04d2236d").then(n)}},{name:"v-1a823cb0",path:"/documentation/1.0/javascript/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-1a823cb0").then(n)}},{path:"/documentation/1.0/javascript/index.html",redirect:"/documentation/1.0/javascript/"},{name:"v-00153acd",path:"/documentation/1.0/processes.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-00153acd").then(n)}},{name:"v-4af2bfca",path:"/documentation/1.0/glossary.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-4af2bfca").then(n)}},{name:"v-9a2a2626",path:"/documentation/1.0/python/client-side-processing.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-9a2a2626").then(n)}},{name:"v-560d08d2",path:"/documentation/1.0/python/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-560d08d2").then(n)}},{path:"/documentation/1.0/python/index.html",redirect:"/documentation/1.0/python/"},{name:"v-ef2073ec",path:"/documentation/1.0/qgis/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-ef2073ec").then(n)}},{path:"/documentation/1.0/qgis/index.html",redirect:"/documentation/1.0/qgis/"},{name:"v-592eaa86",path:"/documentation/1.0/r/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-592eaa86").then(n)}},{path:"/documentation/1.0/r/index.html",redirect:"/documentation/1.0/r/"},{name:"v-ffc79ec2",path:"/documentation/1.0/udfs.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-ffc79ec2").then(n)}},{name:"v-c71b5aa6",path:"/documentation/code-of-conduct.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-c71b5aa6").then(n)}},{name:"v-186cd6ed",path:"/events/igarrs2021.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-186cd6ed").then(n)}},{name:"v-1005bb66",path:"/documentation/software-guidelines.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-1005bb66").then(n)}},{name:"v-0ee3f026",path:"/news/2017-12-05-welcome.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-0ee3f026").then(n)}},{name:"v-2997b752",path:"/news/2017-12-18-VITO_meeting.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-2997b752").then(n)}},{name:"v-24966ce6",path:"/news/2018-01-31-WWU_meeting.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-24966ce6").then(n)}},{name:"v-4fe4e126",path:"/news/2018-03-15-poc.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-4fe4e126").then(n)}},{name:"v-f9778ae6",path:"/news/2018-05-23-user-requirements-survey-launched.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-f9778ae6").then(n)}},{name:"v-d2a018a6",path:"/news/2018-10-30-year-one-review-meeting.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-d2a018a6").then(n)}},{name:"v-9ddae032",path:"/news/2019-10-07-EO-big-data-hackaton.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-9ddae032").then(n)}},{name:"v-3f85032d",path:"/news/2020-07-31-lessons-learned.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-3f85032d").then(n)}},{name:"v-2fcee9ad",path:"/news/2020-07-31-openeo-api-released.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-2fcee9ad").then(n)}},{name:"v-45d803ab",path:"/news/2019-03-07-openeo-api-040.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-45d803ab").then(n)}},{name:"v-525dec3e",path:"/news/2020-09-02-openeo-user-workshop.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-525dec3e").then(n)}},{name:"v-0e5e57cd",path:"/news/2020-11-30-openeo-api-101-released.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-0e5e57cd").then(n)}},{name:"v-6e6b7e2d",path:"/news/2021-05-17-openeo-api-110-released.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-6e6b7e2d").then(n)}},{name:"v-1227575e",path:"/news/2022-04-08-psc-meetings.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-1227575e").then(n)}},{name:"v-06e0a8ca",path:"/news/2021-11-08-r-client-on-cran.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-06e0a8ca").then(n)}},{name:"v-00d62ee6",path:"/news/2022-07-07-monthly-dev-calls.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-00d62ee6").then(n)}},{name:"v-59d340ad",path:"/news/2022-05-12-r-client-v120.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-59d340ad").then(n)}},{name:"v-221bfb8d",path:"/news/2022-11-17-r-client-v130.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-221bfb8d").then(n)}},{name:"v-3eeef04a",path:"/news/2023-05-25-new-openeo-versions-120-200rc1%20copy.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-3eeef04a").then(n)}},{path:"/news/2023-05-25-new-openeo-versions-120-200rc1 copy.html",redirect:"/news/2023-05-25-new-openeo-versions-120-200rc1%20copy.html"},{path:"/news/2023-05-25-new-openeo-versions-120-200rc1 copy.html",redirect:"/news/2023-05-25-new-openeo-versions-120-200rc1%20copy.html"},{name:"v-857a96a6",path:"/news/2023-12-06-openeo-submitted-to-ogc.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-857a96a6").then(n)}},{name:"v-10d9ffb7",path:"/news/2024-02-06-openeo-ogc-rfc.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-10d9ffb7").then(n)}},{name:"v-d5007282",path:"/news/2024-03-22_mooc_cubeandclouds.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-d5007282").then(n)}},{name:"v-64c18f4d",path:"/psc.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-64c18f4d").then(n)}},{name:"v-9adb302a",path:"/software.html",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-9adb302a").then(n)}},{name:"v-8850e2c4",path:"/news/",component:Rt,beforeEnter:(e,t,n)=>{dt("Layout","v-8850e2c4").then(n)}},{path:"/news/index.html",redirect:"/news/"},{path:"*",component:Rt}],Mt={title:"openEO",description:"openEO develops an open API to connect various clients to big EO cloud back-ends in a simple and unified way.",base:"/",headTags:[],pages:[{title:"Home",frontmatter:{home:!0},regularPath:"/",relativePath:"README.md",key:"v-3ec20de4",path:"/",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"About",frontmatter:{},regularPath:"/about.html",relativePath:"about.md",key:"v-31596d2d",path:"/about.html",headers:[{level:2,title:"openEO?",slug:"openeo"},{level:2,title:"Why an API?",slug:"why-an-api"},{level:2,title:"More information",slug:"more-information"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Contact",frontmatter:{sidebar:!1},regularPath:"/contact.html",relativePath:"contact.md",key:"v-26232766",path:"/contact.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO Documentation",frontmatter:{},regularPath:"/documentation/0.4/",relativePath:"documentation/0.4/README.md",key:"v-5e94256a",path:"/documentation/0.4/",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{frontmatter:{iframe:"https://api.openeo.org/v/0.4.2/"},regularPath:"/documentation/0.4/developers/api/",relativePath:"documentation/0.4/developers/api/README.md",key:"v-5e0de9fe",path:"/documentation/0.4/developers/api/",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Status and error handling",frontmatter:{},regularPath:"/documentation/0.4/developers/api/errors.html",relativePath:"documentation/0.4/developers/api/errors.md",key:"v-418e1b4d",path:"/documentation/0.4/developers/api/errors.html",headers:[{level:2,title:"JSON error object",slug:"json-error-object"},{level:2,title:"Standardized status codes",slug:"standardized-status-codes"},{level:2,title:"openEO error codes",slug:"openeo-error-codes"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Introduction",frontmatter:{},regularPath:"/documentation/0.4/developers/",relativePath:"documentation/0.4/developers/README.md",key:"v-4155eb1e",path:"/documentation/0.4/developers/",headers:[{level:2,title:"Additional information",slug:"additional-information"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Architecture",frontmatter:{},regularPath:"/documentation/0.4/developers/arch.html",relativePath:"documentation/0.4/developers/arch.md",key:"v-6bf62e0d",path:"/documentation/0.4/developers/arch.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{frontmatter:{fullpage:!0,stripCSS:!0},regularPath:"/documentation/0.4/developers/api/reference.html",relativePath:"documentation/0.4/developers/api/reference.md",key:"v-63a2d53d",path:"/documentation/0.4/developers/api/reference.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Getting started for back-end providers",frontmatter:{},regularPath:"/documentation/0.4/developers/backends/getting-started.html",relativePath:"documentation/0.4/developers/backends/getting-started.md",key:"v-d80ea866",path:"/documentation/0.4/developers/backends/getting-started.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"User-defined functions",frontmatter:{},regularPath:"/documentation/0.4/developers/backends/udfs.html",relativePath:"documentation/0.4/developers/backends/udfs.md",key:"v-4899abd1",path:"/documentation/0.4/developers/backends/udfs.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Client library development guidelines",frontmatter:{},regularPath:"/documentation/0.4/developers/clients/library-guidelines.html",relativePath:"documentation/0.4/developers/clients/library-guidelines.md",key:"v-5e5c94cd",path:"/documentation/0.4/developers/clients/library-guidelines.html",headers:[{level:2,title:"Conventions",slug:"conventions"},{level:3,title:"Casing",slug:"casing"},{level:3,title:"Scopes",slug:"scopes"},{level:3,title:"Scope categories",slug:"scope-categories"},{level:3,title:"Parameters",slug:"parameters"},{level:2,title:"Method mappings",slug:"method-mappings"},{level:3,title:"Scope: openEO (root category)",slug:"scope-openeo-root-category"},{level:4,title:"Parameters",slug:"parameters-2"},{level:3,title:"Scope: Connection (API category)",slug:"scope-connection-api-category"},{level:4,title:"Parameters",slug:"parameters-3"},{level:3,title:"Scope Capabilities (Content category)",slug:"scope-capabilities-content-category"},{level:4,title:"Parameters",slug:"parameters-4"},{level:3,title:"Scope: File (API category)",slug:"scope-file-api-category"},{level:4,title:"Parameters",slug:"parameters-5"},{level:3,title:"Scope: Job (API category)",slug:"scope-job-api-category"},{level:4,title:"Parameters",slug:"parameters-6"},{level:3,title:"Scope: ProcessGraph (API category)",slug:"scope-processgraph-api-category"},{level:3,title:"Scope: Service (API category)",slug:"scope-service-api-category"},{level:2,title:"Processes",slug:"processes"},{level:2,title:"Workflow example",slug:"workflow-example"},{level:3,title:"R (functional style)",slug:"r-functional-style"},{level:3,title:"Python (mixed style)",slug:"python-mixed-style"},{level:3,title:"Java (object oriented style)",slug:"java-object-oriented-style"},{level:3,title:"PHP (procedural style)",slug:"php-procedural-style"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Getting started for client developers",frontmatter:{},regularPath:"/documentation/0.4/developers/clients/getting-started.html",relativePath:"documentation/0.4/developers/clients/getting-started.md",key:"v-4081eb72",path:"/documentation/0.4/developers/clients/getting-started.html",headers:[{level:2,title:"Client library developers",slug:"client-library-developers"},{level:2,title:"Applications and Software plugins",slug:"applications-and-software-plugins"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Examples",frontmatter:{},regularPath:"/documentation/0.4/developers/examples/",relativePath:"documentation/0.4/developers/examples/README.md",key:"v-0059cb2a",path:"/documentation/0.4/developers/examples/",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Getting started for users",frontmatter:{},regularPath:"/documentation/0.4/getting-started.html",relativePath:"documentation/0.4/getting-started.md",key:"v-6993aee6",path:"/documentation/0.4/getting-started.html",headers:[{level:2,title:"Contribute",slug:"contribute"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Glossary",frontmatter:{},regularPath:"/documentation/0.4/glossary.html",relativePath:"documentation/0.4/glossary.md",key:"v-3359623e",path:"/documentation/0.4/glossary.html",headers:[{level:2,title:"General terms",slug:"general-terms"},{level:2,title:"Processes and process graphs",slug:"processes-and-process-graphs"},{level:2,title:"EO data (Collections)",slug:"eo-data-collections"},{level:2,title:"Spatial data cubes",slug:"spatial-data-cubes"},{level:3,title:"apply: processes that do not change dimensions",slug:"apply-processes-that-do-not-change-dimensions"},{level:3,title:"filter: subsetting dimensions by dimension value selection",slug:"filter-subsetting-dimensions-by-dimension-value-selection"},{level:3,title:"reduce: removing dimensions entirely by computation",slug:"reduce-removing-dimensions-entirely-by-computation"},{level:3,title:"aggregate: reducing resolution",slug:"aggregate-reducing-resolution"},{level:3,title:"resample: changing data cube geometry",slug:"resample-changing-data-cube-geometry"},{level:2,title:"User-defined function (UDF)",slug:"user-defined-function-udf"},{level:2,title:"Data Processing modes",slug:"data-processing-modes"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{frontmatter:{fullpage:!0,stripCSS:!0},regularPath:"/documentation/0.4/processes.html",relativePath:"documentation/0.4/processes.md",key:"v-cfac61a6",path:"/documentation/0.4/processes.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"User-defined functions",frontmatter:{},regularPath:"/documentation/0.4/udfs.html",relativePath:"documentation/0.4/udfs.md",key:"v-6aca4be5",path:"/documentation/0.4/udfs.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Introduction",frontmatter:{},regularPath:"/documentation/1.0/",relativePath:"documentation/1.0/README.md",key:"v-37dbaaa0",path:"/documentation/1.0/",headers:[{level:2,title:"Contribute",slug:"contribute"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Authentication",frontmatter:{},regularPath:"/documentation/1.0/authentication.html",relativePath:"documentation/1.0/authentication.md",key:"v-7758ae27",path:"/documentation/1.0/authentication.html",headers:[{level:2,title:"HTTP Basic",slug:"http-basic"},{level:2,title:"OpenID Connect",slug:"openid-connect"},{level:3,title:"Authorization Code Flow",slug:"authorization-code-flow"},{level:3,title:"Device Flow",slug:"device-flow"},{level:3,title:"Client Credentials Flow",slug:"client-credentials-flow"},{level:3,title:"Resource Owner Password flow",slug:"resource-owner-password-flow"},{level:3,title:"Refresh Token Flow",slug:"refresh-token-flow"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Examples (proof of concept)",frontmatter:{},regularPath:"/documentation/0.4/developers/examples/poc.html",relativePath:"documentation/0.4/developers/examples/poc.md",key:"v-25dd3de6",path:"/documentation/0.4/developers/examples/poc.html",headers:[{level:2,title:"Use Case 1",slug:"use-case-1"},{level:2,title:"Use Case 2",slug:"use-case-2"},{level:2,title:"Use Case 3",slug:"use-case-3"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO Cookbook",frontmatter:{sidebarDepth:3},regularPath:"/documentation/1.0/cookbook/",relativePath:"documentation/1.0/cookbook/README.md",key:"v-9f635184",path:"/documentation/1.0/cookbook/",headers:[{level:2,title:"Chapter 1",slug:"chapter-1"},{level:3,title:"Connecting to a back-end",slug:"connecting-to-a-back-end"},{level:3,title:"Input: load_collection",slug:"input-load-collection"},{level:3,title:"Filter Bands: filter_bands",slug:"filter-bands-filter-bands"},{level:3,title:"Temporal Mean: reduce_dimension",slug:"temporal-mean-reduce-dimension"},{level:3,title:"Scale All Pixels Linearly: apply, linear_scale_range",slug:"scale-all-pixels-linearly-apply-linear-scale-range"},{level:3,title:"Spatial Aggregation: aggregate_spatial",slug:"spatial-aggregation-aggregate-spatial"},{level:3,title:"Output: save_result",slug:"output-save-result"},{level:4,title:"Raster Formats: GTiff, NetCDF",slug:"raster-formats-gtiff-netcdf"},{level:4,title:"Raster Formats: PNG",slug:"raster-formats-png"},{level:4,title:"Text Formats: JSON, CSV",slug:"text-formats-json-csv"},{level:3,title:"Output: Process as JSON",slug:"output-process-as-json"},{level:2,title:"Chapter 2",slug:"chapter-2"},{level:3,title:"Bandmath",slug:"bandmath"},{level:4,title:"Example 1: NDVI",slug:"example-1-ndvi"},{level:4,title:"Example 2: EVI",slug:"example-2-evi"},{level:3,title:"Masks: mask",slug:"masks-mask"},{level:4,title:"Mask Out Specific Values",slug:"mask-out-specific-values"},{level:4,title:"Thresholds",slug:"thresholds"},{level:3,title:"Pixel Operations: apply",slug:"pixel-operations-apply"},{level:3,title:"Image Kernels: apply_kernel",slug:"image-kernels-apply-kernel"},{level:2,title:"Endnote",slug:"endnote"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Datacubes",frontmatter:{},regularPath:"/documentation/1.0/datacubes.html",relativePath:"documentation/1.0/datacubes.md",key:"v-5fd8f1ad",path:"/documentation/1.0/datacubes.html",headers:[{level:2,title:"What are Datacubes?",slug:"what-are-datacubes"},{level:2,title:"Dimensions",slug:"dimensions"},{level:3,title:"Applying Processes on Dimensions",slug:"applying-processes-on-dimensions"},{level:3,title:"Resolution",slug:"resolution"},{level:3,title:"Coordinate Reference System as a Dimension",slug:"coordinate-reference-system-as-a-dimension"},{level:2,title:"Values in a datacube",slug:"values-in-a-datacube"},{level:2,title:"Processes on Datacubes",slug:"processes-on-datacubes"},{level:3,title:"Filter",slug:"filter"},{level:3,title:"Apply",slug:"apply"},{level:3,title:"Resample",slug:"resample"},{level:3,title:"Reduce",slug:"reduce"},{level:3,title:"Aggregate",slug:"aggregate"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Introduction",frontmatter:{},regularPath:"/documentation/1.0/developers/",relativePath:"documentation/1.0/developers/README.md",key:"v-43de507e",path:"/documentation/1.0/developers/",headers:[{level:2,title:"Additional information",slug:"additional-information"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Datacube Documentation",frontmatter:{},regularPath:"/documentation/1.0/datacubes/",relativePath:"documentation/1.0/datacubes/README.md",key:"v-f5de2fb4",path:"/documentation/1.0/datacubes/",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{frontmatter:{},regularPath:"/documentation/1.0/developers/api/",relativePath:"documentation/1.0/developers/api/README.md",key:"v-654015de",path:"/documentation/1.0/developers/api/",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO error codes",frontmatter:{},regularPath:"/documentation/1.0/developers/api/errors.html",relativePath:"documentation/1.0/developers/api/errors.md",key:"v-8d587926",path:"/documentation/1.0/developers/api/errors.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{frontmatter:{fullpage:!0,stripCSS:!0},regularPath:"/documentation/1.0/developers/api/reference.html",relativePath:"documentation/1.0/developers/api/reference.md",key:"v-dc734f12",path:"/documentation/1.0/developers/api/reference.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Getting started for service (back-end) providers",frontmatter:{},regularPath:"/documentation/1.0/developers/backends/getting-started.html",relativePath:"documentation/1.0/developers/backends/getting-started.md",key:"v-1772ad2d",path:"/documentation/1.0/developers/backends/getting-started.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Architecture",frontmatter:{},regularPath:"/documentation/1.0/developers/arch.html",relativePath:"documentation/1.0/developers/arch.md",key:"v-75018026",path:"/documentation/1.0/developers/arch.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Performance guide for openEO backends",frontmatter:{},regularPath:"/documentation/1.0/developers/backends/performance.html",relativePath:"documentation/1.0/developers/backends/performance.md",key:"v-253cefad",path:"/documentation/1.0/developers/backends/performance.html",headers:[{level:2,title:"openEO API vision on performance & scalability",slug:"openeo-api-vision-on-performance-scalability"},{level:3,title:"Bringing the processing to the data",slug:"bringing-the-processing-to-the-data"},{level:3,title:"Datacube processing",slug:"datacube-processing"},{level:2,title:"Process graph execution",slug:"process-graph-execution"},{level:2,title:"Performance FAQ",slug:"performance-faq"},{level:3,title:"I have a highly optimized workflow, can openEO expose it?",slug:"i-have-a-highly-optimized-workflow-can-openeo-expose-it"},{level:3,title:"Can openEO be as fast as a hand-written workflow?",slug:"can-openeo-be-as-fast-as-a-hand-written-workflow"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Getting started with openEO and Xarray and Dask",frontmatter:{},regularPath:"/documentation/1.0/developers/backends/xarray.html",relativePath:"documentation/1.0/developers/backends/xarray.md",key:"v-2840d4fe",path:"/documentation/1.0/developers/backends/xarray.html",headers:[{level:2,title:"Process Graph Parser for Python",slug:"process-graph-parser-for-python"},{level:2,title:"Python Processes for openEO",slug:"python-processes-for-openeo"},{level:2,title:"The loadcollection and saveresult process",slug:"the-load-collection-and-save-result-process"},{level:3,title:"Connection to ODC and STAC",slug:"connection-to-odc-and-stac"},{level:2,title:"openEO Client Side Processing",slug:"openeo-client-side-processing"},{level:2,title:"Adding a new process",slug:"adding-a-new-process"},{level:3,title:"Add the process spec",slug:"add-the-process-spec"},{level:3,title:"Add the process implementation",slug:"add-the-process-implementation"},{level:2,title:"HTTP REST Interface",slug:"http-rest-interface"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Getting started for client developers",frontmatter:{},regularPath:"/documentation/1.0/developers/clients/getting-started.html",relativePath:"documentation/1.0/developers/clients/getting-started.md",key:"v-1b45967e",path:"/documentation/1.0/developers/clients/getting-started.html",headers:[{level:2,title:"Client library developers",slug:"client-library-developers"},{level:2,title:"Applications and Software plugins",slug:"applications-and-software-plugins"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO Profiles",frontmatter:{},regularPath:"/documentation/1.0/developers/profiles/",relativePath:"documentation/1.0/developers/profiles/README.md",key:"v-e35c5e24",path:"/documentation/1.0/developers/profiles/",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Client library development guidelines",frontmatter:{},regularPath:"/documentation/1.0/developers/clients/library-guidelines.html",relativePath:"documentation/1.0/developers/clients/library-guidelines.md",key:"v-021062ed",path:"/documentation/1.0/developers/clients/library-guidelines.html",headers:[{level:2,title:"Conventions",slug:"conventions"},{level:3,title:"Casing",slug:"casing"},{level:3,title:"Scopes",slug:"scopes"},{level:3,title:"Scope categories",slug:"scope-categories"},{level:3,title:"Parameters",slug:"parameters"},{level:2,title:"Method mappings",slug:"method-mappings"},{level:3,title:"Scope: openEO (root category)",slug:"scope-openeo-root-category"},{level:4,title:"Parameters",slug:"parameters-2"},{level:3,title:"Scope: Connection (API category)",slug:"scope-connection-api-category"},{level:4,title:"Parameters",slug:"parameters-3"},{level:3,title:"Scope Capabilities (Content category)",slug:"scope-capabilities-content-category"},{level:4,title:"Parameters",slug:"parameters-4"},{level:3,title:"Scope: File (API category)",slug:"scope-file-api-category"},{level:4,title:"Parameters",slug:"parameters-5"},{level:3,title:"Scope: Job (API category)",slug:"scope-job-api-category"},{level:4,title:"Parameters",slug:"parameters-6"},{level:3,title:"Scope: UserProcess (API category)",slug:"scope-userprocess-api-category"},{level:3,title:"Scope: Service (API category)",slug:"scope-service-api-category"},{level:2,title:"Processes",slug:"processes"},{level:2,title:"Workflow example",slug:"workflow-example"},{level:3,title:"R (functional style)",slug:"r-functional-style"},{level:3,title:"Python (mixed style)",slug:"python-mixed-style"},{level:3,title:"Java (object oriented style)",slug:"java-object-oriented-style"},{level:3,title:"PHP (procedural style)",slug:"php-procedural-style"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"API Profiles",frontmatter:{},regularPath:"/documentation/1.0/developers/profiles/api.html",relativePath:"documentation/1.0/developers/profiles/api.md",key:"v-97aa86e6",path:"/documentation/1.0/developers/profiles/api.html",headers:[{level:2,title:"Requirements per Profile",slug:"requirements-per-profile"},{level:3,title:"L1: Minimal",slug:"l1-minimal"},{level:4,title:"API fundamentals",slug:"api-fundamentals"},{level:4,title:"Well-known Discovery",slug:"well-known-discovery"},{level:4,title:"Capabilities",slug:"capabilities"},{level:4,title:"File Formats",slug:"file-formats"},{level:4,title:"Authentication",slug:"authentication"},{level:4,title:"Pre-defined Processes",slug:"pre-defined-processes"},{level:4,title:"Collections",slug:"collections"},{level:4,title:"Data Processing",slug:"data-processing"},{level:3,title:"L1A: Minimal - Synchronous Processing",slug:"l1a-minimal-synchronous-processing"},{level:4,title:"Synchronous Processing",slug:"synchronous-processing"},{level:3,title:"L1B: Minimal - Batch Jobs",slug:"l1b-minimal-batch-jobs"},{level:4,title:"Batch Jobs",slug:"batch-jobs"},{level:4,title:"Batch Jobs > Results",slug:"batch-jobs-results"},{level:3,title:"L1C: Minimal - Secondary Web Services",slug:"l1c-minimal-secondary-web-services"},{level:4,title:"Secondary Web Service Discovery",slug:"secondary-web-service-discovery"},{level:4,title:"Secondary Web Services",slug:"secondary-web-services"},{level:3,title:"L2: Recommended",slug:"l2-recommended"},{level:4,title:"API fundamentals",slug:"api-fundamentals-2"},{level:4,title:"Well-known Discovery",slug:"well-known-discovery-2"},{level:4,title:"Capabilities",slug:"capabilities-2"},{level:4,title:"File Formats",slug:"file-formats-2"},{level:4,title:"Authentication",slug:"authentication-2"},{level:4,title:"User Account",slug:"user-account"},{level:4,title:"Pre-defined Processes",slug:"pre-defined-processes-2"},{level:4,title:"Collections",slug:"collections-2"},{level:4,title:"User-defined processes",slug:"user-defined-processes"},{level:4,title:"Data Processing",slug:"data-processing-2"},{level:4,title:"Batch Jobs",slug:"batch-jobs-2"},{level:4,title:"Batch Jobs > Logs",slug:"batch-jobs-logs"},{level:4,title:"Batch Jobs > Results",slug:"batch-jobs-results-2"},{level:4,title:"Synchronous Processing",slug:"synchronous-processing-2"},{level:3,title:"L3: Advanced",slug:"l3-advanced"},{level:4,title:"API fundamentals",slug:"api-fundamentals-3"},{level:4,title:"Well-known Discovery",slug:"well-known-discovery-3"},{level:4,title:"Conformance Classes",slug:"conformance-classes"},{level:4,title:"Authentication",slug:"authentication-3"},{level:4,title:"Pre-defined Processes",slug:"pre-defined-processes-3"},{level:4,title:"Collections",slug:"collections-3"},{level:4,title:"User-defined processes",slug:"user-defined-processes-2"},{level:4,title:"Validation",slug:"validation"},{level:4,title:"Batch Jobs",slug:"batch-jobs-3"},{level:4,title:"Batch Jobs > Logs",slug:"batch-jobs-logs-2"},{level:4,title:"Batch Jobs > Estimates",slug:"batch-jobs-estimates"},{level:4,title:"Batch Jobs > Results",slug:"batch-jobs-results-3"},{level:4,title:"Synchronous Processing",slug:"synchronous-processing-3"},{level:3,title:"L3-UDF: UDF",slug:"l3-udf-udf"},{level:4,title:"UDF Runtimes",slug:"udf-runtimes"},{level:3,title:"L3-FS: File Storage",slug:"l3-fs-file-storage"},{level:4,title:"File Storage",slug:"file-storage"},{level:3,title:"L3-SWS: Secondary Web Services",slug:"l3-sws-secondary-web-services"},{level:4,title:"Secondary Web Service Discovery",slug:"secondary-web-service-discovery-2"},{level:4,title:"Secondary Web Services",slug:"secondary-web-services-2"},{level:3,title:"L4: Above and Beyond",slug:"l4-above-and-beyond"},{level:4,title:"Secondary Web Services",slug:"secondary-web-services-3"},{level:4,title:"Secondary Web Services > Logs",slug:"secondary-web-services-logs"},{level:4,title:"Batch Jobs",slug:"batch-jobs-4"},{level:4,title:"Batch Jobs > Estimates",slug:"batch-jobs-estimates-2"},{level:4,title:"Batch Jobs > Results",slug:"batch-jobs-results-4"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Process Profiles",frontmatter:{},regularPath:"/documentation/1.0/developers/profiles/processes.html",relativePath:"documentation/1.0/developers/profiles/processes.md",key:"v-04d2236d",path:"/documentation/1.0/developers/profiles/processes.html",headers:[{level:2,title:"Requirements per Profile",slug:"requirements-per-profile"},{level:3,title:"L1: Minimal",slug:"l1-minimal"},{level:3,title:"L2: Recommended",slug:"l2-recommended"},{level:3,title:"L2A: Recommended Raster",slug:"l2a-recommended-raster"},{level:3,title:"L2B: Recommended Vector",slug:"l2b-recommended-vector"},{level:3,title:"L2-Date: Date & Time manipulation",slug:"l2-date-date-time-manipulation"},{level:3,title:"L2-Text: Text manipulation",slug:"l2-text-text-manipulation"},{level:3,title:"L3: Advanced",slug:"l3-advanced"},{level:3,title:"L3-ML: Machine Learning",slug:"l3-ml-machine-learning"},{level:3,title:"L3-UDF: User-Defined Functions",slug:"l3-udf-user-defined-functions"},{level:3,title:"L3-Clim: Cimatology",slug:"l3-clim-cimatology"},{level:3,title:"L3-ARD: Analysis-Ready Data",slug:"l3-ard-analysis-ready-data"},{level:3,title:"L4: Above and Beyond",slug:"l4-above-and-beyond"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"JavaScript Client",frontmatter:{},regularPath:"/documentation/1.0/javascript/",relativePath:"documentation/1.0/javascript/index.md",key:"v-1a823cb0",path:"/documentation/1.0/javascript/",headers:[{level:2,title:"Installation",slug:"installation"},{level:2,title:"Exploring a back-end",slug:"exploring-a-back-end"},{level:3,title:"Collections",slug:"collections"},{level:3,title:"Processes",slug:"processes"},{level:2,title:"Authentication",slug:"authentication"},{level:3,title:"Basic Authentication",slug:"basic-authentication"},{level:3,title:"OpenID Connect Authentication",slug:"openid-connect-authentication"},{level:2,title:"Creating a (user-defined) process",slug:"creating-a-user-defined-process"},{level:2,title:"Batch Job Management",slug:"batch-job-management"},{level:2,title:"Full Example",slug:"full-example"},{level:2,title:"User Defined Functions",slug:"user-defined-functions"},{level:2,title:"Additional Information",slug:"additional-information"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{frontmatter:{fullpage:!0,stripCSS:!0},regularPath:"/documentation/1.0/processes.html",relativePath:"documentation/1.0/processes.md",key:"v-00153acd",path:"/documentation/1.0/processes.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Glossary",frontmatter:{},regularPath:"/documentation/1.0/glossary.html",relativePath:"documentation/1.0/glossary.md",key:"v-4af2bfca",path:"/documentation/1.0/glossary.html",headers:[{level:2,title:"General terms",slug:"general-terms"},{level:2,title:"Processes",slug:"processes"},{level:2,title:"EO data (Collections)",slug:"eo-data-collections"},{level:2,title:"Spatial datacubes",slug:"spatial-datacubes"},{level:2,title:"Vector data",slug:"vector-data"},{level:2,title:"User-defined function (UDF)",slug:"user-defined-function-udf"},{level:2,title:"Data Processing modes",slug:"data-processing-modes"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Get started with the openEO Python Client Client Side Processing",frontmatter:{},regularPath:"/documentation/1.0/python/client-side-processing.html",relativePath:"documentation/1.0/python/client-side-processing.md",key:"v-9a2a2626",path:"/documentation/1.0/python/client-side-processing.html",headers:[{level:2,title:"Background",slug:"background"},{level:2,title:"Installation",slug:"installation"},{level:2,title:"Usage",slug:"usage"},{level:3,title:"STAC Collections and Items",slug:"stac-collections-and-items"},{level:3,title:"Local Collections",slug:"local-collections"},{level:3,title:"Local Processing",slug:"local-processing"},{level:2,title:"Client-Side Processing Example Notebooks",slug:"client-side-processing-example-notebooks"},{level:2,title:"Additional Information",slug:"additional-information"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Python Client",frontmatter:{},regularPath:"/documentation/1.0/python/",relativePath:"documentation/1.0/python/index.md",key:"v-560d08d2",path:"/documentation/1.0/python/",headers:[{level:2,title:"Installation",slug:"installation"},{level:2,title:"Exploring a back-end",slug:"exploring-a-back-end"},{level:3,title:"Collections",slug:"collections"},{level:3,title:"Processes",slug:"processes"},{level:2,title:"Authentication",slug:"authentication"},{level:3,title:"Basic Authentication",slug:"basic-authentication"},{level:3,title:"OpenID Connect Authentication",slug:"openid-connect-authentication"},{level:2,title:"Working with Datacube",slug:"working-with-datacube"},{level:3,title:"Creating a Datacube",slug:"creating-a-datacube"},{level:3,title:"Applying processes",slug:"applying-processes"},{level:3,title:"Defining output format",slug:"defining-output-format"},{level:2,title:"Execution",slug:"execution"},{level:3,title:"Batch job execution",slug:"batch-job-execution"},{level:2,title:"Full Example",slug:"full-example"},{level:2,title:"User Defined Functions",slug:"user-defined-functions"},{level:2,title:"Additional Information",slug:"additional-information"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"QGIS Plugin",frontmatter:{},regularPath:"/documentation/1.0/qgis/",relativePath:"documentation/1.0/qgis/index.md",key:"v-ef2073ec",path:"/documentation/1.0/qgis/",headers:[{level:2,title:"Installation",slug:"installation"},{level:2,title:"Connecting",slug:"connecting"},{level:2,title:"Exploring a backend",slug:"exploring-a-backend"},{level:2,title:"Job Management",slug:"job-management"},{level:3,title:"Creating new Jobs",slug:"creating-new-jobs"},{level:3,title:"Adapting existing Jobs",slug:"adapting-existing-jobs"},{level:4,title:"Process Argument Helper",slug:"process-argument-helper"},{level:2,title:"Service Management",slug:"service-management"},{level:2,title:"Additional Information",slug:"additional-information"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"R Client",frontmatter:{},regularPath:"/documentation/1.0/r/",relativePath:"documentation/1.0/r/index.md",key:"v-592eaa86",path:"/documentation/1.0/r/",headers:[{level:2,title:"Useful links",slug:"useful-links"},{level:2,title:"Installation",slug:"installation"},{level:2,title:"Exploring a back-end",slug:"exploring-a-back-end"},{level:3,title:"Collections",slug:"collections"},{level:3,title:"Processes",slug:"processes"},{level:2,title:"Authentication",slug:"authentication"},{level:3,title:"Basic Authentication",slug:"basic-authentication"},{level:3,title:"OpenID Connect Authentication",slug:"openid-connect-authentication"},{level:2,title:"Creating a (user-defined) process",slug:"creating-a-user-defined-process"},{level:2,title:"Batch Job Management",slug:"batch-job-management"},{level:2,title:"Full Example",slug:"full-example"},{level:2,title:"User Defined Functions",slug:"user-defined-functions"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"User-defined functions",frontmatter:{},regularPath:"/documentation/1.0/udfs.html",relativePath:"documentation/1.0/udfs.md",key:"v-ffc79ec2",path:"/documentation/1.0/udfs.html",headers:[{level:2,title:"Users",slug:"users"},{level:3,title:"JavaScript",slug:"javascript"},{level:3,title:"Python",slug:"python"},{level:3,title:"QGIS",slug:"qgis"},{level:3,title:"R",slug:"r"},{level:3,title:"Web Editor",slug:"web-editor"},{level:2,title:"Back-ends",slug:"back-ends"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Contributor Code of Conduct",frontmatter:{},regularPath:"/documentation/code-of-conduct.html",relativePath:"documentation/code-of-conduct.md",key:"v-c71b5aa6",path:"/documentation/code-of-conduct.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"IEEE IGARRS 2021 HD-3: Hands-on openEO: access cloud platforms using your preferred programming language",frontmatter:{},regularPath:"/events/igarrs2021.html",relativePath:"events/igarrs2021.md",key:"v-186cd6ed",path:"/events/igarrs2021.html",headers:[{level:2,title:"Agenda",slug:"agenda"},{level:2,title:"Python client",slug:"python-client"},{level:3,title:"Logging in",slug:"logging-in"},{level:3,title:"openEO in Python intro",slug:"openeo-in-python-intro"},{level:2,title:"R client",slug:"r-client"},{level:2,title:"openEO user interfaces",slug:"openeo-user-interfaces"},{level:2,title:"Use cases",slug:"use-cases"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Software Development Guidelines",frontmatter:{},regularPath:"/documentation/software-guidelines.html",relativePath:"documentation/software-guidelines.md",key:"v-1005bb66",path:"/documentation/software-guidelines.html",headers:[{level:2,title:"Software quality guidelines",slug:"software-quality-guidelines"},{level:2,title:"Software documentation guidelines",slug:"software-documentation-guidelines"},{level:2,title:"Software review",slug:"software-review"},{level:2,title:"Test-driven development",slug:"test-driven-development"},{level:2,title:"Continuous integration",slug:"continuous-integration"},{level:2,title:"Additional guidelines",slug:"additional-guidelines"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Welcome to openEO!",frontmatter:{news:!0,title:"Welcome to openEO!",date:"2017-12-05T00:00:00.000Z",author:"Edzer Pebesma"},regularPath:"/news/2017-12-05-welcome.html",relativePath:"news/2017-12-05-welcome.md",key:"v-0ee3f026",path:"/news/2017-12-05-welcome.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"First week of intensive collaboration: Dec 4-6, 2017",frontmatter:{news:!0,title:"First week of intensive collaboration: Dec 4-6, 2017",date:"2017-12-18T00:00:00.000Z",author:"Edzer Pebesma"},regularPath:"/news/2017-12-18-VITO_meeting.html",relativePath:"news/2017-12-18-VITO_meeting.md",key:"v-2997b752",path:"/news/2017-12-18-VITO_meeting.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Second week of intensive collaboration: Jan 22-24, 2018",frontmatter:{news:!0,title:"Second week of intensive collaboration: Jan 22-24, 2018",date:"2018-01-31T00:00:00.000Z",author:"Marius Appel"},regularPath:"/news/2018-01-31-WWU_meeting.html",relativePath:"news/2018-01-31-WWU_meeting.md",key:"v-24966ce6",path:"/news/2018-01-31-WWU_meeting.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO proves its concept",frontmatter:{news:!0,title:"openEO proves its concept",date:"2018-03-17T00:00:00.000Z",author:"Edzer Pebesma, the openEO consortium"},regularPath:"/news/2018-03-15-poc.html",relativePath:"news/2018-03-15-poc.md",key:"v-4fe4e126",path:"/news/2018-03-15-poc.html",headers:[{level:2,title:"The problem",slug:"the-problem"},{level:2,title:"Why an API?",slug:"why-an-api"},{level:2,title:"First results",slug:"first-results"},{level:2,title:"The three use cases",slug:"the-three-use-cases"},{level:2,title:"Links to the client and back-end implementations",slug:"links-to-the-client-and-back-end-implementations"},{level:2,title:"Proof-of-concept videos",slug:"proof-of-concept-videos"},{level:3,title:"R client and WCPS back-end, use case 1",slug:"r-client-and-wcps-back-end-use-case-1"},{level:3,title:"Grass GIS back-end, use cases 1, 2 and 3",slug:"grass-gis-back-end-use-cases-1-2-and-3"},{level:3,title:"R client and R back-end, use-case 1",slug:"r-client-and-r-back-end-use-case-1"},{level:3,title:"R client and R back-end, use case 3",slug:"r-client-and-r-back-end-use-case-3"},{level:3,title:"openEO Web Editor (JS client) with three back-ends (use case 1)",slug:"openeo-web-editor-js-client-with-three-back-ends-use-case-1"},{level:3,title:"openEO Web Editor (JS client) with R back-end (use case 3)",slug:"openeo-web-editor-js-client-with-r-back-end-use-case-3"},{level:3,title:"Python client with GeoPySpark back-end (use case 1)",slug:"python-client-with-geopyspark-back-end-use-case-1"},{level:3,title:"openEO Web Editor (JS client) with Google Earth Engine back-end (use case 1)",slug:"openeo-web-editor-js-client-with-google-earth-engine-back-end-use-case-1"},{level:2,title:"Links to documents",slug:"links-to-documents"},{level:2,title:"Next steps",slug:"next-steps"},{level:2,title:"Getting involved",slug:"getting-involved"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"User Requirements Survey for openEO launched",frontmatter:{news:!0,title:"User Requirements Survey for openEO launched",date:"2018-05-23T00:00:00.000Z",author:"Sarah Carter"},regularPath:"/news/2018-05-23-user-requirements-survey-launched.html",relativePath:"news/2018-05-23-user-requirements-survey-launched.md",key:"v-f9778ae6",path:"/news/2018-05-23-user-requirements-survey-launched.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO year one review meeting",frontmatter:{news:!0,title:"openEO year one review meeting",date:"2018-10-30T00:00:00.000Z",author:"Matthias Schramm"},regularPath:"/news/2018-10-30-year-one-review-meeting.html",relativePath:"news/2018-10-30-year-one-review-meeting.md",key:"v-d2a018a6",path:"/news/2018-10-30-year-one-review-meeting.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"H2020 EO Big Data Hackathon Nov 7-8",frontmatter:{news:!0,title:"H2020 EO Big Data Hackathon Nov 7-8",date:"2019-10-07T00:00:00.000Z",author:"Edzer Pebesma"},regularPath:"/news/2019-10-07-EO-big-data-hackaton.html",relativePath:"news/2019-10-07-EO-big-data-hackaton.md",key:"v-9ddae032",path:"/news/2019-10-07-EO-big-data-hackaton.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Lessons learned while developing the openEO API",frontmatter:{news:!0,title:"Lessons learned while developing the openEO API",date:"2020-07-31T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2020-07-31-lessons-learned.html",relativePath:"news/2020-07-31-lessons-learned.md",key:"v-3f85032d",path:"/news/2020-07-31-lessons-learned.html",headers:[{level:2,title:"1. Collection Names",slug:"_1-collection-names"},{level:2,title:"2. Other Names",slug:"_2-other-names"},{level:2,title:"3. Chunked Collections",slug:"_3-chunked-collections"},{level:2,title:"4. What to specify?",slug:"_4-what-to-specify"},{level:3,title:"File Formats",slug:"file-formats"},{level:2,title:"5. Authentication",slug:"_5-authentication"},{level:2,title:"6. Debugging Experience",slug:"_6-debugging-experience"},{level:2,title:"7. Defining interoperable Processes",slug:"_7-defining-interoperable-processes"},{level:2,title:"Conclusion",slug:"conclusion"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Stable release of the openEO API and Processes (v1.0.0)",frontmatter:{news:!0,title:"Stable release of the openEO API and Processes (v1.0.0)",date:"2020-07-31T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2020-07-31-openeo-api-released.html",relativePath:"news/2020-07-31-openeo-api-released.md",key:"v-2fcee9ad",path:"/news/2020-07-31-openeo-api-released.html",headers:[{level:2,title:"Processes",slug:"processes"},{level:2,title:"STAC and OGC APIs",slug:"stac-and-ogc-apis"},{level:2,title:"User-defined Functions (UDFs)",slug:"user-defined-functions-udfs"},{level:2,title:"Other improvements",slug:"other-improvements"},{level:2,title:"Limitations",slug:"limitations"},{level:2,title:"Next steps",slug:"next-steps"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO API v0.4.0 released",frontmatter:{news:!0,title:"openEO API v0.4.0 released",date:"2019-03-07T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2019-03-07-openeo-api-040.html",relativePath:"news/2019-03-07-openeo-api-040.md",key:"v-45d803ab",path:"/news/2019-03-07-openeo-api-040.html",headers:[{level:2,title:"New process catalogue and process graph changes",slug:"new-process-catalogue-and-process-graph-changes"},{level:2,title:"Other improvements",slug:"other-improvements"},{level:2,title:"Next steps",slug:"next-steps"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO Virtual User Workshop",frontmatter:{news:!0,title:"openEO Virtual User Workshop",date:"2020-09-02T00:00:00.000Z",author:"Matthias Schramm"},regularPath:"/news/2020-09-02-openeo-user-workshop.html",relativePath:"news/2020-09-02-openeo-user-workshop.md",key:"v-525dec3e",path:"/news/2020-09-02-openeo-user-workshop.html",headers:[{level:3,title:"UPDATE:",slug:"update"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO API v1.0.1 released",frontmatter:{news:!0,title:"openEO API v1.0.1 released",date:"2020-11-30T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2020-11-30-openeo-api-101-released.html",relativePath:"news/2020-11-30-openeo-api-101-released.md",key:"v-0e5e57cd",path:"/news/2020-11-30-openeo-api-101-released.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO API v1.1.0 released",frontmatter:{news:!0,title:"openEO API v1.1.0 released",date:"2021-05-17T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2021-05-17-openeo-api-110-released.html",relativePath:"news/2021-05-17-openeo-api-110-released.md",key:"v-6e6b7e2d",path:"/news/2021-05-17-openeo-api-110-released.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO PSC meetings",frontmatter:{news:!0,title:"openEO PSC meetings",date:"2022-04-08T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2022-04-08-psc-meetings.html",relativePath:"news/2022-04-08-psc-meetings.md",key:"v-1227575e",path:"/news/2022-04-08-psc-meetings.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"R Client on CRAN",frontmatter:{news:!0,title:"R Client on CRAN",date:"2021-11-08T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2021-11-08-r-client-on-cran.html",relativePath:"news/2021-11-08-r-client-on-cran.md",key:"v-06e0a8ca",path:"/news/2021-11-08-r-client-on-cran.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Monthly openEO community meeting",frontmatter:{news:!0,title:"Monthly openEO community meeting",date:"2022-07-07T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2022-07-07-monthly-dev-calls.html",relativePath:"news/2022-07-07-monthly-dev-calls.md",key:"v-00d62ee6",path:"/news/2022-07-07-monthly-dev-calls.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"R Client v1.2.0 has been released",frontmatter:{news:!0,title:"R Client v1.2.0 has been released",date:"2022-05-12T00:00:00.000Z",author:"Matthias Mohr, Florian Lahn"},regularPath:"/news/2022-05-12-r-client-v120.html",relativePath:"news/2022-05-12-r-client-v120.md",key:"v-59d340ad",path:"/news/2022-05-12-r-client-v120.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"R Client v1.3.0 has been released",frontmatter:{news:!0,title:"R Client v1.3.0 has been released",date:"2022-11-17T00:00:00.000Z",author:"Matthias Mohr, Peter J. Zellner, Florian Lahn"},regularPath:"/news/2022-11-17-r-client-v130.html",relativePath:"news/2022-11-17-r-client-v130.md",key:"v-221bfb8d",path:"/news/2022-11-17-r-client-v130.html",headers:[{level:2,title:"Better support for sf",slug:"better-support-for-sf"},{level:2,title:"New Vignettes",slug:"new-vignettes"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"New releases for openEO API and openEO Processes, focus on vector data",frontmatter:{news:!0,title:"New releases for openEO API and openEO Processes, focus on vector data",date:"2023-05-25T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2023-05-25-new-openeo-versions-120-200rc1%20copy.html",relativePath:"news/2023-05-25-new-openeo-versions-120-200rc1 copy.md",key:"v-3eeef04a",path:"/news/2023-05-25-new-openeo-versions-120-200rc1%20copy.html",headers:[{level:2,title:"openEO API v1.2.0",slug:"openeo-api-v1-2-0"},{level:2,title:"openEO Processes v2.0.0-rc.1",slug:"openeo-processes-v2-0-0-rc-1"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO submitted to OGC for consideration as an OGC community standard",frontmatter:{news:!0,title:"openEO submitted to OGC for consideration as an OGC community standard",date:"2023-12-06T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2023-12-06-openeo-submitted-to-ogc.html",relativePath:"news/2023-12-06-openeo-submitted-to-ogc.md",key:"v-857a96a6",path:"/news/2023-12-06-openeo-submitted-to-ogc.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"OGC seeks public comment on the adoption of openEO as a Community Standard",frontmatter:{news:!0,title:"OGC seeks public comment on the adoption of openEO as a Community Standard",date:"2024-02-06T00:00:00.000Z",author:"Matthias Mohr"},regularPath:"/news/2024-02-06-openeo-ogc-rfc.html",relativePath:"news/2024-02-06-openeo-ogc-rfc.md",key:"v-10d9ffb7",path:"/news/2024-02-06-openeo-ogc-rfc.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"MOOC Cubes and Clouds - open for registration",frontmatter:{news:!0,title:"MOOC Cubes and Clouds - open for registration",date:"2024-03-22T00:00:00.000Z",author:"Peter Zellner"},regularPath:"/news/2024-03-22_mooc_cubeandclouds.html",relativePath:"news/2024-03-22_mooc_cubeandclouds.md",key:"v-d5007282",path:"/news/2024-03-22_mooc_cubeandclouds.html",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"openEO Project Steering Committee",frontmatter:{},regularPath:"/psc.html",relativePath:"psc.md",key:"v-64c18f4d",path:"/psc.html",headers:[{level:2,title:"Members",slug:"members"},{level:2,title:"Detailed Process",slug:"detailed-process"},{level:3,title:"When is Vote Required?",slug:"when-is-vote-required"},{level:3,title:"Final remarks",slug:"final-remarks"},{level:2,title:"Committee Membership",slug:"committee-membership"},{level:3,title:"Adding Members",slug:"adding-members"},{level:3,title:"Stepping Down",slug:"stepping-down"},{level:2,title:"History",slug:"history"}],codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"Software",frontmatter:{},regularPath:"/software.html",relativePath:"software.md",key:"v-9adb302a",path:"/software.html",headers:[{level:2,title:"Clients",slug:"clients"},{level:2,title:"Back-ends",slug:"back-ends"},{level:2,title:"Specification",slug:"specification"},{level:2,title:"Ecosystem",slug:"ecosystem"}],lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}},{title:"News",frontmatter:{sidebar:!1},regularPath:"/news/",relativePath:"news/README.md",key:"v-8850e2c4",path:"/news/",lastUpdated:"7/26/2024, 6:48:28 PM",lastUpdatedTimestamp:1722019708e3,codeSwitcherOptions:{groups:{default:{py:"Python",r:"R",js:"JavaScript"}}}}],themeConfig:{apiVersion:"1.2.0",versions:[{folder:"1.0",path:"/documentation/1.0/",title:"1.x",apiTag:"1.2.0",processesTag:"2.0.0-rc.1",apiVersions:["1.0.0","1.0.1","1.1.0","1.2.0"],userNav:[{text:"Introduction",link:"index.html"},{text:"Glossary",link:"glossary.html"},{text:"Datacubes",link:"datacubes.html"},{text:"Getting Started",items:[{text:"JavaScript",link:"javascript/index.html"},{text:"Python",link:"python/index.html"},{text:"QGIS",link:"qgis/index.html"},{text:"R",link:"r/index.html"},{text:"Client-Side Processing (Python)",link:"python/client-side-processing.html"}]},{text:"Processes",link:"processes.html"},{text:"Cookbook",link:"cookbook/index.html"},{text:"Authentication",link:"authentication.html"},{text:"UDFs",link:"udfs.html"}],devNav:[{text:"Introduction",link:"developers/index.html"},{text:"Glossary",link:"glossary.html"},{text:"Architecture",link:"developers/arch.html"},{text:"Service Providers",items:[{text:"Getting Started",link:"developers/backends/getting-started.html"},{text:"Performance Guide",link:"developers/backends/performance.html"},{text:"Xarray / Dask Guide",link:"developers/backends/xarray.html"},{text:"Profiles",link:"developers/profiles/index.html"}]},{text:"Client Developers",items:[{text:"Getting Started",link:"developers/clients/getting-started.html"},{text:"Library Guidelines",link:"developers/clients/library-guidelines.html"}]},{text:"API",items:[{text:"Reference",link:"developers/api/reference.html"},{text:"Profiles",link:"developers/profiles/api.html"}]},{text:"Processes",items:[{text:"Reference",link:"processes.html"},{text:"Profiles",link:"developers/profiles/processes.html"}]},{text:"Error Codes",link:"developers/api/errors.html"},{text:"Authentication",link:"authentication.html"},{text:"UDFs",link:"udfs.html"}]},{folder:"0.4",path:"/documentation/0.4/",title:"0.4",apiTag:"0.4.2",apiFormat:"json",processesTag:"0.4.2",apiVersions:["0.4.0","0.4.1","0.4.2"],userNav:[{text:"Getting Started",link:"getting-started.html"},{text:"Glossary",link:"glossary.html"},{text:"Processes",link:"processes.html"},{text:"UDFs",link:"udfs.html"}],devNav:[{text:"Introduction",link:"developers/index.html"},{text:"Glossary",link:"glossary.html"},{text:"Architecture",link:"developers/arch.html"},{text:"Service Providers",items:[{text:"Getting Started",link:"developers/backends/getting-started.html"},{text:"UDFs",link:"developers/backends/udfs.html"}]},{text:"Client Developers",items:[{text:"Getting Started",link:"developers/clients/getting-started.html"},{text:"Library Guidelines",link:"developers/clients/library-guidelines.html"}]},{text:"API",items:[{text:"Specification",link:"developers/api/reference.html"},{text:"Further documentation",link:"developers/api/index.html"}]},{text:"Processes",link:"processes.html"},{text:"Error Codes",link:"developers/api/errors.html"},{text:"Examples",link:"developers/examples/"}]}],defaultVersion:0,docPath:"/documentation/1.0/",logo:"/images/openeo_navbar_logo.png",editLinks:!0,docsRepo:"Open-EO/openeo.org",algolia:{appId:"3J2STFK847",apiKey:"b12d6cb143c2ddadfa8989c962d1a049",indexName:"openeo"},nav:[{text:"Home",link:"/"},{text:"About",link:"/about.html"},{text:"News",link:"/news/"},{text:"Software",link:"/software.html"},{text:"Services / Hub",link:"https://hub.openeo.org"},{text:"User Documentation",userNav:!0,items:[]},{text:"Developers",devNav:!0,items:[]},{text:"PSC",link:"/psc.html"},{text:"Contact",link:"/contact.html"}],sidebar:"auto"}},Lt=n(148),It=Lt.themeConfig.versions[Lt.themeConfig.defaultVersion];"undefined"!=typeof window&&(window.global=window);n(149);r.a.component("ApiSpec",()=>n.e(39).then(n.bind(null,479))),r.a.component("Channels",()=>Promise.all([n.e(0),n.e(27)]).then(n.bind(null,480))),r.a.component("ErrorCodes",()=>n.e(19).then(n.bind(null,481))),r.a.component("InlineFrame",()=>Promise.all([n.e(0),n.e(28)]).then(n.bind(null,482))),r.a.component("News",()=>n.e(40).then(n.bind(null,483))),r.a.component("ProcessesSpec",()=>Promise.all([n.e(0),n.e(26)]).then(n.bind(null,484))),r.a.component("Badge",()=>Promise.all([n.e(0),n.e(4)]).then(n.bind(null,490)));n(150),n(151);r.a.component("CodeSwitcher",()=>n.e(53).then(n.bind(null,485)));var Dt=[({router:e,Vue:t})=>{t.config.ignoredElements=["redoc"],e.addRoutes([{path:"/documentation",redirect:It.path},{path:"/about",redirect:"about.html"},{path:"/software",redirect:"software.html"},{path:"/contact",redirect:"contact.html"},{path:"/glossary",redirect:It.path+"glossary.html"},{path:"/documentation/1.0/developers/backends/opendatacube.html",redirect:"/documentation/1.0/developers/backends/xarray.html"}])},{},({Vue:e})=>{e.mixin({computed:{$dataBlock(){return this.$options.__data__block__}}})},{},{},{},{},{},({Vue:e})=>{e.component("CodeCopy",$t)}],Nt=[];class Ft extends class{constructor(){this.store=new r.a({data:{state:{}}})}$get(e){return this.store.state[e]}$set(e,t){r.a.set(this.store.state,e,t)}$emit(...e){this.store.$emit(...e)}$on(...e){this.store.$on(...e)}}{}Object.assign(Ft.prototype,{getPageAsyncComponent:lt,getLayoutAsyncComponent:ct,getAsyncComponent:ut,getVueComponent:pt});var Jt={install(e){const t=new Ft;e.$vuepress=t,e.prototype.$vuepress=t}};function Bt(e,t){const n=t.toLowerCase();return e.options.routes.some(e=>e.path.toLowerCase()===n)}var Vt={props:{pageKey:String,slotKey:{type:String,default:"default"}},render(e){const t=this.pageKey||this.$parent.$page.key;return ft("pageKey",t),r.a.component(t)||r.a.component(t,lt(t)),r.a.component(t)?e(t):e("")}},zt={functional:!0,props:{slotKey:String,required:!0},render:(e,{props:t,slots:n})=>e("div",{class:["content__"+t.slotKey]},n()[t.slotKey])},qt={computed:{openInNewWindowTitle(){return this.$themeLocaleConfig.openNewWindowText||"(opens new window)"}}},Gt=(n(152),n(153),Object(jt.a)(qt,(function(){var e=this._self._c;return e("span",[e("svg",{staticClass:"icon outbound",attrs:{xmlns:"http://www.w3.org/2000/svg","aria-hidden":"true",focusable:"false",x:"0px",y:"0px",viewBox:"0 0 100 100",width:"15",height:"15"}},[e("path",{attrs:{fill:"currentColor",d:"M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"}}),this._v(" "),e("polygon",{attrs:{fill:"currentColor",points:"45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"}})]),this._v(" "),e("span",{staticClass:"sr-only"},[this._v(this._s(this.openInNewWindowTitle))])])}),[],!1,null,null,null).exports),Wt={functional:!0,render(e,{parent:t,children:n}){if(t._isMounted)return n;t.$once("hook:mounted",()=>{t.$forceUpdate()})}};r.a.config.productionTip=!1,r.a.use(Ge),r.a.use(Jt),r.a.mixin(function(e,t,n=r.a){!function(e){e.locales&&Object.keys(e.locales).forEach(t=>{e.locales[t].path=t});Object.freeze(e)}(t),n.$vuepress.$set("siteData",t);const o=new(e(n.$vuepress.$get("siteData"))),a=Object.getOwnPropertyDescriptors(Object.getPrototypeOf(o)),i={};return Object.keys(a).reduce((e,t)=>(t.startsWith("$")&&(e[t]=a[t].get),e),i),{computed:i}}(e=>class{setPage(e){this.__page=e}get $site(){return e}get $themeConfig(){return this.$site.themeConfig}get $frontmatter(){return this.$page.frontmatter}get $localeConfig(){const{locales:e={}}=this.$site;let t,n;for(const r in e)"/"===r?n=e[r]:0===this.$page.path.indexOf(r)&&(t=e[r]);return t||n||{}}get $siteTitle(){return this.$localeConfig.title||this.$site.title||""}get $canonicalUrl(){const{canonicalUrl:e}=this.$page.frontmatter;return"string"==typeof e&&e}get $title(){const e=this.$page,{metaTitle:t}=this.$page.frontmatter;if("string"==typeof t)return t;const n=this.$siteTitle,r=e.frontmatter.home?null:e.frontmatter.title||e.title;return n?r?r+" | "+n:n:r||"VuePress"}get $description(){const e=function(e){if(e){const t=e.filter(e=>"description"===e.name)[0];if(t)return t.content}}(this.$page.frontmatter.meta);return e||(this.$page.frontmatter.description||this.$localeConfig.description||this.$site.description||"")}get $lang(){return this.$page.frontmatter.lang||this.$localeConfig.lang||"en-US"}get $localePath(){return this.$localeConfig.path||"/"}get $themeLocaleConfig(){return(this.$site.themeConfig.locales||{})[this.$localePath]||{}}get $page(){return this.__page?this.__page:function(e,t){for(let n=0;nn||(e.hash?!r.a.$vuepress.$get("disableScrollBehavior")&&{selector:decodeURIComponent(e.hash)}:{x:0,y:0})});!function(e){e.beforeEach((t,n,r)=>{if(Bt(e,t.path))r();else if(/(\/|\.html)$/.test(t.path))if(/\/$/.test(t.path)){const n=t.path.replace(/\/$/,"")+".html";Bt(e,n)?r(n):r()}else r();else{const n=t.path+"/",o=t.path+".html";Bt(e,o)?r(o):Bt(e,n)?r(n):r()}})}(n);const o={};try{await Promise.all(Dt.filter(e=>"function"==typeof e).map(t=>t({Vue:r.a,options:o,router:n,siteData:Mt,isServer:e})))}catch(e){console.error(e)}return{app:new r.a(Object.assign(o,{router:n,render:e=>e("div",{attrs:{id:"app"}},[e("RouterView",{ref:"layout"}),e("div",{class:"global-ui"},Nt.map(t=>e(t)))])})),router:n}}(!1).then(({app:e,router:t})=>{t.onReady(()=>{e.$mount("#app")})})}]); \ No newline at end of file diff --git a/contact.html b/contact.html index b30b6a8f2..d9c5cb064 100644 --- a/contact.html +++ b/contact.html @@ -8,7 +8,7 @@ - + @@ -211,6 +211,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/0.4/developers/api/errors.html b/documentation/0.4/developers/api/errors.html index 2a489f481..b51c97e90 100644 --- a/documentation/0.4/developers/api/errors.html +++ b/documentation/0.4/developers/api/errors.html @@ -8,7 +8,7 @@ - + @@ -168,6 +168,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/0.4/developers/api/index.html b/documentation/0.4/developers/api/index.html index 97afe3451..8e284aa52 100644 --- a/documentation/0.4/developers/api/index.html +++ b/documentation/0.4/developers/api/index.html @@ -8,7 +8,7 @@ - + @@ -145,6 +145,6 @@

- + diff --git a/documentation/0.4/developers/api/reference.html b/documentation/0.4/developers/api/reference.html index a77d8fbe4..a4e354729 100644 --- a/documentation/0.4/developers/api/reference.html +++ b/documentation/0.4/developers/api/reference.html @@ -8,7 +8,7 @@ - + @@ -145,6 +145,6 @@

- + diff --git a/documentation/0.4/developers/arch.html b/documentation/0.4/developers/arch.html index 9f1c0a718..2416b25e7 100644 --- a/documentation/0.4/developers/arch.html +++ b/documentation/0.4/developers/arch.html @@ -8,7 +8,7 @@ - + @@ -151,6 +151,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/0.4/developers/backends/getting-started.html b/documentation/0.4/developers/backends/getting-started.html index d8cba1d63..b0b8df2bb 100644 --- a/documentation/0.4/developers/backends/getting-started.html +++ b/documentation/0.4/developers/backends/getting-started.html @@ -8,7 +8,7 @@ - + @@ -152,6 +152,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/0.4/developers/backends/udfs.html b/documentation/0.4/developers/backends/udfs.html index f70dee805..65c9dc81d 100644 --- a/documentation/0.4/developers/backends/udfs.html +++ b/documentation/0.4/developers/backends/udfs.html @@ -8,7 +8,7 @@ - + @@ -147,6 +147,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/0.4/developers/clients/getting-started.html b/documentation/0.4/developers/clients/getting-started.html index 0f86a6ddb..ee7ff66d5 100644 --- a/documentation/0.4/developers/clients/getting-started.html +++ b/documentation/0.4/developers/clients/getting-started.html @@ -8,7 +8,7 @@ - + @@ -151,6 +151,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/0.4/developers/clients/library-guidelines.html b/documentation/0.4/developers/clients/library-guidelines.html index f33cc9ddd..f451012e3 100644 --- a/documentation/0.4/developers/clients/library-guidelines.html +++ b/documentation/0.4/developers/clients/library-guidelines.html @@ -8,7 +8,7 @@ - + @@ -233,6 +233,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/0.4/developers/examples/index.html b/documentation/0.4/developers/examples/index.html index 01f46a97b..ba7bfc32f 100644 --- a/documentation/0.4/developers/examples/index.html +++ b/documentation/0.4/developers/examples/index.html @@ -8,7 +8,7 @@ - + @@ -147,6 +147,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/0.4/developers/examples/poc.html b/documentation/0.4/developers/examples/poc.html index 5f393390b..770b06c49 100644 --- a/documentation/0.4/developers/examples/poc.html +++ b/documentation/0.4/developers/examples/poc.html @@ -8,7 +8,7 @@ - + @@ -375,6 +375,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/0.4/developers/index.html b/documentation/0.4/developers/index.html index bfde403fa..76824f781 100644 --- a/documentation/0.4/developers/index.html +++ b/documentation/0.4/developers/index.html @@ -8,7 +8,7 @@ - + @@ -151,6 +151,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/0.4/getting-started.html b/documentation/0.4/getting-started.html index 34d4534ae..8977ad3f2 100644 --- a/documentation/0.4/getting-started.html +++ b/documentation/0.4/getting-started.html @@ -8,7 +8,7 @@ - + @@ -147,6 +147,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/0.4/glossary.html b/documentation/0.4/glossary.html index 7d2151a72..2c5a5d3dd 100644 --- a/documentation/0.4/glossary.html +++ b/documentation/0.4/glossary.html @@ -8,7 +8,7 @@ - + @@ -174,6 +174,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/0.4/index.html b/documentation/0.4/index.html index 9f7c291a7..18908e4ca 100644 --- a/documentation/0.4/index.html +++ b/documentation/0.4/index.html @@ -8,7 +8,7 @@ - + @@ -151,6 +151,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/0.4/processes.html b/documentation/0.4/processes.html index 39822b22b..afc9769a7 100644 --- a/documentation/0.4/processes.html +++ b/documentation/0.4/processes.html @@ -8,7 +8,7 @@ - + @@ -152,6 +152,6 @@ experimental

Note: This is the list of all processes specified by the openEO project. Back-ends implement a varying set of processes. Thus, the processes you can use at a specific back-end may derive from the specification, may include non-standardized processes and may not implement all processes listed here. Please check each back-end individually for the processes they support. The client libraries usually have a function called listProcesses or list_processes for that.

- + diff --git a/documentation/0.4/udfs.html b/documentation/0.4/udfs.html index 66508618d..a143528a3 100644 --- a/documentation/0.4/udfs.html +++ b/documentation/0.4/udfs.html @@ -8,7 +8,7 @@ - + @@ -151,6 +151,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/authentication.html b/documentation/1.0/authentication.html index 9fb82adc9..d671f5a9d 100644 --- a/documentation/1.0/authentication.html +++ b/documentation/1.0/authentication.html @@ -8,7 +8,7 @@ - + @@ -205,6 +205,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/cookbook/index.html b/documentation/1.0/cookbook/index.html index 14f734255..56aeb022a 100644 --- a/documentation/1.0/cookbook/index.html +++ b/documentation/1.0/cookbook/index.html @@ -8,7 +8,7 @@ - + @@ -746,6 +746,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/datacubes.html b/documentation/1.0/datacubes.html index c6efdc036..36f7cff9f 100644 --- a/documentation/1.0/datacubes.html +++ b/documentation/1.0/datacubes.html @@ -8,7 +8,7 @@ - + @@ -209,6 +209,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/datacubes/index.html b/documentation/1.0/datacubes/index.html index 9d0ba2b5d..1f81739a7 100644 --- a/documentation/1.0/datacubes/index.html +++ b/documentation/1.0/datacubes/index.html @@ -8,7 +8,7 @@ - + @@ -203,6 +203,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/developers/api/errors.html b/documentation/1.0/developers/api/errors.html index aaf4d26ec..d569ad3b8 100644 --- a/documentation/1.0/developers/api/errors.html +++ b/documentation/1.0/developers/api/errors.html @@ -8,7 +8,7 @@ - + @@ -207,6 +207,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/developers/api/index.html b/documentation/1.0/developers/api/index.html index 73643c7eb..f2d718978 100644 --- a/documentation/1.0/developers/api/index.html +++ b/documentation/1.0/developers/api/index.html @@ -8,7 +8,7 @@ - + @@ -207,6 +207,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/developers/api/reference.html b/documentation/1.0/developers/api/reference.html index a98f378af..12e1aca6b 100644 --- a/documentation/1.0/developers/api/reference.html +++ b/documentation/1.0/developers/api/reference.html @@ -8,7 +8,7 @@ - + @@ -201,6 +201,6 @@

- + diff --git a/documentation/1.0/developers/arch.html b/documentation/1.0/developers/arch.html index 962e3d2c1..204f4a3c9 100644 --- a/documentation/1.0/developers/arch.html +++ b/documentation/1.0/developers/arch.html @@ -8,7 +8,7 @@ - + @@ -207,6 +207,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/developers/backends/getting-started.html b/documentation/1.0/developers/backends/getting-started.html index b22f40fa1..7d6094943 100644 --- a/documentation/1.0/developers/backends/getting-started.html +++ b/documentation/1.0/developers/backends/getting-started.html @@ -8,7 +8,7 @@ - + @@ -208,6 +208,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/developers/backends/performance.html b/documentation/1.0/developers/backends/performance.html index 515b06f0f..32c5869ce 100644 --- a/documentation/1.0/developers/backends/performance.html +++ b/documentation/1.0/developers/backends/performance.html @@ -8,7 +8,7 @@ - + @@ -246,6 +246,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/developers/backends/xarray.html b/documentation/1.0/developers/backends/xarray.html index 0b600ffa5..cb7331c9a 100644 --- a/documentation/1.0/developers/backends/xarray.html +++ b/documentation/1.0/developers/backends/xarray.html @@ -8,7 +8,7 @@ - + @@ -214,6 +214,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/developers/clients/getting-started.html b/documentation/1.0/developers/clients/getting-started.html index 4a2c0552c..84f3e0043 100644 --- a/documentation/1.0/developers/clients/getting-started.html +++ b/documentation/1.0/developers/clients/getting-started.html @@ -8,7 +8,7 @@ - + @@ -207,6 +207,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/developers/clients/library-guidelines.html b/documentation/1.0/developers/clients/library-guidelines.html index 403ed4cc0..7e6638864 100644 --- a/documentation/1.0/developers/clients/library-guidelines.html +++ b/documentation/1.0/developers/clients/library-guidelines.html @@ -8,7 +8,7 @@ - + @@ -278,6 +278,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/developers/index.html b/documentation/1.0/developers/index.html index 3336cef6d..1bdb011bc 100644 --- a/documentation/1.0/developers/index.html +++ b/documentation/1.0/developers/index.html @@ -8,7 +8,7 @@ - + @@ -207,6 +207,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/developers/profiles/api.html b/documentation/1.0/developers/profiles/api.html index 2f2198fd1..2f507ccee 100644 --- a/documentation/1.0/developers/profiles/api.html +++ b/documentation/1.0/developers/profiles/api.html @@ -8,7 +8,7 @@ - + @@ -205,6 +205,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/developers/profiles/index.html b/documentation/1.0/developers/profiles/index.html index c4f302708..6c640e6c1 100644 --- a/documentation/1.0/developers/profiles/index.html +++ b/documentation/1.0/developers/profiles/index.html @@ -8,7 +8,7 @@ - + @@ -203,6 +203,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/developers/profiles/processes.html b/documentation/1.0/developers/profiles/processes.html index 86fb1e005..5fcca98d0 100644 --- a/documentation/1.0/developers/profiles/processes.html +++ b/documentation/1.0/developers/profiles/processes.html @@ -8,7 +8,7 @@ - + @@ -215,6 +215,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/glossary.html b/documentation/1.0/glossary.html index 151f3285f..dfaedcfcc 100644 --- a/documentation/1.0/glossary.html +++ b/documentation/1.0/glossary.html @@ -8,7 +8,7 @@ - + @@ -211,6 +211,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/index.html b/documentation/1.0/index.html index 3838d0032..72ede091a 100644 --- a/documentation/1.0/index.html +++ b/documentation/1.0/index.html @@ -8,7 +8,7 @@ - + @@ -208,6 +208,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/javascript/index.html b/documentation/1.0/javascript/index.html index 68bf0927b..7e5fa9e41 100644 --- a/documentation/1.0/javascript/index.html +++ b/documentation/1.0/javascript/index.html @@ -8,7 +8,7 @@ - + @@ -371,6 +371,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/processes.html b/documentation/1.0/processes.html index be873568a..9bf0a0e5c 100644 --- a/documentation/1.0/processes.html +++ b/documentation/1.0/processes.html @@ -8,7 +8,7 @@ - + @@ -208,6 +208,6 @@ experimental

Note: This is the list of all processes specified by the openEO project. Back-ends implement a varying set of processes. Thus, the processes you can use at a specific back-end may derive from the specification, may include non-standardized processes and may not implement all processes listed here. Please check each back-end individually for the processes they support. The client libraries usually have a function called listProcesses or list_processes for that.

- + diff --git a/documentation/1.0/python/client-side-processing.html b/documentation/1.0/python/client-side-processing.html index f6ef16685..395c0602f 100644 --- a/documentation/1.0/python/client-side-processing.html +++ b/documentation/1.0/python/client-side-processing.html @@ -8,7 +8,7 @@ - + @@ -303,6 +303,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/python/index.html b/documentation/1.0/python/index.html index 2a42f0c11..c1b3811a0 100644 --- a/documentation/1.0/python/index.html +++ b/documentation/1.0/python/index.html @@ -8,7 +8,7 @@ - + @@ -356,6 +356,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/qgis/index.html b/documentation/1.0/qgis/index.html index f7f854b8a..1c240b5c7 100644 --- a/documentation/1.0/qgis/index.html +++ b/documentation/1.0/qgis/index.html @@ -8,7 +8,7 @@ - + @@ -332,6 +332,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/r/index.html b/documentation/1.0/r/index.html index e9979cff4..67ba8aa01 100644 --- a/documentation/1.0/r/index.html +++ b/documentation/1.0/r/index.html @@ -8,7 +8,7 @@ - + @@ -388,6 +388,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/1.0/udfs.html b/documentation/1.0/udfs.html index 06cf62258..c769bcf72 100644 --- a/documentation/1.0/udfs.html +++ b/documentation/1.0/udfs.html @@ -8,7 +8,7 @@ - + @@ -233,6 +233,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/code-of-conduct.html b/documentation/code-of-conduct.html index 4cbbf6513..f137dce13 100644 --- a/documentation/code-of-conduct.html +++ b/documentation/code-of-conduct.html @@ -8,7 +8,7 @@ - + @@ -214,6 +214,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/documentation/software-guidelines.html b/documentation/software-guidelines.html index 27ad1b766..2c42aa191 100644 --- a/documentation/software-guidelines.html +++ b/documentation/software-guidelines.html @@ -8,7 +8,7 @@ - + @@ -204,6 +204,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/events/igarrs2021.html b/events/igarrs2021.html index b04faa93b..ecd6d509a 100644 --- a/events/igarrs2021.html +++ b/events/igarrs2021.html @@ -8,7 +8,7 @@ - + @@ -206,6 +206,6 @@ Apache License, Version 2.0 (opens new window)
- + diff --git a/index.html b/index.html index 1e0ee7ead..daeca2ae1 100644 --- a/index.html +++ b/index.html @@ -8,7 +8,7 @@ - + @@ -213,6 +213,6 @@
  • December 6, 2023
    openEO submitted to OGC for consideration as an OGC community standard
    • Read more...

    Other Channels

    - + diff --git a/news/2017-12-05-welcome.html b/news/2017-12-05-welcome.html index cf81d2081..09efee0be 100644 --- a/news/2017-12-05-welcome.html +++ b/news/2017-12-05-welcome.html @@ -8,7 +8,7 @@ - + @@ -204,6 +204,6 @@ source software solutions. We develop an API to connect R, python and javascript clients to big Earth observation cloud back-ends in a simple and unified way.

    We invite everyone interested to participate. Get in touch today!

    - + diff --git a/news/2017-12-18-VITO_meeting.html b/news/2017-12-18-VITO_meeting.html index 9e7e42833..ec509f30c 100644 --- a/news/2017-12-18-VITO_meeting.html +++ b/news/2017-12-18-VITO_meeting.html @@ -8,7 +8,7 @@ - + @@ -205,6 +205,6 @@ gathered to discuss, and work on realising the first three use cases (opens new window), which are planned to be delivered in Month 6 (March 2018):

    We worked on the following back-ends:

    • Sentinel hub
    • EODC file-based
    • Rasdaman
    • GRASS
    • GeoTrellis

    and on the R and python clients, and started working on a glossary.

    Among the many insights we gathered by sitting together and talk, we found that

    • the "core API" as described in the proposal is not so much a software layer on itself, but rather an API in front of every compute back-end; this simplifies the whole architecture pretty much
    • OpenSearch should have the ability to describe collections of granules (or images, tiles) in addition to describing individual granules
    • band can be seen as array dimension as well as attributes of array records, but seeing it as a dimension may make life easier
    • use case 1 can be described as a sequence of filter operations (on image collection, bounding box, date range, and bands) followed by two aggregate operations (compute division over bands, compute mininum over time)

    Intermediate results can be found in a bunch of repositories, mostly proof-of-concept, on the openEO Github organisation (opens new window).

    - + diff --git a/news/2018-01-31-WWU_meeting.html b/news/2018-01-31-WWU_meeting.html index 33c9d2dd4..532fd8fca 100644 --- a/news/2018-01-31-WWU_meeting.html +++ b/news/2018-01-31-WWU_meeting.html @@ -8,7 +8,7 @@ - + @@ -200,6 +200,6 @@ on January 31, 2018 by Marius Appel.

    On Jan 22-24, the Institute for Geoinformatics (opens new window) at the University of Muenster hosted the second week of intense collaboration. 16 developers from 8 partners worked on implementing the proof of concept use cases for different clients and backends, improving the core API, and connecting the clients to different backends.

    We continued implementing the GeoTrellis (opens new window), WCPS (opens new window), GRASS GIS (opens new window), and Sentinel Hub (opens new window) backend drivers and a Python client (opens new window) for OpenEO, which we started during our meeting in December at VITO (opens new window).

    Besides many improvements in the proof of concept implementations, this week resulted in two more prototypical OpenEO clients:

    During the three days, we also discussed important ideas of the core API specification and how it can be improved by supporting synchronous processing and representing descriptions of process chains as resources. EODC (opens new window) presented its new OpenShift (opens new window)-based architecture to run OpenEO queries in containers. Further important discussions made clear how our proof of concept in month 6 will look like.

    More details of the week's results can be found in our GitHub (opens new window) repositories.

    - + diff --git a/news/2018-03-15-poc.html b/news/2018-03-15-poc.html index 7cd53f421..7ec9dc117 100644 --- a/news/2018-03-15-poc.html +++ b/news/2018-03-15-poc.html @@ -8,7 +8,7 @@ - + @@ -225,6 +225,6 @@ made while testing the various clients and back-ends.

    # Proof-of-concept videos

    # R client and WCPS back-end, use case 1

    # Grass GIS back-end, use cases 1, 2 and 3

    # R client and R back-end, use-case 1

    # R client and R back-end, use case 3

    # openEO Web Editor (JS client) with three back-ends (use case 1)

    Demonstrates use of back-ends Sentinel Hub, WCPS EURAC, and OpenShift EODC

    # openEO Web Editor (JS client) with R back-end (use case 3)

    # Python client with GeoPySpark back-end (use case 1)

    # openEO Web Editor (JS client) with Google Earth Engine back-end (use case 1)

    The following four documents (formal project deliverables) describe the proof-of-concept more extensively:

    In addition, a document has been written that describes standards and interfaces used by the various back-ends, and the extent to which they are or will be useful for further developing the openEO API:

    These deliverables have been submitted, but have not been approved, and hence may not be final.

    # Next steps

    During the proof-of-concept, intentionally a number of difficult issues were not addressed, including

    • billing (costs) of processes and account management and
    • authentification while others were defined rather vaguely, including
    • the description of data (end point /data)
    • the description of processes (end point /processes).

    The next steps will include:

    • discussing of the use-cases in the proof-of-concept
    • deciding whether to adopt existing standards and interfaces, e.g. for data descriptions
    • getting users involved outside the openEO consortium to define further requirements and priorities
    • designing a new iteration of the openEO API.

    # Getting involved

    As any API, the openAPI will only become good and useful if it is being used, and it needs testing by a wide audience. We are now at the stage of designing it, but at the point where large chunks are useful already. If you want to contribute to any of this, please do not hesitate and contact us e.g. by

    • expressing interest
    • writing GitHub issues wherever you think it is appropriate
    • sending an email
    - + diff --git a/news/2018-05-23-user-requirements-survey-launched.html b/news/2018-05-23-user-requirements-survey-launched.html index 16d1da8c8..9fb8cde61 100644 --- a/news/2018-05-23-user-requirements-survey-launched.html +++ b/news/2018-05-23-user-requirements-survey-launched.html @@ -8,7 +8,7 @@ - + @@ -199,6 +199,6 @@

    • User Requirements Survey for openEO launched

    User Requirements Survey for openEO launched

    Written on May 23, 2018 by Sarah Carter.

    This survey (opens new window) aims to gather a detailed view of external user needs in relation EO data access and analysis. This will enable the openEO project team to better identify current needs of different users and the potential for openEO to be useful to them and to overcome any barriers they have in their work streams. Ultimately, this will steer the openEO API in a way which meets user needs including being compatible with additional EO service providers and their data infrastructures. Additional processes and use cases will also be added where necessary with the aim of benefiting more potential users.

    The survey is open to all, so please fill it in by 18 June 2018, and share within your relevant networks. It should take no longer than 10 minutes to complete.

    https://ec.europa.eu/eusurvey/runner/openEO_UserSurvey (opens new window)

    - + diff --git a/news/2018-10-30-year-one-review-meeting.html b/news/2018-10-30-year-one-review-meeting.html index 11789979f..d1c518941 100644 --- a/news/2018-10-30-year-one-review-meeting.html +++ b/news/2018-10-30-year-one-review-meeting.html @@ -8,7 +8,7 @@ - + @@ -200,6 +200,6 @@ on October 30, 2018 by Matthias Schramm.

    The openEO consortium is currently undergoing its first evaluation process by the European Commission. During the first year the partners exceeded the planned progress. During the starting phase the meaning of the different layers was clarified more precisely. openEO represents a set of contracts between two API layers.

    1. Instances of the core API are implemented at back-end drivers within the respective EO service providers. By guaranteeing the same instances at the various back-ends, their interoperability can be guaranteed.
    2. Client APIs – software libraries specific to given programming languages – are enabling users to interact with the back-end's drivers. The communication between clients and service providers is realised via HTTP requests, which's complexity is not visible to the users, but is dealt with by openEO.

    Since the successful development of the Proof of Concept, client APIs are developed for Python (opens new window), R (opens new window), and JavaScript (opens new window), enabling the execution of a growing set of functionalities. Being language neutral, new client APIs of e.g. additional programming languages, Quantum GIS interfaces, or GRASS GIS can be added easily. Currently, the core API is establishing access to entry points of 7 European EO service providers, which are thus able to provide services to the user, reflecting examples from all stages of EO data processing.

    A process catalogue is under development, describing a set of functionalities to be implemented for openEO, their I/O data and their exact workflow. Interested users are encouraged to discuss with the consortium partners via the various provided channels to enable openEO forming widely accepted and used standards with a consistent syntax. The well-defined process catalogue shall also serve 3rd-party processing platforms with a template to become accessible to openEO. In the same manner, a client library development guideline is being prepared momentarily to ensure a standardised implementation of the client APIs.

    For using arbitrary code to process EO data with the openEO API, first User-Defined Functions (UDF) are currently implemented and added to openEO-compatible workflows. The UDFs are running in specific dockers at the EO data service providers.

    openEO is published in its version 0.3.0 (opens new window), providing a HTTP communication between the users and service providers specified by OpenAPI 3.0 JSON files. The JSON data entails process graphs, sent as a job to the back-ends, which can be executed in three different ways.

    1. A batch job can be submitted, which stays inactive until processing is requested. It will run only once and stores its results after execution.
    2. Secondary web services allow web-based access using different protocols such as OGC WMS, OGC WCS or XYZ tiles. The computation runs on demand to allow users to change e.g. the result's viewing extent or level of detail.
    3. Lightweight process graphs (e.g. small previews) can be executed synchronously. More costly processes have to expect timeouts for long-polling HTTP requests.

    The next steps for the consortium will entail the realisation of the newest openEO version at all back-ends and a definition of the targeted level of UDFs (e.g. simple NDVI calculation vs. machine learning algorithms). The process catalogues will be widened up, entailing at least all needed processes to implement the project's use cases via openEO. As an interested user please contact us, if you have any suggestions.

    Finally, we plan to submit our first preliminary stable openEO version in May 2019.

    - + diff --git a/news/2019-03-07-openeo-api-040.html b/news/2019-03-07-openeo-api-040.html index 7be1a4449..0a34d0596 100644 --- a/news/2019-03-07-openeo-api-040.html +++ b/news/2019-03-07-openeo-api-040.html @@ -8,7 +8,7 @@ - + @@ -227,6 +227,6 @@ .reduce("temporal", (b, data) => data.min()) .saveResult("GTiff");

    Similarly, it would work in the R client. You can also check the process graph documentation (opens new window) if you'd like to know how this algorithm looks as a process graph.

    # Other improvements

    We also updated our Data Discovery to be compatible with the most recent version of STAC, v0.6.2 (opens new window). In the last months, openEO contributed several extensions to the STAC specification such as an extension to describe Synthetic-Aperture Radar (SAR) data (opens new window) or an extension to describe Data Cubes (opens new window).

    Despite the process and data discovery, we generally improved the discovery of openEO back-ends. For example, the API now also allows clients to automatically detect supported API versions at the back-end, so that users don't need to keep track of that and can always connect to the same URL without worrying about compatibility between clients and back-ends. Our approach to user-defined functions (UDFs) (opens new window) was also better integrated withing the API. UDF runtimes can be discovered now and well-defined processes allow executing UDFs. Many more improvements were incorporated into the API specification based on feedback from the review meeting, discussions with users and implementations (see the full changelog (opens new window)).

    # Next steps

    This is the API version, which is targeted towards getting the first more universally usable version of the openEO clients and back-ends released. We will work hard now to implement the back-ends and clients to comply with the new API version and will follow up with a new blog post once this is achieved. Afterwards, all interested parties can use clients and back-ends to get a first solid impression of the project. In the meantime, it is already possible to make experiments with the back-ends and clients working on the API version 0.3.1. Please contact us (opens new window) to get more information about it. Having said that, the new version is not the last one and we will continue to improve the API, client and back-ends. So any feedback is highly appreciated and can be sent our way via GitHub issues in the corresponding GitHub repositories (opens new window) or via any of the other contact options (opens new window).

    - + diff --git a/news/2019-10-07-EO-big-data-hackaton.html b/news/2019-10-07-EO-big-data-hackaton.html index 5b57193a7..e67a26dee 100644 --- a/news/2019-10-07-EO-big-data-hackaton.html +++ b/news/2019-10-07-EO-big-data-hackaton.html @@ -8,7 +8,7 @@ - + @@ -199,6 +199,6 @@

    • H2020 EO Big Data Hackathon Nov 7-8

    H2020 EO Big Data Hackathon Nov 7-8

    Written on October 7, 2019 by Edzer Pebesma.

    openEO will participate, along with the four other H2020 projects funded under the same call, in the H2020 EO Big Data Hackathon (opens new window), which is open for participation.

    The hackaton will take place on Nov 7 and 8, 2019, in Frascati, Italy.

    - + diff --git a/news/2020-07-31-lessons-learned.html b/news/2020-07-31-lessons-learned.html index fab15f742..17f60e6d1 100644 --- a/news/2020-07-31-lessons-learned.html +++ b/news/2020-07-31-lessons-learned.html @@ -8,7 +8,7 @@ - + @@ -199,6 +199,6 @@

    Lessons learned while developing the openEO API

    Written on July 31, 2020 by Matthias Mohr.

    With openEO, we are digging into new grounds regarding the interoperability of big Earth observation clouds. While we could address a lot of problems that came up, some issues remained that we couldn't solve. This article explains some of the lessons learned and thus also gives an honest overview about current limitations of the openEO API.

    # 1. Collection Names

    The naming of data sets (collections) is different across providers. We thought about recommending to follow lists like the CEOS Mission Index (opens new window), but then the question is what data does it really refer to? It lists Sentinel-2 A and Sentinel-2 B, but would that be Level 1C or 2A or something completely different? Therefore, openEO decided to not enforce any naming scheme as data sets throughout the affiliated providers were mostly differently pre-processed anyway. To improve the situation, openEO allows to define process parameters. This allows to define algorithms independently of data set names, which can later be assigned when executing the process. Also, openEO recommends to split processing instructions into two parts: data loading/pre-processing and the actual algorithm.

    Some more background information can be found in the corresponding GitHub issue (opens new window). In general, many limitations (including the following) concern the data holdings of the providers and may hopefully be solved by initiatives that work on Analysis Ready Data (ARD).

    # 2. Other Names

    Similarly, the naming of bands (and potentially other dimension labels, too) are inconsistent across providers, we faced names such as B2, B02, 2 or blue for Sentinel-2. openEO doesn't enforce any naming scheme, but has found ways to improve the situation for users. First, process parameters can be used (see above). Second, bands can also be specified using the common names as specified by STAC (opens new window) or wavelength ranges. openEO recommends to use common names whenever available.

    For example, to avoid specific naming you could filter for Sentinel-2 (A and B) band 2 as follows:

    • by common name: filter_bands(data = cube, bands = ['blue']) (blue maps to the wavelength range 0.45 - 0.50 according to STAC)
    • by wavelength, specified in μm: filter_bands(data = cube, wavelength = [[0.49, 0.50]]) (wavelength is 0.4966 for Sentinel-2A and 0.4921 for Sentinel-2B)

    In general, metadata is aligned for usage in openEO processes by using the STAC specification (opens new window), which improves interoperability.

    # 3. Chunked Collections

    Some providers (for example Google Earth Engine (opens new window)) expose data sets such as Sentinel-2 L2A as one large collection. Other providers expose the data sets split into groups, e.g. chunked by CRS and resolution. EURAC has collections such as S2_32632_60m_L2A or S2_32635_10m_L2A for example. There are valid reasons (opens new window) for any of the implementations, but to explain them is too much for this article. Unfortunately, those differences decrease the interoperability and in the end the re-usability of the processes. openEO aims to make algorithms re-usable and thus recommends to split processing instructions into two parts: data loading/pre-processing and the actual algorithm. This allows greater re-usability of the algorithms.

    # 4. What to specify?

    The API has a focus on Service and Data Discovery, Data Processing and Result Retrieval/Publishing. Some more customer-oriented tasks such as user registration and payments are not handled through the openEO API. These aspects are too different across providers and can be handled more efficiently through external interfaces. Most providers already offer such services independently of the openEO API implementation anyway to offer their pre-openEO services.

    Still, the openEO API uses OpenID Connect as main Authentication and Authorization mechanism (see also point 5). OpenID Connect (opens new window) has a User Registration extension draft (opens new window) that can be used by back-ends and may be adopted in the future. We closely follow upcoming specifications and standards and are happy to adopt anything useful.

    # File Formats

    Similarly, file formats (opens new window) and their options (opens new window) are often very different between processing software. That is why GDAL exists. To improve interoperability, the openEO API just recommends to align them with GDAL, which is used in most relevant software anyway. Unfortunately, this comes with some small inconveniences. For example, most people would probably expect to just specify "GeoTiff" as file format name, but GDAL has named it "GTiff". Another idea was to use media types (opens new window) such as application/json, but then we realized that these are often to broad or not even defined. For example, openEO had to push the OGC (opens new window) to specify an official media type for GeoTiff. But the same issue exists for other file formats, too.

    # 5. Authentication

    One of the most complex issues we faced during the API development was actually not EO or data processing related. It was the Authentication and Authorization mechanism. We quickly decided to use one of the well-established standards available for security reasons. Unfortunately, most of them don't seem to cater very well for our use case where you have a number of different clients and back-ends communicating with each other. Usually in the Web you have multiple clients communicating with a single back-end (1:n), but in openEO we have a n:m relation. There are CLI tools, web clients and more that need to authenticate against a growing set of independent providers. Therefore, you can't easily ship clients with security measures like Client IDs (and Client Secrets) as required by OpenID Connect (opens new window) (based on OAuth 2 (opens new window)). Users need to get those information by themselves and provide it to the clients, which is inconvenient and probably confusing to many non-developers. This issue is probably the thing I dislike most in the current API specification and thus would love to hear from you whether there are good solutions out there that we missed.

    # 6. Debugging Experience

    The logging and debugging experience varies a lot between cloud processing and the "traditional workflow" (you download data and compute locally with your preferred tools). While it's "free" on a local machine to just do "trial and error" to check whether something is running, cloud processing usually comes with a cost and you likely don't want to work with "trial and error". Also you don't directly have access to the hardware and software and thus it is harder to investigate problems. openEO took several measures to mitigate these issues, but it is still a different experience for users. I guess that is a long learning process until it is adopted by users and may need additional effort to implement tools to improve the situation. While many users are getting used to it in situations where a streamlined experience is somewhat possible as only few clients communicate with a single provider (e.g. Google Earth Engine), the issue increases in openEO due to the different infrastructure and software used on back-end side.

    # 7. Defining interoperable Processes

    Defining a common set of pre-defined processes was a very long and challenging task.

    1. First, we had to come up with a useful schema that allowed us to describe processes in JSON. We got inspired by different other standards such as WPS (opens new window) and OpenAPI (opens new window).
    2. Second, we had to find what processes are required and which granularity they should have. That quickly led to over a hundred processes (opens new window), mainly for data cube and math operations. And that was only for mostly raster operations. We still have a big hole in the processes regarding vector related operations, but we aim to close that in the next year(s).
    3. Third, we had to figure out what common processing softwares offered and how to come up with process definitions than can be implemented with those softwares.
    4. Last, we had to specify it in a way that is unambiguous and easy to understand by users.

    All of these tasks took much more time than initially expected. For example, one of the partners reported that the granularity of the processes is not really suited for the underlying processing software. While we couldn't really change the granularity, it was at least not an issue to make openEO work for them. Fortunately, the process part of the openEO API is very flexible and allows providers to change the processes according to their needs or define their own processes. Due to the fact that the actual parameters and return values are described in JSON Schema, clients and back-ends can easily re-use existing JSON Schema implementations and adopt to changes in the process specifications. Thus, if a back-end doesn't support parts of a process, it can just be changed/removed and a client can understand that and cater for it.

    # Conclusion

    This was a deep dive into some of my challenges during the last years. I hope it is useful for others and I'm hoping to get into discussions with developers facing similar issues. Maybe with joint forces we can solve some of these for a better cloud processing experience in the future. If you have anything to say, please contact me via e-mail, GitHub issues (API (opens new window), Processes (opens new window)) or Twitter (opens new window). You can also contact openEO.

    - + diff --git a/news/2020-07-31-openeo-api-released.html b/news/2020-07-31-openeo-api-released.html index 608afa05a..e2711a4a3 100644 --- a/news/2020-07-31-openeo-api-released.html +++ b/news/2020-07-31-openeo-api-released.html @@ -8,7 +8,7 @@ - + @@ -199,6 +199,6 @@

    Stable release of the openEO API and Processes (v1.0.0)

    Written on July 31, 2020 by Matthias Mohr.

    After two release candidates in early 2020, the openEO Consortium released the first stable version of its openEO API (opens new window) and their set of common processes (opens new window). This blog post gives an overview of the most notable changes since version 0.4 and provides an outlook on the next months' project activity.

    For those who are new to openEO, we have developed an open API to connect R, Python, JavaScript and other clients to big Earth observation cloud back-ends in a simple and unified way. The idea is that this will make cloud-based processing of large satellite image collections, or other data cubes such as weather model data easier for data scientists. The entire development process has been open, and all software developed in this project is open source and available on GitHub (opens new window). For more information about openEO, please read page about the project first.

    # Processes

    The most important change was introduced just recently in openEO API version 1.0.0 RC2. Until then, openEO process graphs allowed users to express processing algorithms and execute them on a back-end using pre-defined processes exposed by a back-end provider. While this still exists, a user can now also promote a process graph to a full openEO process description, following the same schema as the pre-defined processes: it must include the processing instructions and metadata like an identifier, parameters, return values, examples etc. This allows user-defined processes to be stored and used like pre-defined processes, enabling users to extend the processing capabilities of a back-end. Users can now encapsulate algorithms in separate user-defined processes and re-use these in other user-defined processes. This also allows the exchange of processes (algorithms) between users and back-ends, and creates the possibility for a repository of user-contributed processes that other users can benefit from. A place for finding and sharing such processes is (planned to be) the openEO Hub (opens new window).

    Through user-defined processes (and user defined functions) users may also be able to substitute processes that back-ends have not implemented. In fact, several pre-defined processes are defined with alternative processing instructions that use other openEO pre-defined processes to solve the task. For example, the pre-defined process normalized_ difference can be emulated with a combination of the processes add, subtract and divide. So if a back-end is missing the normalized_difference process, a user can just download it (opens new window) and use an openEO client to push it to the back-end where it then acts as drop-in replacement for the missing pre-defined process. In the future we plan to allow just using the URL of the process, so that no download/upload would be required.

    As mentioned above, openEO offers a set of common processes (opens new window) to improve interoperability and portability between back-ends. This is not a complete list and is expected to be extended by the openEO Consortium. More than that, we would like to see that processes arise from the community and that we can take over and standardize whatever comes up and is useful for the different domains working with openEO. We can then simply use the user-defined processes as they share the same schema as the pre-defined processes.

    The pre-defined openEO processes are released separately from the API to ensure a faster release cycle than we plan for the API. We want to be able to quickly adapt to community needs with additional processes. Future version of the processes are valid with any future API version through the specification of the process metadata standard in openEO.

    The pre-defined processes itself also got an update just after the API release, but the changes (opens new window) are relatively small compared to the API. The focus was to clarify unspecified and ambiguous parts of the specification. Some processes such as apply_neighborhood and constant were added for the use cases. In collaboration with Julia Wagemann (opens new window) from the ECMWF (opens new window) we started defining processes such as aggregate_temporal_frequency, anomaly and climatological_normal for climatology and meteorology use-cases. Unfortunately, this effort could not be finished yet due to the COVID-19 situation. We want to continue to broaden the processes to be useful for more domains apart from core Earth Observation.

    # STAC and OGC APIs

    The openEO API now supports STAC (API) versions 0.9 and 1.x, which implements OGC API - Features. Thus, a potential integration of the openEO API with upcoming OGC API standards should be easy to establish.

    # User-defined Functions (UDFs)

    Note: Don't get confused, user-defined processes and user-defined functions describe different things.

    Although already foreseen in API version 0.4.0, the openEO UDF API has evolved and is better integrated in the openEO API. It now allows to run Docker containers or custom scripts in potentially any programming language. The UDF API itself is not part of the openEO API, but is a separate specification to describe the data exchange between a back-end implementing the openEO API and a UDF API instance. The UDF API is in release candidate phase and we'll likely post a separate blog post focussing solely on them. Currently, implementations in R and Python are available. It is foreseen that users could also host their own UDF API instances and call them from remote back-ends.

    # Other improvements

    Other notable changes and additions:

    • Support for importing user-provided data sets has been added.
    • Providers can now expose their terms of service and privacy policies.
    • The WebSocket-based Subscription API for notifications and monitoring introduced in version 0.4 has been replaced by a logging mechanism in the HTTP API. This makes implementing the API easier for clients and back-ends, but doesn't work in real-time any longer.

    The full set of changes can be found in the API's change log (opens new window).

    # Limitations

    With openEO, we are digging into new grounds regarding the interoperability of big Earth observation clouds. While we could solve a lot of issues that came up, there were some issues that we couldn't solve as part of the API and processes. We want to be honest and give some insights into the lessons learned, so I have posted these as a separate blog post.

    # Next steps

    The API's development went through several iterations and is working well for our broad range of use cases, which we'll report soon. Implementations by several organizations for several API versions provide evidence that the API and the processes are useful for a wide range of use cases. Client and back-end developers will now finish their implementations and we hope to have the first operational services this year. We will follow up with new blog posts once other releases are available. If you are interested in trying out openEO, please contact us to get more information.

    - + diff --git a/news/2020-09-02-openeo-user-workshop.html b/news/2020-09-02-openeo-user-workshop.html index 7b1f20cbf..feea1ff32 100644 --- a/news/2020-09-02-openeo-user-workshop.html +++ b/news/2020-09-02-openeo-user-workshop.html @@ -8,7 +8,7 @@ - + @@ -199,6 +199,6 @@

    • openEO Virtual User Workshop

    openEO Virtual User Workshop

    Written on September 2, 2020 by Matthias Schramm.

    # UPDATE:

    Presentations and Notebooks of the user workshop can be downloaded here (opens new window).

    openEO hosts a (virtual) user workshop on 19 October 2020 (10:30 - 16:30 CEST in two parts) and encourages interested parties to register for this event at https://ec.europa.eu/eusurvey/runner/openEOUserWorkshop (opens new window).

    Needed preparation: Manuals for installing the various client APIs, recommended for testing openEO in guided sessions, can be found in the User Documentation under Getting Started.

    User questionnaire: Please help us also by spending some minutes for this user questionnaire (opens new window).

    Access details: Please click the session topics below to connect to the corresponding sessions in Microsoft Teams.

    Agenda:

    Part 1
    No. Start Duration Topic Remark
    1.1 10:30h 30min Introduction into openEO + technical overview
    1.2 11:00h 20min Overview backends
    1.3 11:20h 20min Overview processes + documentation
    1.4 11:40h 5min Installation of openEO
    1.5 11:45h 15min Q/A: Backends, Installation, Q/A Chat Questionaire
    Break for users to install openEO, partners stay available in chat for answering questions on that in bilateral talks
    Part 2
    No. Start Duration Topic Remark
    2.1 14:00h 5min Welcome back / Ways for users to approach to openEO
    Live Demontrations, Part 1
    2.2a 14:05h 20min Python Client Parallel session
    2.2b 14:05h 20min JavaScript Client + mobile application
    14:25h 5min Short break / Switching sessions
    Live Demontrations, Part 2
    2.3a 14:30h 20min Web Editor + QGIS Parallel session
    2.3b 14:30h 20min R Client
    14:50h 5min Short break / Switching sessions
    Guided Sessions and Q/A
    2.4a 14:55h 60min Guided room for users to test the R Client Parallel session
    2.4b 14:55h 60min Guided room for users to test the Python Client
    2.4c 14:55h 60min Guided room for users to test other clients
    2.5a 15:55h 15min Q/A and Discussions: R Client Parallel session
    2.5b 15:55h 15min Q/A and Discussions: Python
    2.5c 15:55h 15min Q/A and Discussions: Other clients
    Wrap up
    2.6 16:10h 20min Q/A; Discussion on user needs, future work

    Background: openEO is a user-driven open source API, which grants a uniform communication between the Earth Observation (EO) data user community and diverse EO cloud service providers. Thus, it aims for a cross-platform interoperability to ease a comparison, the cooperation and the switch between them. The project consortium (H2020 Grant No 776242) released a stable version of the openEO API, covering standardised online processing of all aspects of an EO data life cycle on diverse cloud platforms.

    In this User Workshop, the audience is provided with insight into the functionalities of the openEO API. In various live demonstration and training sessions, real demonstration cases will be explained from the user perspective. Possible applications of the openEO API will be presented for different access levels – from the use of programming languages to browser based model builders or mobile applications. Target audience for this event are programmers, decision makers, as well as third-party cloud EO service providers.

    - + diff --git a/news/2020-11-30-openeo-api-101-released.html b/news/2020-11-30-openeo-api-101-released.html index 59c359189..da1b9356d 100644 --- a/news/2020-11-30-openeo-api-101-released.html +++ b/news/2020-11-30-openeo-api-101-released.html @@ -8,7 +8,7 @@ - + @@ -205,6 +205,6 @@ issues with credentials in web browsers. Back-ends are advised to check their implementations against the new specification and update the CORS headers accordingly. The web clients have already been updated accordingly.

    More details about the release:

    - + diff --git a/news/2021-05-17-openeo-api-110-released.html b/news/2021-05-17-openeo-api-110-released.html index ab2363113..2c90460cd 100644 --- a/news/2021-05-17-openeo-api-110-released.html +++ b/news/2021-05-17-openeo-api-110-released.html @@ -8,7 +8,7 @@ - + @@ -208,6 +208,6 @@ For several parts exposed by the API can now be declared to be experimental or deprecated. Finally, the API specification also clarifies several ambiguous parts of the specification.

    Back-ends and clients are advised to check their implementations against the new specification and update accordingly.

    More details about the release:

    - + diff --git a/news/2021-11-08-r-client-on-cran.html b/news/2021-11-08-r-client-on-cran.html index 66578e61f..8beed07cf 100644 --- a/news/2021-11-08-r-client-on-cran.html +++ b/news/2021-11-08-r-client-on-cran.html @@ -8,7 +8,7 @@ - + @@ -201,6 +201,6 @@

    Today, we released a new version 1.1.0 of the openEO R Client, which features a couple of improvements and bug fixes (opens new window).

    At the same time, the R client has been published on CRAN, too: openeo (opens new window) This means you can now install the R client more easily and directly through CRAN with the following command:

    install.packages("openeo")

    If you have trouble installing or working with the package, feel free to leave an issue in the GitHub issue tracker (opens new window).

    - + diff --git a/news/2022-04-08-psc-meetings.html b/news/2022-04-08-psc-meetings.html index c0bf89d10..03747a4f4 100644 --- a/news/2022-04-08-psc-meetings.html +++ b/news/2022-04-08-psc-meetings.html @@ -8,7 +8,7 @@ - + @@ -203,6 +203,6 @@ We will always discuss the open issues in the PSC issue tracker (opens new window) and talk through the future and strategic directions openEO is heading towards. The meetings are open to the public and anyone can join as a guest. If you'd like to join the next meeting, please contact openeo.psc@uni-muenster.de and we'll send you an invite.

    - + diff --git a/news/2022-05-12-r-client-v120.html b/news/2022-05-12-r-client-v120.html index cea8b818c..d09e6efb1 100644 --- a/news/2022-05-12-r-client-v120.html +++ b/news/2022-05-12-r-client-v120.html @@ -8,7 +8,7 @@ - + @@ -218,6 +218,6 @@ ) )

  • The login procedure was greatly simplified for back-ends that support this new behavior. For example, on openEO Platform you can now login simply by calling the login method as such login() instead of passing a client ID and secret tom connect() or login(). It is still possible, but not required any more. It will then interactively guide you through the login procedure. It is now also supported to login in environments that are remotely hosted (e.g. RStudio Cloud, Jupyter).

  • Getting the JSON representation of a process is now simplified. The new recommended way is toJSON(as(result, "Process")) where result is the last node of your process, which usually is save_result.

  • Directly load data into stars (opens new window) if you set as_stars=TRUE in compute_result

    • - + diff --git a/news/2022-07-07-monthly-dev-calls.html b/news/2022-07-07-monthly-dev-calls.html index 6dec93b4c..a32d7c823 100644 --- a/news/2022-07-07-monthly-dev-calls.html +++ b/news/2022-07-07-monthly-dev-calls.html @@ -8,7 +8,7 @@ - + @@ -204,6 +204,6 @@ know each other. In the past there have been project-specific developer calls, but we would like to build bridges between projects and coordinate the work better.

    If you'd like to join these calls, please send an e-mail to openeo.psc@uni-muenster.de. Everyone is welcome!

    - + diff --git a/news/2022-11-17-r-client-v130.html b/news/2022-11-17-r-client-v130.html index 47194803c..3b649b1bf 100644 --- a/news/2022-11-17-r-client-v130.html +++ b/news/2022-11-17-r-client-v130.html @@ -8,7 +8,7 @@ - + @@ -218,6 +218,6 @@ We describe the details on how to create process graphs and respectively "User Defined Processes" (UDP). Those processes can be seen as the analysis workflows that are run as jobs at a designated openEO back-end. They might be called later directly or some variables can be added to the UDP to customize the processes at runtime, e.g. set the temporal interval or the area of interest. This vignette focuses on the user point of view.

  • Package Software Architecture (opens new window) This is the first part of a contribution guide which ensures that developers can effectively contribute to the R-Client. Since a server-client based package is different from most other R packages some concepts are used that most R users and developers are not so familiar with. Therefore, this contribution guide eases the process of actively contributing to the packages development or bug fixing by explaining the underlying concepts.

  • Developer Implementation Details (opens new window) In this guide selected core mechanisms of the openEO package are described. It is targeted towards interested developers and it is highly recommended to dive into the source code, while reading through this guide. The explanations here are abstracted from the code and shall guide new developers on the concepts and routines of this package.

    • - + diff --git a/news/2023-05-25-new-openeo-versions-120-200rc1 copy.html b/news/2023-05-25-new-openeo-versions-120-200rc1 copy.html index 460fb094c..6e2a64837 100644 --- a/news/2023-05-25-new-openeo-versions-120-200rc1 copy.html +++ b/news/2023-05-25-new-openeo-versions-120-200rc1 copy.html @@ -8,7 +8,7 @@ - + @@ -204,6 +204,6 @@
  • inspect: The parameter message has been moved to be the second argument. #369 (opens new window)
  • New definition for aggregate_spatial:
  • Updated the processes based on the subtypes raster-cube or vector-cube to work with the subtype datacube instead. #68 (opens new window)
  • sort and order: The ordering of ties is not defined anymore. #409 (opens new window)
  • quantiles: Parameter probabilities provided as array must be in ascending order. #297 (opens new window)
  • fit_curve and predict_curve: Heavily modified specifications. fit_curve works on arrays instead of data cubes, predict_curve doesn't support gap filling anymore, clarify no-data handling, ... #425 (opens new window)
  • climatological_normal: The climatology_period parameter accepts an array of integers instead of strings. #331 (opens new window)
  • between: Support for temporal comparison. Use date_between instead. #331 (opens new window)
  • Deprecated GeometryCollections are not supported any longer. #389 (opens new window)
  • Deprecated PROJ definitions for the CRS are not supported any longer.
  • The comparison processes eq, neq, lt, lte, gt, gte and array_contains:
    • Removed support for temporal comparison. Instead explicitly use date_difference.
    • Removed support for the input data types array and object. #208 (opens new window)
  • sort and order: Removed support for time-only values. #331 (opens new window)
    • - + diff --git a/news/2023-12-06-openeo-submitted-to-ogc.html b/news/2023-12-06-openeo-submitted-to-ogc.html index b543ece49..27074dc04 100644 --- a/news/2023-12-06-openeo-submitted-to-ogc.html +++ b/news/2023-12-06-openeo-submitted-to-ogc.html @@ -8,7 +8,7 @@ - + @@ -202,6 +202,6 @@ More specifically, the submission document (opens new window) justifies why the openEO API specification (version 1.2.0) and the openEO process specification (version 1.2.0) are - from our point of view - a good candidate for an OGC community standard. We hope OGC accepts our documents and establishes the corresponding procedures soon.

    The members of the openEO PSC voted to submit the justification document to OGC by unanimous consent. We are glad that the following OGC members confirmed to support the OCG submmissin of openEO:

    • University of Münster - Institute for Geoinformatics
    • Eurac Research
    • VITO (Flemish Institute for Technological Research)
    • GeoConnections - Natural Resources Canada
    • EUMETSAT
    • European Space Agency (ESA)
    • EOX IT Services GmbH
    • Telespazio VEGA UK Ltd
    • Planet Labs PBC
    • German Aerospace Center – DLR
    • Matthias Mohr - Softwareentwicklung

    We'll keep you updated about the progress. The next step is likely a public request for comments.

    - + diff --git a/news/2024-02-06-openeo-ogc-rfc.html b/news/2024-02-06-openeo-ogc-rfc.html index 5c204d552..056741662 100644 --- a/news/2024-02-06-openeo-ogc-rfc.html +++ b/news/2024-02-06-openeo-ogc-rfc.html @@ -8,7 +8,7 @@ - + @@ -202,6 +202,6 @@ OGC now seeks public comment on the potential adoption of openEO as an OGC Community Standard. Comments are due by February 27, 2024.

    For more details, please read the press release that was published today by OGC: Request for Comments: OGC considering openEO as a Community Standard; comment sought on its adoption (opens new window)

    openEO will also be presented at the next OGC member meeting in Delft on Thu, 28 Mar 2024 during the closing planery.

    We'll keep you updated about the progress.

    - + diff --git a/news/2024-03-22_mooc_cubeandclouds.html b/news/2024-03-22_mooc_cubeandclouds.html index 0ea7ae421..353b51707 100644 --- a/news/2024-03-22_mooc_cubeandclouds.html +++ b/news/2024-03-22_mooc_cubeandclouds.html @@ -8,7 +8,7 @@ - + @@ -199,6 +199,6 @@

    • MOOC Cubes and Clouds - open for registration

    MOOC Cubes and Clouds - open for registration

    Written on March 22, 2024 by Peter Zellner.

    The latest EO college course “Cubes and Clouds” explores the newest concepts in Earth Observation through engaging lectures, videos, animated content, and hands-on exercises!

    openEO plays a main role in the course due to its standardized API for homogenizing cloud processing. It allows for portablility of the created workflow between different cloud providers, reproducibility and sharing of the workflow which is enriched with valuable metadata. The idea behind and need for openEO are tought in a dedicated lecture. All hands-on exercises use openEO, guiding participants from basic processes to carrying out end-to-end EO workflows and sharing their results!

    You can subscribe to the course for free and learn about cloud native EO at Cubes & Clouds – EO College (eo-college.org) (opens new window).

    - + diff --git a/news/index.html b/news/index.html index a3a400803..9c16545b4 100644 --- a/news/index.html +++ b/news/index.html @@ -8,7 +8,7 @@ - + @@ -247,6 +247,6 @@ Apache License, Version 2.0 (opens new window)
    - + diff --git a/psc.html b/psc.html index b39bb1ad0..482c6b719 100644 --- a/psc.html +++ b/psc.html @@ -8,7 +8,7 @@ - + @@ -203,6 +203,6 @@ Apache License, Version 2.0 (opens new window)
    - + diff --git a/software.html b/software.html index 5889cf948..e36c31e0d 100644 --- a/software.html +++ b/software.html @@ -8,7 +8,7 @@ - + @@ -205,6 +205,6 @@ Apache License, Version 2.0 (opens new window)
    - +