From 8d51753839b5c38a5fe3476b8a4a35165697efa5 Mon Sep 17 00:00:00 2001 From: dfguerrerom Date: Mon, 11 Dec 2023 17:32:52 +0100 Subject: [PATCH] docs: proofreading --- doc/en.rst | 41 ++++++++++++++++++++--------------------- 1 file changed, 20 insertions(+), 21 deletions(-) diff --git a/doc/en.rst b/doc/en.rst index a5ef735..557c474 100644 --- a/doc/en.rst +++ b/doc/en.rst @@ -1,5 +1,6 @@ Planet order ============ +*Explore and download Planet Lab images with the Planet Order app* This dasboard application, based on the `SEPAL-UI `_ framework, provides users with an interface to explore and download Planet Lab images. @@ -8,13 +9,13 @@ This dasboard application, based on the `SEPAL-UI `_) and (`connect your GEE account to SEPAL `_). + To start this module, `sign up for NICFI `_ and `connect your GEE account to SEPAL `_. On the landing page of our module, in the lower left of the window, you will find three buttons: -- :btn:``: Opens the GitHub repository that is used to create this module in a new tab (our code is open-source and distributed under the MIT license). -- :btn:``: Leads to the wiki page. -- :btn:``: Opens the issue tracker of our GitHub repository in a new tab (you can write here if you experience bugs or if you have any feature requests; the SEPAL team will answer as quickly as possible). +- :btn:``: Opens the **GitHub repository** that is used to create this module in a new tab (our code is open-source and distributed under the MIT license). +- :btn:``: Leads to the **Wiki page**. +- :btn:``: Opens the **Issue tracker** of our GitHub repository in a new tab (you can write here if you experience bugs or if you have any feature requests; the SEPAL team will answer as quickly as possible). Parameters ---------- @@ -26,19 +27,19 @@ In the lower-right corner, two tabs are available: In the upper-left corner, three other tabs will allow you to interact with data: -- :btn:``: the Planet order manager -- :btn:``: color management -- :btn:``: download panel +- :btn:``: the **Planet order manager** +- :btn:``: **Colour management** +- :btn:``: **Download** pane Select an AOI ------------- -The application uses the same AOI selector that you will find in many other SEPAL applications (see the `Module AOI section `__ for more information). +The application uses the same **AOI selector** that you will find in many other SEPAL applications (for more information, see the `Module AOI section `__). Planet Lab authentication ------------------------- -To authenticate the user, complete the form in the second tab with either your credentials or a Planet API key, which you can find in the settings section in your Planet profile page. Once the values are set, select :btn:`Validate`. If your Planet credentials are valid, the :btn:`NICFI` button should turn green. You can now select a mosaic from the provided list. +To authenticate the user, complete the form in the second tab with either your credentials or a Planet API key, which you can find in the **Settings** section in your **Planet profile page**. Once the values are set, select :btn:`Validate`. If your Planet credentials are valid, the :btn:`NICFI` button should turn green. You can now select a mosaic from the provided list. .. thumbnail:: https://raw.githubusercontent.com/12rambau/planet-order/master/doc/img/planet_auth.png :group: planet-order @@ -60,16 +61,16 @@ Once a mosaic is selected, the module will display basemaps on the map. Manage color combination ------------------------ -Select :btn:`` on the upper-left side of the map, which will show the different color combinations available, including: +Select :btn:`` on the upper-left side of the map, which will show the different colour combinations available, including: -- Red-green-blue (RGB) -- Color-infrared (CIR) -- Normalized difference vegetation index (NDVI) -- Normalized difference water index (NDWI) -- Visual atmosphere resistance index (VARI) -- Modified soil-adjusted vegetation index (MSAVI2) -- Modified triangular vegetation index (MTVI2) -- Triangular greenness index (TGI) +- Red-green-blue (**RGB**) +- Color-infrared (**CIR**) +- Normalized difference vegetation index (**NDVI**) +- Normalized difference water index (**NDWI**) +- Visual atmosphere resistance index (**VARI**) +- Modified soil-adjusted vegetation index (**MSAVI2**) +- Modified triangular vegetation index (**MTVI2**) +- Triangular greenness index (**TGI**) Selecting one will update the displayed basemap. @@ -127,6 +128,4 @@ The images will be stored in the following folder: :code:`~/module_results/plane If the requested image is not available (e.g. the grid points to water area, the image was too cloudy and filtered by Planet, you don't have the rights to download it, etc.) the image will fail. - If the image already exists in your folder, it will be skipped. This behaviour allows you to restart a process if your SEPAL connection crashes without needing to restart all downloads. - -.. custom-edit:: https://raw.githubusercontent.com/sepal-contrib/planet-order/release/doc/en.rst + If the image already exists in your folder, it will be skipped. This behaviour allows you to restart a process if your SEPAL connection crashes without needing to restart all downloads. \ No newline at end of file