SEPAL modules

Overview

SEPAL applications are tools provided by the SEPAL team from FAO or from other developers. These tools are based on advanced GIS libraries and complement the functionalities of the SEPAL recipes. It provides the end user access to complex workflows without requirering knowledge of digital programming. These applications are served in SEPAL with nice User Interfaces to ensure the best possible user experience.

They run on various shells from pure HTML to shinny based R apps but also Jupyter powered Python kernels. This flexibility and variety of tools allows developer to bring any workflows and make them available for SEPAL users. Click on any of the module documentation to know more about its usage.

Start applications

To start a SEPAL application gor to the dashboard of application by clicking on the wrench icon on the left side of the window ((1) on the following image). This will bring up a list of apps you can run in SEPAL. More information about each app is found by clicking on the “i” on the right hand side. The top 3 app (2) are not real app but code editors:

  • R Studio: provides access to R environment where you can run processing scripts and upload data to your SEPAL folder

  • Juyter Notebook: an open-source web application that allows you to create and share documents that contain live code, equations, visualizations and narrative text. support Kernels in many different languages including R, Python and NodesJS.

  • JupyterLab: JupyterLab is a web-based interactive development environment for Jupyter notebooks, code, and data.

To find the aplication he’s looking for, the user can navigate in the different app pages (3), use the tags (4) or use the search bar (5).

Once the desired application is found simply click on it to start the process. This will as well start the smallest instance to run the SEPAL sandbox (t1). Please refer to the next section to start aspecific instance manually.

Warning

Applications that includes a “G” in their descriptor require a connection to Google Earth Engine to run, please refer to Connect GEE and SEPAL for more information.

Warning

Application need to set up numerous tools and system, don’t rush and be patient it can take up to 5 min to start. If the application doesn’t start after 5 min, close the tab and start it again, it’s usually a Amazon cloud connection issue. On the other hand if one run in an bug or crash please report this issue in SEPAL or the specific app issue tracker.

Important

Application are running on the current instance so closing it (by disconecting from SEPAL or stop the instance manually) will end up in killing the application workflow. The already performed work will be available in SEPAL folders but the user will need to restart the process to finish it.

Start instance manually

Some applications require more powerful instances than the default t1. If the app documentation requires the user to start a specific instance type (e.g. a GPU machine g4 or g8) please follow these steps prior to start the application.

  1. Go to the SEPAL termninal and wait for the instance selector to start

  2. Type the instance name suggested in the documentation of your app and press Enter.

  3. Wait for the instance to finish loading

  4. Go back to the dashboard of application to launch your app. It will be automatically using the instance you opened and won’t restart a t1.