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.

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 #492

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
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
48 changes: 20 additions & 28 deletions docs/source/cli/index.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
CLI utilities and coding tools
==============================
*Use command-line interface (CLI) utilities and coding tools in SEPAL*
CLI
===
*Use CLI utilities and coding tools in SEPAL*

CLI tools
---------

The SEPAL platform includes a variety of useful command-line interface (CLI) utilities to help resolve specific problems, such as:
To help resolve specific problems, the SEPAL platform includes a variety of useful command-line interface (CLI) utilities, including:

- **Geospatial Data Abstraction Library (GDAL)**
- **Google Drive (Drive)**
- **Google Earth Engine (GEE)**
- **GuidosToolbox Workbench (GWB)**
- **Open Foris Geospatial Toolkit (OFGT)**
- **Orfeo Toolbox (OTB)**
.. toctree::
:maxdepth: 1

gdal
gdrive
gee
gwb
ofgt
otb
python
r

These tools can be called directly from the terminal or via any programming language sending commands to the kernel, including R and Python (installed by default on any SEPAL account).

Expand All @@ -21,7 +26,7 @@ These tools can be called directly from the terminal or via any programming lang

.. note::

The code executed previously on an existing :code:`example.tif` file.
The code executed previously on an existing :code:`example.tif` file:

.. code-block:: console

Expand All @@ -33,40 +38,27 @@ These tools can be called directly from the terminal or via any programming lang

.. tip::

If the code you want to execute is taking time, consider running it in the background using :code:`nohup`.
If the code you want to execute is taking time, consider running it in the background using :code:`nohup`:

.. code-block:: console

nohup gdalinfo example.tif

All console outputs will be redirected to a :code:`nohup.out` in your home directory, but the execution will be running in the background. Thus, you will be able to safely close the terminal or even the browser window without killing your process (for more information about :code:`nohup`, see `this article <https://en.wikipedia.org/wiki/Nohup>`__.
All console outputs will be redirected to a :code:`nohup.out` in your home directory, but the execution will be running in the background. You will be able to safely close the terminal or even the browser window without interrupting the process (for more information about :code:`nohup`, see `this article <https://en.wikipedia.org/wiki/Nohup>`__).

Coding tools
------------

In the **Apps** section, there are three coding tools at the top of the list:

- JupyterLab
- JupyterNotebook
- Jupyter Notebook
- RStudio

.. thumbnail:: ../_images/cli/index/code_editor.png
:title: The three code editors in the SEPAL environment

They will allow the user to code wokflows in any of the available languages using the corresponding environment in SEPAL. These environments are fully customizable (select the :code:`Python` or :code:`R` section to know more).
They will allow the user to code wokflows in any of the available languages using the corresponding environment in SEPAL. These environments are fully customizable (view the :code:`Python` or :code:`R` section to know more).

.. thumbnail:: ../_images/cli/index/jupyter_example.png
:title: Example of **rasterio** code running in SEPAL JupyterLab (code extracted from **rasterio** documentation: https://rasterio.readthedocs.io/en/latest/topics/plotting.html)

.. toctree::
:hidden:
:maxdepth: 1

gdal
gdrive
gee
gwb
ofgt
otb
python
r