doc string description for defaults/objects/simulation/utils sub-modules (#1005)

For all scripts within `defaults/objects/simulation/utils` sub-modules:

+ add a doc string at the top to describe its purpose

+ remove `#!` at the top from the remaining scripts (most scripts are already like that), since they are not needed.

Author: yunjunz

src/mintpy/defaults/auto_path.py

@@ -1,9 +1,10 @@
+"""Utilities for automatic configuration fo input file pathes"""
 ############################################################
 # Program is part of MintPy                                #
 # Copyright (c) 2013, Zhang Yunjun, Heresh Fattahi         #
 # Author: Zhang Yunjun, Mar 2018                           #
 ############################################################
-# recommended usage:
+# Recommended usage:
 #   from mintpy.defaults import auto_path
 
 

src/mintpy/defaults/template.py

@@ -1,11 +1,11 @@
+"""Utilities to grab template content for processing steps."""
 ############################################################
 # Program is part of MintPy                                #
 # Copyright (c) 2013, Zhang Yunjun, Heresh Fattahi         #
 # Author: Zhang Yunjun, Mar 2020                           #
 ############################################################
-# recommend usage:
+# Recommend usage:
 #   from mintpy.defaults.template import STEP_LIST, get_template_content
-#
 
 
 import os

src/mintpy/objects/cluster.py

@@ -1,11 +1,11 @@
-#!/usr/bin/env python3
+"""Class wrapped around Dask for parallel computing."""
 #############################################################
 # Program is part of MintPy                                 #
 # Copyright (c) 2013, Zhang Yunjun, Heresh Fattahi          #
 # Author: Joshua Zahner, David Grossman, Zhang Yunjun, 2020 #
 #############################################################
 # Recommend import:
-#     from mintpy.objects import cluster
+#   from mintpy.objects import cluster
 
 
 import glob

src/mintpy/objects/colors.py

@@ -1,3 +1,4 @@
+"""Class wrapped around matplotlib.colors for colormaps."""
 ############################################################
 # Program is part of MintPy                                #
 # Copyright (c) 2013, Zhang Yunjun, Heresh Fattahi         #

src/mintpy/objects/conncomp.py

@@ -1,3 +1,4 @@
+"""Class / utilities for connected components."""
 ############################################################
 # Program is part of MintPy                                #
 # Copyright (c) 2013, Zhang Yunjun, Heresh Fattahi         #

src/mintpy/objects/coord.py

@@ -1,3 +1,4 @@
+"""Class for (radar/geo) coordinates conversion."""
 ############################################################
 # Program is part of MintPy                                #
 # Copyright (c) 2013, Zhang Yunjun, Heresh Fattahi         #

src/mintpy/objects/euler_pole.py

@@ -1,4 +1,4 @@
-"""Euler Pole class definition and utility functions."""
+"""Class / utilities for Euler Pole / plate motion (models)."""
 ############################################################
 # Program is part of MintPy                                #
 # Copyright (c) 2013, Zhang Yunjun, Heresh Fattahi         #

src/mintpy/objects/giant.py

@@ -1,11 +1,11 @@
+"""Classes for HDF5/GIAnT file operations"""
 ############################################################
 # Program is part of MintPy                                #
 # Copyright (c) 2013, Zhang Yunjun, Heresh Fattahi         #
 # Author: Zhang Yunjun, 2018                               #
 ############################################################
-# class used for file operation within MintPy
 # Recommend import:
-#     from mintpy.objects import giantTimeseries, giantIfgramStack
+#   from mintpy.objects import giantTimeseries, giantIfgramStack
 
 import os
 from datetime import datetime as dt

src/mintpy/objects/gps.py

@@ -1,9 +1,9 @@
+"""Class / utilities for GPS download / operations."""
 ############################################################
 # Program is part of MintPy                                #
 # Copyright (c) 2013, Zhang Yunjun, Heresh Fattahi         #
 # Author: Zhang Yunjun, Jul 2018                           #
 ############################################################
-# Utility scripts for GPS handling
 # Recommend import:
 #     from mintpy.objects.gps import GPS
 

src/mintpy/objects/insar_vs_gps.py

@@ -1,3 +1,4 @@
+"""Class for comparing InSAR with GPS."""
 ############################################################
 # Program is part of MintPy                                #
 # Copyright (c) 2013, Zhang Yunjun, Heresh Fattahi         #