Workflows from the Plugin

Description & purpose: This notebook steps a user through the main way to use the QGIS plugin.

Author(s): Alastair Graham, Dusan Figala

Date created: 2024-12-18

Date last modified: 2024-12-18

Licence: This file is licensed under Creative Commons Attribution-ShareAlike 4.0 International. Any included code is released using the BSD-2-Clause license.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Connect to the EODH

The first thing a user will need to do is supply their username an API token under the Settings tab. In this screengrab we can see that user gary is logging in to their EODH workspace. Plugin and pyeodh updates can also be installed from this part of the plugin.

Choose and Parameterise

In gary’s workspace are two available workflows: * echo * convert-url

It is up to the creator of the workflow to provide a useful description for the CWL workflow. Also, if users will need to run them, the workflow should be held in an online location with accessible help and about information so that the user understands what the workflow does and how much resource it might use.

The convert-url workflow is a small demonstrator that takes the URL to an image and resizes it. This is the workflow used in this demonstrtaion. The image to be resized is the thumbnail for a sentinel2_ard asset available through the EODH. The thumbnail is accessible here and is shown below.

Once the user clicks on the Execute button they are taken to the parameterisation configuration. This rebuilds for different workflows, depending on the required inputs. Here we can see that a function (resize), a resizing value (50%) and the URL to the image are required. Once completed the user will press Execute to complete the processing.

Success!

The plugin will report back the progress of the workflow on the platform. It will also provide access to any outputs, which will laso be available through the workspace interface on the user’s web prescence.

Information about a workflow run is also stored under the Jobs tab. From here, the status of all jobs that have been run in a user’s workspace will be available to be interrogated.