From 1fc37e333b9695dacf837600b1dc74642b6fcdbb Mon Sep 17 00:00:00 2001 From: "algodeveloper1@free.fr" <algodeveloper1@free.fr> Date: Wed, 6 Jan 2021 19:16:58 +0000 Subject: [PATCH] add doc --- conf/configuration.properties | 1 - doc/documentation.md | 28 ++++++++++++---------------- 2 files changed, 12 insertions(+), 17 deletions(-) diff --git a/conf/configuration.properties b/conf/configuration.properties index 45befbd..371bb8b 100644 --- a/conf/configuration.properties +++ b/conf/configuration.properties @@ -1,6 +1,5 @@ # Inputs s2_folder = S2A_MSIL2A_20201129T110421_N0214_R094_T30TXQ_20201129T135030.SAFE -#s2_folder = /projects/read_s2/input/MTD_MSIL2A.xml # Outputs diff --git a/doc/documentation.md b/doc/documentation.md index 938285b..dc16657 100644 --- a/doc/documentation.md +++ b/doc/documentation.md @@ -1,27 +1,23 @@ ## Short description of the algorithm - +Downloads the S2 _ ***.SAFE.tar folder from S3 and untar it. Then reads the Sentinel 2 metadata (MTD_MSIL2A.xml and MTD_TL.xml) and creates the dictionaries:* Bands_10m.pkl : all path to data with 10 meters resolution +* Bands_20m.pkl : all path to data with 20 meters resolution +* Bands_60m.pkl : all path to data with 60 meters resolution +* Tile_metadata.pkl : all informations about the tiles +* Mask_esa.pkl : all path to ESA masks ## Description of data used * Description of inputs + * **s2_folder**: name of the S2 folder in S3 (S2_***.SAFE without the .tar) * Description of outputs - - - -## Description of the different functions -* Function 1 - * Short description - * Description of inputs - * Description of outputs - - -* Function 2 - * Short description - * Description of inputs - * Description of outputs - + * **output**: path to the read_s2 output directory + * **bands_10m**: name of the dictionary for data with 10 meters resolution + * **bands_20m**: name of the dictionary for data with 20 meters resolution + * **bands_60m**: name of the dictionary for data with 60 meters resolution + * **tile_meta**: name of the dictionary for informations about the tiles + * **mask_meta**: name of the dictionary for ESA masks -- GitLab