From 99f477a2d6b324598a727102dfcb469ff77b1bf0 Mon Sep 17 00:00:00 2001
From: Abdussalam SALEH MGHIR <salehma@visu04.sis.cnes.fr>
Date: Wed, 6 Oct 2021 15:19:15 +0000
Subject: [PATCH] ENH : Add PythonAPI repertory in rst

---
 doc_cookbook/rst/PythonAPI/pythonAPI.md | 110 ++++++++++++++++++++++++
 1 file changed, 110 insertions(+)
 create mode 100644 doc_cookbook/rst/PythonAPI/pythonAPI.md

diff --git a/doc_cookbook/rst/PythonAPI/pythonAPI.md b/doc_cookbook/rst/PythonAPI/pythonAPI.md
new file mode 100644
index 0000000..13d368d
--- /dev/null
+++ b/doc_cookbook/rst/PythonAPI/pythonAPI.md
@@ -0,0 +1,110 @@
+# Python API (python_src/)
+
+## Description
+
+The python_src was organized with two packages : processings and utils. 
+
+The first one contains the main processings chains such as DInSAR, Ground or Pre_Processing. Utils package is a general module with a pool of useful functions and an API to launch OTB or DiapOTB applications from Python.
+
+
+Our four main scripts (SAR_MultiSlc.py, SAR_MultiSlc_IW.py, diapOTB.py and diapOTB_S1IW.py) use processing and utils modules with these following connexions :
+
+![image](../Art/PythonAPI/python_src.png)
+
+
+## Packages
+
+
+* [processings package](processings) 
+
+
+    * Submodules
+
+
+    * processings.DInSar module
+
+
+        * The `DINSAR` chain
+
+
+            * main function : gridToInterferogram
+
+
+    * processings.Ground module
+
+
+        * The `Ground` chain
+
+
+            * main function : demProjectionAndCartesianEstimation
+
+
+    * processings.Metadata_Correction module
+
+
+        * The `Metadata Correction` chain
+
+
+            * main function : metadataCorrection
+
+
+    * processings.Post_Processing module
+
+
+        * The `Post_Processing` chain
+
+
+            * main function : filtering
+
+
+    * processings.Pre_Processing module
+
+
+        * The `Pre_Processing` chain
+
+
+            * main function : extractToMultilook
+
+
+    * Module contents
+
+
+* [utils package](utils)
+
+
+    * Submodules
+
+    * utils.DiapOTB_applications module
+
+
+        * DiapOTB applications
+
+
+            * Applications list :
+
+
+    * utils.addGCP module
+
+
+        * addGCP.py
+
+
+    * utils.func_utils module
+
+
+        * func_utils module
+
+
+    * utils.generateConfigFile module
+
+
+        * generateConfigFile.py
+
+
+    * utils.getEOFFromESA module
+
+
+        * getEOFFromESA.py
+		
+		
+    * Module contents
-- 
GitLab