From e751a63efd8319f95ddc8f93c63e3656ddc9cada Mon Sep 17 00:00:00 2001
From: Remi Cresson <remi.cresson@irstea.fr>
Date: Fri, 13 May 2022 17:00:16 +0200
Subject: [PATCH] DOC: add applications doc

---
 apps/drs_spot67_import.py |  9 +++++++++
 apps/s2_download.py       | 10 ++++++++++
 apps/s2_import.py         |  3 +++
 apps/search.py            |  3 +++
 4 files changed, 25 insertions(+)

diff --git a/apps/drs_spot67_import.py b/apps/drs_spot67_import.py
index d8b5ec5..2acc677 100755
--- a/apps/drs_spot67_import.py
+++ b/apps/drs_spot67_import.py
@@ -1,4 +1,13 @@
 #!/usr/bin/env python3
+"""
+This application enables to search existing Spot-6/7 products from different locations, and save a pickle object
+containing all the `scene.spot.Spot67Scene` instances
+
+``` command-line
+drs_spot67_import --root_dirs /ortho_drs/2018/ /ortho_drs/2019 --out_pickle collection
+```
+
+"""
 import argparse
 from scenes import save_scenes
 from scenes.spot import get_spot67_scenes
diff --git a/apps/s2_download.py b/apps/s2_download.py
index def6bf0..f9c9aa5 100755
--- a/apps/s2_download.py
+++ b/apps/s2_download.py
@@ -1,4 +1,14 @@
 #!/usr/bin/env python3
+"""
+This application enables to download all Sentinel-2 images overlapping a reference raster, and acquired at a specific
+ date, from the Theia land data center.
+The Theia credential have to be provided.
+
+``` command-line
+s2_download --refimage raster.tif --theia_cfg ~/cfg.txt --download_dir /tmp --year 2022 --month 12 --day 1
+```
+
+"""
 import argparse
 from scenes import TheiaDownloader, raster
 import datetime
diff --git a/apps/s2_import.py b/apps/s2_import.py
index b2d31f6..d8790a4 100755
--- a/apps/s2_import.py
+++ b/apps/s2_import.py
@@ -1,4 +1,7 @@
 #!/usr/bin/env python3
+"""
+This application enables to save a collection of Sentinel-2 image into a pickel object.
+"""
 import argparse
 from scenes import save_scenes
 from scenes.sentinel import get_local_scenes
diff --git a/apps/search.py b/apps/search.py
index 1aa30e1..9682f5a 100755
--- a/apps/search.py
+++ b/apps/search.py
@@ -1,4 +1,7 @@
 #!/usr/bin/env python3
+"""
+This application enables to perform a spatial query over a collection of image, from the specific ROI (vector or raster)
+"""
 import argparse
 from scenes import load_scenes, Index, raster, vector
 
-- 
GitLab