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 damage_proxy_map.rst #465

Closed
wants to merge 1 commit into from
Closed

Update damage_proxy_map.rst #465

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
19 changes: 8 additions & 11 deletions docs/source/modules/dwn/damage_proxy_map.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
Damage proxy maps
=================

**Damage proxy maps based on coherence change detection**

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.
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).

The files are found within a newly created folder. The folder name is based on the name of your 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 @@ -21,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 @@ -30,16 +27,16 @@ Using the provided AOI selector, select an AOI of your choice between the differ
Parameters
----------

- Disaster event date: Pick the date where the disaster event happened.
- Copernicus credentials: Provide your Sci-Hub credentials for search and download of the 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 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 or browser tab.)
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 the processing does not finish, you can rerun the module with the same parameters, and the 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.
Once the computation has 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

Expand Down