readme edit

alti_read/readsa3.py

@@ -1,6 +1,12 @@
 #!/usr/bin/python
 # coding=utf-8
 
+# Main functions:
+# -Read Sentinel-3 A/B altimeter GDR data
+# -Calculate the 20Hz water level over lakes and wide rivers
+# -Plot waveforms of the altimeter. From the waveforms, the surface could be determined, such as sea ice, calm water, ocean.
+#
+
 from netCDF4 import Dataset
 import numpy as np
 import matplotlib.pyplot as plt
@@ -27,7 +33,7 @@
 pass_num = 260  # 152,260 for S3A; 317 For S3B
 s_model = "LAN"  # define the data mode: `LAN` (land) or `MAR` (marine)
 plot_wave = "no"  # Plot wave form. `yes` or `no`
-site = "jiujiang"  # choose the site. `jiujiang`| `py_lake`
+site = "py_lake"  # choose the site. `jiujiang`| `py_lake`
 output_name = "no"  # If output the names of the variables.
 # define the latitude boundary
 if pass_num == 152:
@@ -300,4 +306,4 @@
         fh.write(str(i)+'\n')
     fh.close()
 else:
-    print("data are not correct")
+    print("You choose not to output the variables to file")

readme.md

@@ -1,21 +1,30 @@
 # Read me
 
 ## Introduction 
-This software is aimed to read satellite altimetry data of the netCDF format. It is not finished yet!!!
+This software is aimed to read satellite altimetry data of the netCDF format. It is still undergoing development. More functions will be added in future, such as the waveform retracking over lakes, AI application on waveform determination, sea ice thickness estimation.
+
 The netCDF4 lib is used under python3.
 This software is aimed to:
 - Read Sentinel-3A SRAL data, including the waveform data, analysis data and show data in
 figures.
 - Apply AI algorithm to the waveform data to classify sea ice and sea water in the arctic ocean.
 - ...
-## data example
+
+## Snapshot of Examples
 You can download data example from [here](https://www.jianguoyun.com/p/DfGdEB8Q2PCQBxidq9YC).
 
 The waveform will be plotted as:
 ![](waveform.png)
+In the future, I will add the surface type determination (sea ice types, ponds in Arctic,etc.) by AI.
 
 The time series of AVISO MMS over South China Sea will be plotted like:
 ![](ssh.png)
+The seasonal signals were not excluded here. 
+
+The water level of the Poyang Lake during the flood will be estimated like (without data filtering and waveform retracking):
+<center class = "half">
+<img src = “wls.png”  width = “50%” align = left><img src = pylake.png  width = “50%” align = right>
+</center>
 
 ## usage
 - Download the py file and example data.