refactor(examples): more comment about each file

yoctoyotta1024 · Apr 11, 2024 · 3dc7296 · 3dc7296
1 parent ead268b
commit 3dc7296
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 26 deletions.
diff --git a/examples/boxmodelcollisions/shima2009.py b/examples/boxmodelcollisions/shima2009.py
@@ -6,7 +6,7 @@
 Author: Clara Bayley (CB)
 Additional Contributors:
 -----
-Last Modified: Monday 8th April 2024
+Last Modified: Friday 12th April 2024
 Modified By: CB
 -----
 License: BSD 3-Clause "New" or "Revised" License
@@ -15,10 +15,9 @@
 Copyright (c) 2023 MPI-M, Clara Bayley
 -----
 File Description:
-Script runs CLEO 0-D box model executables to
-of collisions with selected collision kernels (e.g.
-Golovin's or Long's) to create data and plot
-similar to Shima et al. 2009 Fig.2
+Script generates input files, runs CLEO 0-D box model executables for
+collisions with selected collision kernels (e.g. Golovin's or Long's) to create data.
+Then plots results similar to Shima et al. 2009 Fig. 2
 '''
 
 import os

diff --git a/examples/boxmodelcollisions/shima2009.sh b/examples/boxmodelcollisions/shima2009.sh
@@ -104,7 +104,6 @@ export OMP_PLACES=threads
 ### ---------------------------------------------------- ###
 
 ### ---------------------- run model ------------------- ###
-### generate input files, run executable and make plots for 1D box model example(s)
 ${python} ${path2CLEO}/examples/boxmodelcollisions/shima2009.py \
     ${path2CLEO} ${path2build} ${configfile} "golovin" "long" "lowlist"
 

diff --git a/examples/constthermo2d/constthermo2d.py b/examples/constthermo2d/constthermo2d.py
@@ -6,7 +6,7 @@
 Author: Clara Bayley (CB)
 Additional Contributors:
 -----
-Last Modified: Monday 8th April 2024
+Last Modified: Friday 12th April 2024
 Modified By: CB
 -----
 License: BSD 3-Clause "New" or "Revised" License
@@ -15,9 +15,9 @@
 Copyright (c) 2023 MPI-M, Clara Bayley
 -----
 File Description:
-Script runs CLEO executable "const2D" to create the
-data and plots precipitation example given 2-D flow
-field and constant thermodynamics read from a file
+Script generatees input files, runs CLEO executable "const2D" to create
+data and then plots precipitation example given 2-D flow field and
+constant thermodynamics read from a file.
 '''
 
 import os

diff --git a/examples/divfreemotion/divfree2d.py b/examples/divfreemotion/divfree2d.py
@@ -6,7 +6,7 @@
 Author: Clara Bayley (CB)
 Additional Contributors:
 -----
-Last Modified: Monday 8th April 2024
+Last Modified: Friday 12th April 2024
 Modified By: CB
 -----
 License: BSD 3-Clause "New" or "Revised" License
@@ -15,9 +15,9 @@
 Copyright (c) 2023 MPI-M, Clara Bayley
 -----
 File Description:
-Script runs CLEO executable "divfree2D" to create the
-data and plots for divergence free motion of
-superdroplets in a 2-D divergence free wind field
+Script generates input files, then runs CLEO executable "divfree2D" to create the
+data to then plot for divergence free motion of superdroplets in a 2-D divergence
+free wind field.
 '''
 
 import os

diff --git a/examples/rainshaft1d/rainshaft1d.py b/examples/rainshaft1d/rainshaft1d.py
@@ -6,7 +6,7 @@
 Author: Clara Bayley (CB)
 Additional Contributors:
 -----
-Last Modified: Monday 8th April 2024
+Last Modified: Friday 12th April 2024
 Modified By: CB
 -----
 License: BSD 3-Clause "New" or "Revised" License
@@ -15,9 +15,9 @@
 Copyright (c) 2023 MPI-M, Clara Bayley
 -----
 File Description:
-Script runs CLEO executable "rshaft1D" to create the
-data and plots precipitation example given constant
-1-D rainshaft thermodynamics read from a file
+Script generates input files, then runs CLEO executable "rshaft1D" to create the
+data which is then plotted to demonstrate precipitation example in 1-D rainshaft
+with constant thermodynamics read from a file.
 '''
 
 import os

diff --git a/examples/speedtest/speedtest.py b/examples/speedtest/speedtest.py
@@ -6,7 +6,7 @@
 Author: Clara Bayley (CB)
 Additional Contributors:
 -----
-Last Modified: Monday 8th April 2024
+Last Modified: Friday 12th April 2024
 Modified By: CB
 -----
 License: BSD 3-Clause "New" or "Revised" License
@@ -15,10 +15,8 @@
 Copyright (c) 2023 MPI-M, Clara Bayley
 -----
 File Description:
-Script runs CLEO executable "spdtest" to
-check performance of CLEO usign different
-build configurations (e.g. serial, OpenmP
-and CUDA parallelism).
+Script generates input files, then runs CLEO executable "spdtest" to check performance
+of CLEO usign different build configurations (e.g. serial, OpenmP and CUDA parallelism).
 '''
 
 import os

diff --git a/examples/yac/fromfile/yac1_fromfile.py b/examples/yac/fromfile/yac1_fromfile.py
@@ -6,7 +6,7 @@
 Author: Clara Bayley (CB)
 Additional Contributors:
 -----
-Last Modified: Tuesday 9th April 2024
+Last Modified: Friday 12th April 2024
 Modified By: CB
 -----
 License: BSD 3-Clause "New" or "Revised" License
@@ -15,8 +15,9 @@
 Copyright (c) 2023 MPI-M, Clara Bayley
 -----
 File Description:
-Script runs CLEO executable for 3D example with time varying thermodynamics
-read from binary files to test that YAC can send the data to CLEO correctly.
+Script generates input files, then runs CLEO executable for 3D example with time varying
+thermodynamics read from binary files to test that YAC can send the data to CLEO correctly.
+Plots output data as .png files for visual checks.
 '''
 
 import os