[docs](test): Update tests documentation

Dirack · Mar 7, 2024 · 13413b3 · 13413b3
1 parent cd3f5c8
commit 13413b3
Show file tree

Hide file tree

Showing 10 changed files with 38 additions and 12 deletions.
diff --git a/test/bug/issue_32/Makefile b/test/bug/issue_32/Makefile
@@ -1,6 +1,6 @@
 # Makefile
 #
-# Purpose: Run tests for libraries and functions.
+# Purpose: Run tests for bug related on issue 32.
 # 
 # Site: https://www.geofisicando.com
 # 

diff --git a/test/bug/issue_46/Makefile b/test/bug/issue_46/Makefile
@@ -1,6 +1,6 @@
 # Makefile
 #
-# Purpose: Run tests related with issue #46.
+# Purpose: Run tests related with issue 46.
 # 
 # Site: https://www.geofisicando.com
 # 

diff --git a/test/bug/issue_46/Test_nhcrssurf_lib.c b/test/bug/issue_46/Test_nhcrssurf_lib.c
@@ -1,7 +1,7 @@
 /*
 * Test_nhcrssurf.c (C)
 * 
-* Purpose: Test of the functions in the library of the program 'Mnhcrssurf.c'.
+* Purpose: Test for bug related on issue 46.
 * 
 * Site: https://www.geofisicando.com
 * 

diff --git a/test/search_window/varlim/SConstruct b/test/search_window/varlim/SConstruct
@@ -20,7 +20,6 @@ from rsf.proj import *
 import math
 
 __author__="Rodolfo Dirack <rodolfo_profissional@hotmail.com>"
-__version__="1.0"
 __site__="https://www.geofisicando.com"
 
 Help('''
@@ -31,9 +30,8 @@ Help('''
     global optimization
 
     Author: %s
-    Version: %s
     Site: %s
-    ''' % (__author__,__version__,__site__))
+    ''' % (__author__,__site__))
 
 Help('''
 ### Kirchhoff modeling ###

diff --git a/test/test_parameters/convergence_graph/README.md b/test/test_parameters/convergence_graph/README.md
@@ -1,3 +1,9 @@
 # Generate convergence graph for VFSA
 
-A convergence graph is a graph of Semblance x iteration
+A convergence graph is a graph of Semblance x iteration
+
+Run this test with scons:
+
+```
+scons view
+```
diff --git a/test/test_parameters/fixed_temp0/README.md b/test/test_parameters/fixed_temp0/README.md
@@ -1,3 +1,9 @@
 # Generate a convergence surface -  Fixed temp0
 
-In this test of parameters fix temp0 and generate a semblance surface of C0 x number of iterations
+In this test of parameters fix temp0 and generate a semblance surface of C0 x number of iterations
+
+Run this test with make:
+
+```
+make view
+```
diff --git a/test/test_parameters/fixed_trial_moves/README.md b/test/test_parameters/fixed_trial_moves/README.md
@@ -1,3 +1,9 @@
 # Generate a convergence surface -  Fixed Number of iterations
 
-In this test of parameters fix the number of iterations and generate a semblance surface of C0 x temp0
+In this test of parameters fix the number of iterations and generate a semblance surface of C0 x temp0
+
+Run this test with make:
+
+```
+make view
+```
diff --git a/test/test_parameters/mt_convergence_graph/README.md b/test/test_parameters/mt_convergence_graph/README.md
@@ -2,3 +2,9 @@
 
 This test generate a convergence graph for multi thread execution with vfsa. This multi thread execution is controled by the repeat parameter.
 The value of the repeat parameter is the number of threads used in vfsa optimization
+
+Run this test with scons (pass the number of threads to be used with the ngraphs parameter):
+
+```
+scons view ngraphs=5
+```
diff --git a/test/test_parameters/mt_convergence_graph/SConstruct b/test/test_parameters/mt_convergence_graph/SConstruct
@@ -21,7 +21,6 @@ import math
 import subprocess
 
 __author__="Rodolfo Dirack <rodolfo_profissional@hotmail.com>"
-__version__="1.0"
 __site__="https://www.geofisicando.com"
 
 Help('''
@@ -32,9 +31,8 @@ Help('''
     global optimization
 
     Author: %s
-    Version: %s
     Site: %s
-    ''' % (__author__,__version__,__site__))
+    ''' % (__author__,__site__))
 
 Help('''
 ### Kirchhoff modeling ###

diff --git a/test/test_parameters/mt_fixed_temp0_c0/README.md b/test/test_parameters/mt_fixed_temp0_c0/README.md
@@ -1,3 +1,9 @@
 # Generate a semblance surface for multi thread execution
 
 This test generate a semblance surface for number of threads x number of iterations. The parameters temp0 and C0 are fixed
+
+Run this test with make:
+
+```
+make view
+```