Codespell (#352)

.github/ISSUE_TEMPLATE/typo.md

@@ -12,5 +12,5 @@ link to the page with including a typo
 **help us with the correction**
 Copy/paste the text you would like to see instead
 
-**keep in mind that you can create a pull request by yourself fo this kind of issue**
+**keep in mind that you can create a pull request by yourself for this kind of issue**
 As a reward you'll be add to the contributors :smile:

.pre-commit-config.yaml

@@ -18,3 +18,11 @@ repos:
     rev: "v1.1.1"
     hooks:
       - id: doc8
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.4
+    hooks:
+      - id: codespell
+        stages: [commit]
+        additional_dependencies:
+          - tomli

CONTRIBUTING.rst

@@ -6,6 +6,6 @@ email, or any other method with the owners of this repository before making a ch
 
 Please note we have a `code of conduct <https://github.com/openforis/sepal-doc/blob/master/CODE_OF_CONDUCT.md>`_, please follow it in all your interactions with the project.
 
-We are glad to receive feedback from our user and collegues from the SEPAL team. This documentation is yours, feel free to improve it!
+We are glad to receive feedback from our user and colleagues from the SEPAL team. This documentation is yours, feel free to improve it!
 
 Go to our `Contribute <#>`_ section to know more about contributing to this documentation.

docs/source/_data/python_lib.txt

@@ -37,7 +37,7 @@ pyperclip
 python-dateutil
 pytesmo
 Wand
-PyPDF2 # more recent version are avaiable (PyPDF4)
+PyPDF2 # more recent version are available (PyPDF4)
 rasterio
 openpyxl
 pre-commit

docs/source/_extentions/custom_edit.py

@@ -1,4 +1,4 @@
-"""Extention to dynamically change the value of the "edit this page btn"""
+"""Extension to dynamically change the value of the "edit this page btn"""
 
 from typing import Dict, List
 

docs/source/_extentions/line_break.py

@@ -1,4 +1,4 @@
-"""Line break extention to create elegant line breaks on demand"""
+"""Line break extension to create elegant line breaks on demand"""
 
 from typing import Dict, List
 

docs/source/_extentions/logos.py

@@ -1,4 +1,4 @@
-"""Logo extention to create a list of logos"""
+"""Logo extension to create a list of logos"""
 import json
 from pathlib import Path
 from typing import Dict, List
@@ -56,7 +56,7 @@ def visit_logo_node_html(translator: SphinxTranslator, node: logo_node) -> None:
 
     for v in node["logos"].values():
 
-        # get informations from the parameters
+        # get information from the parameters
         size = SIZES[v["size"]]
         link = v["html"]
         light_logo = f"_static/logos/{v['light']}"

docs/source/cli/gdrive.rst

@@ -47,7 +47,7 @@ To download files, use the :code:`Pull` command, which will create files that do
     $ # check additional parameters by using -help flag
     $ drive pull -h
 
-This command will syncronize the files that are not present in your SEPAL session but are present in your Google Drive account folder.
+This command will synchronize the files that are not present in your SEPAL session but are present in your Google Drive account folder.
 
 Additional commands
 ^^^^^^^^^^^^^^^^^^^

docs/source/cli/gee.rst

@@ -73,7 +73,7 @@ In the first cell, create a map and place it the sidecar by running the followin
 .. thumbnail:: ../_images/cli/gee/create_a_sidecar.png
     :title: Some code that will be run in the sidecar
 
-As displayed in the previous image, the list of available sidecars is displayed on the right side of the frame. You can create as many sidecars as you want and display any widget in it. We chose to use the **sepal_ui mappping** widget as it includes key features, such as:
+As displayed in the previous image, the list of available sidecars is displayed on the right side of the frame. You can create as many sidecars as you want and display any widget in it. We chose to use the **sepal_ui mapping** widget as it includes key features, such as:
 
 - GEE full compatibility
 - an extended layer manager

docs/source/cli/index.rst

@@ -53,7 +53,7 @@ In the **Apps** section, there are three coding tools at the top of the list:
 .. 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 coresponding 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 (select 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)

docs/source/conf.py

@@ -114,7 +114,7 @@
     "footer_end": ["e-learning", "stackexchange"],
 }
 
-# -- option for the favicon extention ------------------------------------------
+# -- option for the favicon extension ------------------------------------------
 
 favicons = [
     {"rel": "apple-touch-icon", "href": "apple-touch-icon.png"},

docs/source/cookbook/ccdc_slice.rst

@@ -125,7 +125,7 @@ SEPAL offers four ways of selecting the remaining break:
 - :guilabel:`Magnitude`: The break with the highest magnitude of change.
 - :guilabel:`Confidence`: The break with the highest confidence value (for more information about confidence computation, see :doc:`ccdc`).
 
-By selecting a specific break direction, the break selection will only take into acount the break with a :guilabel:`decrease` or :guilabel:`increase` magnitude. By default, we consider :guilabel:`Any` break direction.
+By selecting a specific break direction, the break selection will only take into account the break with a :guilabel:`decrease` or :guilabel:`increase` magnitude. By default, we consider :guilabel:`Any` break direction.
 
 By moving the slider, you will ignore the break with a low confidence from the analysis. You can exclude a break up to 50 percent. If no break respects the requested confidence, the highest available will be selected.
 

docs/source/cookbook/optical_mosaic.rst

@@ -178,7 +178,7 @@ Composite
 
 .. note::
 
-    This step is optional. SEPAL provides the folowing options by default:
+    This step is optional. SEPAL provides the following options by default:
 
     -   **Correction**: :guilabel:`SR`, :guilabel:`BRDF`
     -   **Pixel filters**: No filters

docs/source/cookbook/time_series.rst

@@ -273,7 +273,7 @@ The AOI provided by the user will be divided into multiple SEPAL tiles. The AOI
 
 To limit the size of the downloaded images, in each SEPAL tile, the time period is divided into **Chunks** of 3 months. They are identified by their :code:`<chunk-<start>_<end>`. **Chunks** are image folders. As a SEPAL tile is still bigger than what GEE can download at once, the images are divided into GEE tiles. This tiling process uses its own identification system (000000xxxx-000000xxxx). Consequently, **Chunks** contain tile raster images. Each one of these images is composed of one band per observation date, with the value of the measure for each pixel. The bands are named with the date.
 
-To gather all these rasters together, a first agregation on time is performed. One :code:`stack.vrt` is created per GEE tile, meaning that each :code:`stack.vrt` file contains all the :code:`*<gee tiling id>.tif` contained in each **Chunk**, reconstituting the full time period on the smallest spatial unit: the GEE tile. Each file is stored in a folder called :code:`tile-<gee tiling id>`.
+To gather all these rasters together, a first aggregation on time is performed. One :code:`stack.vrt` is created per GEE tile, meaning that each :code:`stack.vrt` file contains all the :code:`*<gee tiling id>.tif` contained in each **Chunk**, reconstituting the full time period on the smallest spatial unit: the GEE tile. Each file is stored in a folder called :code:`tile-<gee tiling id>`.
 
 Finally, information is gathered spatially at the SEPAL tile level in the main :code:`stack.vrt` file.
 

docs/source/feature/aoi_selector.rst

@@ -31,7 +31,7 @@ There are multiple methods for selecting AOIs in SEPAL process recipes:
 -   Drawn polygons
 
 .. thumbnail:: ../_images/feature/aoi_selector/aoi_landing.png
-    :title: Three differents ways to select an AOI in SEPAL
+    :title: Three different ways to select an AOI in SEPAL
     :group: feature_aoi
     :align: center
     :width: 700

docs/source/feature/project.rst

@@ -42,7 +42,7 @@ To create a project, select :btn:`<fa-solid fa-folder-tree> Projects`, which ope
 
 Then, select :btn:`<fa-solid fa-pencil> Add` to create a new project. Enter the name and select :btn:`<fa-solid fa-check> Apply`.
 
-The newly created project will now apear in the list.
+The newly created project will now appear in the list.
 
 .. thumbnail:: ../_images/feature/project/new-project.png
     :title: Project management pop-up windows
@@ -119,7 +119,7 @@ From this interface, you can:
 Connect recipes
 ^^^^^^^^^^^^^^^
 
-When creating recipes such as :code:`Classification`, users can use other recipes as inputs for the process. To avoid flooding the dropdown list with too many values, only the recipes from the same projet will be displayed (see following figure on the left).
+When creating recipes such as :code:`Classification`, users can use other recipes as inputs for the process. To avoid flooding the dropdown list with too many values, only the recipes from the same project will be displayed (see following figure on the left).
 
 If one still wants to see all of the recipes in the dropdown list, select :btn:`All` and all recipes will be displayed using project names as headers (see following figure on right).
 

docs/source/setup/filezilla.rst

@@ -1,8 +1,8 @@
 Exchange files with SEPAL
 =========================
 
-Use SEPAL's built-in tools and FTP solutions to exhange files
--------------------------------------------------------------
+Use SEPAL's built-in tools and FTP solutions to exchange files
+--------------------------------------------------------------
 
 In this article, you can learn how to exchange files with SEPAL using:
 
@@ -137,7 +137,7 @@ Use the FTP client to interact with SEPAL
 
 Familiarize yourself with FileZilla's window layout by following this overview:
 
-Below the **Toolbar** (1) and **Quick connect bar** (2), the **Message log** (3) displays messages related to transfers and connection. Below, you can find the file listings. The left column (**Local pane**, 4) displays the local files and directories (e.g. content on the PC you're using FileZilla on). The right column (**Remote pane**, 5) displays the files and directories on the server you are connected to. Both columns have a directory tree at the top and a detailed listing of the currently selected directory's contents at the bottom. You can easily navigate either of the trees and lists by clicking around, like you would in any other file manager. In the lower section of the window, the **Transfer queue** (6) lists the status of to-be-tranferred or already transfered files.
+Below the **Toolbar** (1) and **Quick connect bar** (2), the **Message log** (3) displays messages related to transfers and connection. Below, you can find the file listings. The left column (**Local pane**, 4) displays the local files and directories (e.g. content on the PC you're using FileZilla on). The right column (**Remote pane**, 5) displays the files and directories on the server you are connected to. Both columns have a directory tree at the top and a detailed listing of the currently selected directory's contents at the bottom. You can easily navigate either of the trees and lists by clicking around, like you would in any other file manager. In the lower section of the window, the **Transfer queue** (6) lists the status of to-be-tranferred or already transferred files.
 
 .. image:: ../_images/setup/filezilla/filezilla_panel.png
 

docs/source/team/classroom.rst

@@ -31,7 +31,7 @@ If you need material for a webinar, you can either reuse one of the general clas
 
 .. tip::
 
-    If you create your own course as a combination of different modules, invite :email:`sepal.classrom@gmail.com` as a teacher and make this account the owner of the classroom. You will still be able to do everything as a teacher, but the content will be stored in a communal account.
+    If you create your own course as a combination of different modules, invite :email:`sepal.classroom@gmail.com` as a teacher and make this account the owner of the classroom. You will still be able to do everything as a teacher, but the content will be stored in a communal account.
 
 When creating basic content, you can reuse posts from other classes that you are teaching (see following image).
 

docs/source/team/contribute.rst

@@ -141,7 +141,7 @@ Here is an example:
 Icons
 """""
 
-There is a ReST role to include in-line icons in documentation (usualy when referencing a button [btn]).
+There is a ReST role to include in-line icons in documentation (usually when referencing a button [btn]).
 
 You can find the icon you're looking for in the `Font Awesome library <https://fontawesome.com/v5.15/icons?d=gallery&p=2>`__.
 
@@ -260,7 +260,7 @@ In the fork pop-up window, select the account you want to use:
 .. figure:: ../_images/team/contribute/fork_select.png
     :alt: Fork pop-up window.
 
-    Select the acount to fork.
+    Select the account to fork.
 
 In the upper-left side of the following page, you can see your location. This repository is stored in your account, but it's a fork of the original :code:`openforis/sepal-doc` file.
 
@@ -599,7 +599,7 @@ An automatic check will be performed to see if your PR can be built with ReadThe
 .. figure:: ../_images/team/contribute/ci_pr.png
     :alt: Continuous integration (CI) in PR
 
-    Continous integration will run in Github.
+    Continuous integration will run in Github.
 
 Once submitted, the SEPAL team will review your PR and make the appropriate modifications, if needed. The PR will then be accepted and the new page will be available in the main documentation.
 

docs/source/workflows/area_estimation.rst

@@ -40,7 +40,7 @@ These exercises include step-by-step directions and are built to facilitate lear
     digraph process {
            mosaic [label="Mosaic Image creation", href="#mosaic-generation-landsat-sentinel-2", shape=box];
            classif [label="Image classification", href="#image-classification", shape=box];
-           change [label="Two dates cange detection", href="#image-change-detection", shape=box];
+           change [label="Two dates change detection", href="#image-change-detection", shape=box];
            sample [label="Sample based area and error", href="#sample-based-estimation-of-area-and-accuracy", shape=box];
            doc [label="Documentation", href="#documentation-and-archiving", shape=box];
            mosaic -> classif;
@@ -1138,7 +1138,7 @@ Deforest tool
 
 The DEnse FOREst Time Series (deforest) tool is a method for detecting changes in forest cover in a time series of Earth observation data. As input, it takes a time series of forest probability measurements, producing a map of deforestation and an "early warning" map of unconfirmed changes. The method is based on the "Baysian time series" approach of `Reiche et al. (2018) <https://www.sciencedirect.com/science/article/abs/pii/S0034425717304959?via%3Dihub>`_.
 
-The tool was designed as part of the Satellite Monitoring for Forest Management (SMFM) project. The SMFM project (2017 - 2020) aimed to address global challenges relating to the monitoring of tropical dry forest ecosystems, and was conducted in partnership with teams in Mozambique, Namibia and Zambia. For more informaton, see https://www.smfm-project.com/.
+The tool was designed as part of the Satellite Monitoring for Forest Management (SMFM) project. The SMFM project (2017 - 2020) aimed to address global challenges relating to the monitoring of tropical dry forest ecosystems, and was conducted in partnership with teams in Mozambique, Namibia and Zambia. For more information, see https://www.smfm-project.com/.
 
 Full documentation is hosted at http://deforest.rtfd.io/.
 

docs/source/workflows/drivers.rst

@@ -268,7 +268,7 @@ ALOS PALSAR mosaics
 
 Radar imagery has the added benefit of being cloud-free by design, as active sensors are not influenced by clouds.
 
-The Advanced Land Observation Sattelite - Phased Array type L-band Synthetic Aperture Radar (ALOS PALSAR) is an L-band radar that gives good results for monitoring forest ecosystems. Data is provided by the Kyoto & Carbon Initiative from the Japanese Space Agency (JAXA) for the year 2015 onward. SEPAL provides an application to select; process and download them to your SEPAL workspace or GEE account.
+The Advanced Land Observation Satellite - Phased Array type L-band Synthetic Aperture Radar (ALOS PALSAR) is an L-band radar that gives good results for monitoring forest ecosystems. Data is provided by the Kyoto & Carbon Initiative from the Japanese Space Agency (JAXA) for the year 2015 onward. SEPAL provides an application to select; process and download them to your SEPAL workspace or GEE account.
 
 For more information about the parameters, please see :doc:`../modules/dwn/alos_mosaics`.
 
@@ -327,6 +327,6 @@ The analysis performed is a drivers assessment, and not a land cover change anal
 
 The project's technical committee agreed upon nine unique direct drivers and their characteristics to be used in the context of the project, as well as its piloting in Central Africa. The definitions were based on what is potentially visible and recognizable in high-resolution satellite imagery mosaics from Planet which are available over the entire study period (2015–2020). Each driver and its definition and characteristics are described in :ref:`workflows:drivers:drivers`.
 
-In order to identify direct drivers, a survey form is used in the Collect Earth Online (CEO) web platform to enable visual interpretation and identification of the presence or absence of forest, the land cover type in 2015, the type of change (deforestation or degradation) and the year of change (2015–2022), along with one ore more observed direct drivers within a 2 km wide square plot around the sample point.
+In order to identify direct drivers, a survey form is used in the Collect Earth Online (CEO) web platform to enable visual interpretation and identification of the presence or absence of forest, the land cover type in 2015, the type of change (deforestation or degradation) and the year of change (2015–2022), along with one or more observed direct drivers within a 2 km wide square plot around the sample point.
 
 .. footbibliography::