Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update index.rst #464

Closed
wants to merge 1 commit into from
Closed

Update index.rst #464

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions docs/source/_templates/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
SEPAL applications
==================

Access complex workflows without the need of digital programming skills with SEPAL applications
-----------------------------------------------------------------------------------------------
*Access complex workflows without the need of digital programming skills with SEPAL applications*

.. custom-edit:: https://raw.githubusercontent.com/openforis/sepal-doc/main/docs/source/_templates/index.rst

Expand All @@ -11,23 +9,25 @@ Overview

SEPAL applications are tools provided by the SEPAL team from the Food and Agriculture Organization of the United Nations (FAO) or other developers. These tools are based on advanced geographic information system (GIS) libraries and complement the functionalities of SEPAL recipes, providing the end user with access to complex workflows without requiring knowledge of digital programming. These applications are served in SEPAL with attractive user interfaces to ensure the best possible user experience.

They run on various shells – from pure HTML and Shiny-based R apps to Jupyter-powered Python kernels. This flexibility and variety of tools allows developers to integrate workflows and make them available for SEPAL users. Review the module documentation below to learn more about its usage.
They run on various shells – from pure HTML and Shiny-based R apps to Jupyter-powered Python kernels. This flexibility and variety of tools allows developers to integrate workflows and make them available for SEPAL users.

Review the following subsections to learn more about SEPAL applications.

Start applications
------------------

To start a SEPAL application, go to the dashboard of the application by selecting the wrench icon on the left side of the window [(1) on the following image], which will bring up a list of apps you can run in SEPAL. More information about each app is found by selecting the **i** on the right side.
To start a SEPAL application, go to the **Apps** dashboard by selecting the wrench icon on the left side of the window (see **1** in the following image). This will display a list of apps you can run in the interface. More information about each app is found by selecting the **i** on the right side.

Note: The top three apps (2) are code editors, not apps:
Note that the following apps are code editors, not apps (**2**):

- R Studio: Provides access to the R environment where you can run processing scripts and upload data to your SEPAL folder.
- Jupyter Notebook: An open-source web application that allows you to create and share documents that contain live code, equations, visualizations and narrative text (supports Kernels in many different languages, including R, Python and NodesJS).
- JupyterLab: A web-based interactive development environment for Jupyter notebooks, code and data.
- **RStudio**: Provides access to the R environment where you can run processing scripts and upload data to your SEPAL folder.
- **Jupyter Notebook**: An open-source web application that allows you to create and share documents that contain live code, equations, visualizations and narrative text (supports kernels in many different languages, including R, Python and NodesJS).
- **JupyterLab**: A web-based interactive development environment for Jupyter notebooks, code and data.

.. thumbnail:: ../_images/module/index/dashboard.png
:title: The landing page of the dashboard of the application.
:title: The landing page of the **Apps** dashboard

To find the application you're looking for, you can navigate through the different app pages (3), use tags (4), or utilize the search bar (5).
To find the application you're looking for, navigate through the different app pages (**3**), use tags (**4**), or utilize the search bar (**5**).

Once the desired application is found, select it to initiate the process. This will start the smallest instance to run the SEPAL sandbox (:code:`t1`).

Expand All @@ -39,7 +39,7 @@ Refer to the next section to start a specific instance manually.

.. note::

An application relies on numerous tools and systems to run. Since it can take up to five minutes to start, stay patient and avoid rushing. If the application doesn't start after five minutes, it could simply be an issue with the Amazon cloud connection; we recommend closing the tab and starting again. In the event of a major bug or crash, please report the issue in the specific app issue tracker or directly in SEPAL.
An application relies on numerous tools and systems to run. Since it can take up to five minutes to start, stay patient and avoid rushing. If the application doesn't start after five minutes, it could simply be an issue with the Amazon cloud connection; we recommend closing the tab and starting again. In the event of a major bug or crash, please report the issue in the specific app's **Issue tracker** or directly in SEPAL.

.. important::

Expand All @@ -48,23 +48,23 @@ Refer to the next section to start a specific instance manually.
Start instance manually
-----------------------

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

If a particular app's documentation requires the user to start a specific instance type (e.g. a GPU machine :code:`g4` or :code:`g8`), follow these steps prior to initiating the application:

1. Go to the SEPAL terminal and wait for the instance selector to start.
1. Go to the **SEPAL terminal** and wait for the **Instance selector** to start.

.. thumbnail:: ../_images/module/index/terminal.png
:title: The SEPAL instance selector.
:title: The SEPAL instance selector

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

3. Wait for the instance to finish loading.

.. thumbnail:: ../_images/module/index/m4_started.png
:title: Start an m4 instance.

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

:title: Start an **m4** instance

4. Go back to the dashboard of the application to launch your app. It will automatically use the instance you opened and won't restart a :code:`t1`.

.. toctree::
:hidden:
Expand Down
Loading