fix typos in input_params

examples/01_checkerboard_azimuthal_ani/input_params.yml

@@ -9,7 +9,7 @@ data:
   # Love-wave source-receiver files (used when wave_type[1] is true)
   src_rec_file_lv_ph: OUTPUT_FILES/src_rec_file_forward_LV_PH.csv
   src_rec_file_lv_gr: OUTPUT_FILES/src_rec_file_forward_LV_GR.csv
-  wave_type: [True, False] # [use_rayleigh, use_love] - both required for radial anisotropy
+  wave_type: [True, False] # [use_rayleigh, use_love]
   vel_type:  [True, False] # [use_phase, use_group]
   weights:   [1.0, 0.5]    # weights for phase and group velocity
 
@@ -26,9 +26,9 @@ domain:
   grid_method_0:
     interval: [0.02, 0.02, 0.5] # interval of lon(degree), lat(degree), z(km)
     num_grid_margin: 5 # number of grid margin
-  grid_method_1:
-    lon_min_max: [119.5, 120.5]
-    lat_min_max: [29.5, 30.5]
+  grid_method_1: # only read when grid_method: 1; values below describe the same domain as grid_method_0
+    lon_min_max: [101.8, 104.2] # longitude range in degree
+    lat_min_max: [23.8, 26.2] # latitude range in degree
     n_grid: [100, 100, 30] # number of grid in lon, lat, z
 
 model:
@@ -39,13 +39,13 @@ model:
 
 topo:
   is_consider_topo: False # whether consider topography
-  topo_file: /path/to/topo.grd # Path to local elevation file. Only valid in topo_type: 1 and 2
+  topo_file: /path/to/topo.grd # Path to local elevation file. Only valid when is_consider_topo: True
   wavelen_factor: 2.5
 
 postproc:
   kdensity_coe: 0  # Kdensity_coe is used to rescale the final kernel:  kernel -> kernel / pow(density of kernel, Kdensity_coe).
   independent_smooth_ani: False # if True, smooth azimuthal anisotropy (Gc/Gs) kernels with sigma_ani / n_inv_grid_ani
-  smooth_method: 0
+  smooth_method: 0 # 0: PDE (Gaussian) smoothing; 1: multigrid smoothing
   smooth_method_0:
     sigma: [0.1, 1] # smoothing lengths [horizontal (degree), vertical (km)]
     sigma_ani: [0.15, 1] # same units as sigma; azimuthal anisotropy (Gc/Gs) kernels only, ignored for radial anisotropy (gamma uses sigma)
@@ -59,12 +59,12 @@ inversion:
   model_para_type: 1 # 0 Isotropic, 1 Azimuthal anisotropy, 2 Radial anisotropy
   use_alpha_beta_rho: false
   rho_scaling: false
-  vpvs_ratio_range: [1.4, 2.5]
-  # ------- Inversion parameters --------
-  niter: 80 # max iterations
+  vpvs_ratio_range: [1.4, 2.5] # clamp range of vp/vs. Only used when use_alpha_beta_rho: True
+  # ------- Iteration control -------
+  niter: 40 # max iterations
   min_derr: 0.0015 # minimum error change
   # ------- optimization parameters -------
-  optim_method: 1 # 0: SD (adeptive step length); 1: LBFGS (line search)
+  optim_method: 1 # 0: SD (adaptive step length); 1: LBFGS (line search)
   step_length: 0.02 # starting step length
   maxshrink: 0.6 # max step length descent
   # ------- Line search for LBFGS -------

examples/02_checkerboard_radial_ani/input_params.yml

@@ -26,9 +26,9 @@ domain:
   grid_method_0:
     interval: [0.02, 0.02, 0.2] # interval of lon(degree), lat(degree), z(km)
     num_grid_margin: 5 # number of grid margin
-  grid_method_1:
-    lon_min_max: [119.5, 120.5]
-    lat_min_max: [29.5, 30.5]
+  grid_method_1: # only read when grid_method: 1; values below describe the same domain as grid_method_0
+    lon_min_max: [101.95, 104.05] # longitude range in degree
+    lat_min_max: [23.95, 26.05] # latitude range in degree
     n_grid: [100, 100, 30] # number of grid in lon, lat, z
 
 model:
@@ -39,13 +39,13 @@ model:
 
 topo:
   is_consider_topo: False # whether consider topography
-  topo_file: /path/to/topo.grd # Path to local elevation file. Only valid in topo_type: 1 and 2
+  topo_file: /path/to/topo.grd # Path to local elevation file. Only valid when is_consider_topo: True
   wavelen_factor: 2.5
 
 postproc:
   kdensity_coe: 0  # Kdensity_coe is used to rescale the final kernel:  kernel -> kernel / pow(density of kernel, Kdensity_coe).
   independent_smooth_ani: False # if True, smooth azimuthal anisotropy (Gc/Gs) kernels with sigma_ani / n_inv_grid_ani
-  smooth_method: 0
+  smooth_method: 0 # 0: PDE (Gaussian) smoothing; 1: multigrid smoothing
   smooth_method_0:
     sigma: [0.1, 2] # smoothing lengths [horizontal (degree), vertical (km)]
     sigma_ani: [0.1, 2] # same units as sigma; azimuthal anisotropy (Gc/Gs) kernels only, ignored for radial anisotropy (gamma uses sigma)
@@ -59,12 +59,12 @@ inversion:
   model_para_type: 2 # 0 Isotropic, 1 Azimuthal anisotropy, 2 Radial anisotropy
   use_alpha_beta_rho: false
   rho_scaling: false
-  vpvs_ratio_range: [1.4, 2.5]
-  # ------- Inversion parameters --------
+  vpvs_ratio_range: [1.4, 2.5] # clamp range of vp/vs. Only used when use_alpha_beta_rho: True
+  # ------- Iteration control -------
   niter: 40 # max iterations
   min_derr: 0.0015 # minimum error change
   # ------- optimization parameters -------
-  optim_method: 1 # 0: SD (adeptive step length); 1: LBFGS (line search)
+  optim_method: 1 # 0: SD (adaptive step length); 1: LBFGS (line search)
   step_length: 0.02 # starting step length
   maxshrink: 0.6 # max step length descent
   # ------- Line search for LBFGS -------

examples/04_hawaii_topo/input_params.yml

@@ -22,6 +22,10 @@ domain:
   grid_method_0:
     interval: [0.01, 0.01, 0.5] # interval of lon(degree), lat(degree), z(km)
     num_grid_margin: 5 # number of grid margin
+  grid_method_1: # only read when grid_method: 1; values below describe the same domain as grid_method_0
+    lon_min_max: [-0.52, 0.66] # longitude range in degree (rotated frame, see rotatation.ipynb)
+    lat_min_max: [-0.47, 0.48] # latitude range in degree (rotated frame)
+    n_grid: [120, 100, 31] # number of grid in lon, lat, z
 
 model:
   # ------- Initial model --------
@@ -31,16 +35,16 @@ model:
 
 topo:
   is_consider_topo: True # whether consider topography
-  topo_file: hawaii_rotated.nc # Path to local elevation file. Only valid in topo_type: 1 and 2
+  topo_file: hawaii_rotated.nc # Path to local elevation file. Only valid when is_consider_topo: True
   wavelen_factor: 2.5
 
 postproc:
-  kdensity_coe: 1  # Kdensity_coe is used to rescale the final kernel:  kernel -> kernel / pow(density of kernel, Kdensity_coe).
+  kdensity_coe: 0.0  # Kdensity_coe is used to rescale the final kernel:  kernel -> kernel / pow(density of kernel, Kdensity_coe).
   independent_smooth_ani: False # if True, smooth azimuthal anisotropy (Gc/Gs) kernels with sigma_ani / n_inv_grid_ani
   smooth_method: 1 # 0: PDE (Gaussian) smoothing; 1: multigrid smoothing
   smooth_method_0:
-    sigma: [0.1, 2] # smoothing lengths [horizontal (degree), vertical (km)]
-    sigma_ani: [0.1, 2] # same units as sigma; azimuthal anisotropy (Gc/Gs) kernels only, ignored for radial anisotropy (gamma uses sigma)
+    sigma: [0.12, 1.5] # smoothing lengths [horizontal (degree), vertical (km)]
+    sigma_ani: [0.12, 1.5] # same units as sigma; azimuthal anisotropy (Gc/Gs) kernels only, ignored for radial anisotropy (gamma uses sigma)
   smooth_method_1:
     n_inv_components: 5
     n_inv_grid: [8, 9, 10]
@@ -49,13 +53,14 @@ postproc:
 inversion:
   # ------- Inversion parameters --------
   model_para_type: 0 # 0 Isotropic, 1 Azimuthal anisotropy, 2 Radial anisotropy
-  use_alpha_beta_rho: true
-  rho_scaling: true
-  # ------- Inversion parameters --------
+  use_alpha_beta_rho: false
+  rho_scaling: false
+  vpvs_ratio_range: [1.4, 2.5] # clamp range of vp/vs. Only used when use_alpha_beta_rho: True
+  # ------- Iteration control -------
   niter: 40 # max iterations
   min_derr: 0.0001 # minimum error change
   # ------- optimization parameters -------
-  optim_method: 1 # 0: SD (adeptive step length); 1: LBFGS (line search)
+  optim_method: 0 # 0: SD (adaptive step length); 1: LBFGS (line search)
   step_length: 0.02 # starting step length
   maxshrink: 0.6 # max step length descent
   # ------- Line search for LBFGS -------