Skip to content

Commit

Permalink
docs: proofreading complete
Browse files Browse the repository at this point in the history
  • Loading branch information
dfguerrerom committed Dec 11, 2023
1 parent 63df071 commit 19f46ba
Showing 1 changed file with 10 additions and 16 deletions.
26 changes: 10 additions & 16 deletions doc/en.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
Damage proxy maps
=================
**Damage proxy maps based on coherence change detection**

Damage proxy maps based on coherence change detection (CCD)
-----------------------------------------------------------
This module provides a fully automated workflow for the creation of damage proxy maps based on the method of coherent change detection (CCD) with Sentinel-1 SLC data, as described by `Tay et al. (2020) <https://www.nature.com/articles/s41597-020-0443-5>`_ (SLC refers to Single Look Complex).

This module provides a fully automated workflow for the creation of damage proxy maps based on the method of coherent change detection (CCD) with Sentinel-1 SLC data, as described by `Tay et al. (2020) <https://www.nature.com/articles/s41597-020-0443-5>`_.

The output data files consist of the damage proxy map as GeoTiff (*dmp_...tif*) and KMZ (*dmp_...kmz*) files, as well as the raw CCD values in GeoTiff (*CCD_...tif*) and GeoJSON (*CCD_...geojson*) formats.

The files are found within a newly created folder. The folder name is based on the name of your area of interest (AOI) and the event date.
The output data files consist of the damage proxy map as GeoTiff (*dmp_...tif*) and KMZ (*dmp_...kmz*) files, as well as the raw CCD values in GeoTiff (*CCD_...tif*) and GeoJSON (*CCD_...geojson*) formats. The files are found within a newly created folder. The folder name is based on the name of your AOI and the event date.

.. attention::

Expand All @@ -22,7 +18,7 @@ The two steps of the process are explained in the following section.
Select an AOI
-------------

Using the provided AOI selector, select an AOI of your choice between the different methods available in the tool. We provide three administration descriptions (from Level 0 to Level 2) and three custom shapes (drawn directly on the map or OGR-compatible files).
Using the provided **AOI selector**, select an AOI of your choice between the different methods available in the tool. We provide three administration descriptions (from Level 0 to Level 2) and three custom shapes (drawn directly on the map or OGR-compatible files).

.. figure:: https://raw.githubusercontent.com/sepal-contrib/damage_proxy_maps/main/doc/img/aoi_select.png

Expand All @@ -31,17 +27,15 @@ Using the provided AOI selector, select an AOI of your choice between the differ
Parameters
----------

- Disaster event date: Choose the date where the disaster event happened.
- Copernicus credentials: Provide your Sci-Hub credentials for searching and downloading relevant Sentinel-1 scenes (if you do not have an account, register with `Copernicus Sci-Hub <https://scihub.copernicus.eu/>`_).
- **Disaster event date**: Choose the date where the disaster event happened.
- **Copernicus credentials**: Provide your Sci-Hub credentials for searching and downloading relevant Sentinel-1 scenes. If you do not have an account, register with `Copernicus Sci-Hub <https://scihub.copernicus.eu/>`_.

Selecting this button will trigger the full workflow. (Note: Some of the steps such as downloading and processing may take a while. If you have an unstable internet connection, set the minimum runtime of your instance to two hours; otherwise, stay connected to the SEPAL website by keeping your browser and corresponding browser tab open.)
Selecting this button will trigger the full workflow (Note: Some of the steps may take a while, such as downloading and processing, so if you have an unstable internet connection, set the minimum runtime of your instance to two hours; otherwise, stay connected to the SEPAL website by neither closing your browser nor browser tab.)

.. note::

If processing does not finish, you can rerun the module with the same parameters and processing will continue from where it stopped.
If the processing does not finish, you can rerun the module with the same parameters and it will continue from where it stopped.

Once the computation is finished, the result files will be stored in the :code:`module_results/Damage_proxy_map/<aoi name>_<event date>/` folder.

.. figure:: https://raw.githubusercontent.com/sepal-contrib/damage_proxy_maps/main/doc/img/complete.png
Once the computation has finished, the result files will be stored in the :code:`module_results/Damage_proxy_map/<aoi name>_<event date>/` folder.

.. custom-edit:: https://raw.githubusercontent.com/sepal-contrib/damage_proxy_maps/release/doc/en.rst
.. figure:: https://raw.githubusercontent.com/sepal-contrib/damage_proxy_maps/main/doc/img/complete.png

0 comments on commit 19f46ba

Please sign in to comment.