Replace from_vicondar_to_cs_files.py

python_scripts/example/from_vicondar_to_cs_files.py

@@ -9,6 +9,20 @@ create inputs to the constrained simulation framework.
 
 CS: stands for Constrained simulation framework 
 
+Note that as a convention the output filenames from vicondar 
+have wind field characteristics incorporated, e.g.,: 
+
+   "uval_av_sens_dist_Sh20_SD01_V06_TI08_s1000_circ7p_vol30.mat"
+   
+   Sh (Shear) = 0.2 [-]
+   V (Wind speed) = 6 m/s
+   TI (Turbulence intensity) = 0.08 [-]
+   s (seed) = 1000
+   circ7p = lidar scanning configuration's name 
+   vol (lidar's probe volume) = 30 [m]
+   
+The user can easily change this convention and adjust this script accordingly. 
+
 """
 
 import numpy as np 
@@ -91,8 +105,7 @@ for filename in os.listdir(PATH_VICONDAR_OUTPUT):
         # Load VICONDAR outputs
         test_mat=scipy.io.loadmat(PATH_VICONDAR_OUTPUT + '/%s' %filename)
         u_lidar = test_mat['uval'][0].reshape(-1)
-        t_lidar = test_mat['time'][0].reshape(-1)
-        
+        t_lidar = test_mat['time'][0].reshape(-1)  
         
         # Center the lidar pattern to the turbulence box
         y_lidar = Yvalues[int(len(Yvalues)/2)] +  y_lidar[~np.isnan(y_lidar)] 
@@ -181,17 +194,17 @@ for filename in os.listdir(PATH_VICONDAR_OUTPUT):
         
         filename.write('\n#Initialization of variables:')
         filename.write('\nInput={} \n')
-        filename.write("\nInput['Udatafile']=" + "'./turb%s_ti%s_av_setbu.bin'" %(tu_seed,int(TI_amb)))  
-        filename.write("\nInput['Vdatafile']=" + "'turb%s_av_setbv.bin'" %(tu_seed))
-        filename.write("\nInput['Wdatafile']=" + "'turb%s_av_setbw.bin'" %(tu_seed))
-        filename.write("\nInput['LidarSys']=" + "'%s'" %LidarSys)
+        filename.write("\nInput['Udatafile']=" + "'./turb%s_ti%s_av_setbu.bin'" %(tu_seed,int(TI_amb)))  # Input name of the unconstrained turb. box
+        filename.write("\nInput['Vdatafile']=" + "'turb%s_av_setbv.bin'" %(tu_seed)) # Input name of the unconstrained turb. box
+        filename.write("\nInput['Wdatafile']=" + "'turb%s_av_setbw.bin'" %(tu_seed)) # Input name of the unconstrained turb. box
+        filename.write("\nInput['LidarSys']=" + "'%s'" %LidarSys) # Lidar configuration 
         filename.write("\nInput['CrossSpectrumFilenames']=" + "'./MannCrossSpectrum_Gamma'")
-        filename.write("\nInput['CalculateSpectrum']=" + '%d' %2)
-        filename.write("\nInput['SpectrumSteps']=" + '%d' %128)
-        filename.write("\nInput['UseBoxCovariance']=" + '%d' %0)
-        filename.write("\nInput['Gamma']=" + '%.2f' %Gamma_Mann) # Mann spectral velocity tensor parameters
-        filename.write("\nInput['L']=" + '%.4f' %L_mann) # Mann spectral velocity tensor parameters
-        filename.write("\nInput['AlphaEpsilon']=" + '%.4f' %ae)  # Mann spectral velocity tensor parameters
+        filename.write("\nInput['CalculateSpectrum']=" + '%d' %1) # Inputs required for the constrained simulation algorithm
+        filename.write("\nInput['SpectrumSteps']=" + '%d' %128)   # Inputs required for the constrained simulation algorithm
+        filename.write("\nInput['UseBoxCovariance']=" + '%d' %0)  # Inputs required for the constrained simulation algorithm
+        filename.write("\nInput['Gamma']=" + '%.2f' %Gamma_Mann)  # Mann spectral velocity tensor parameters
+        filename.write("\nInput['L']=" + '%.4f' %L_mann)          # Mann spectral velocity tensor parameters
+        filename.write("\nInput['AlphaEpsilon']=" + '%.4f' %ae)   # Mann spectral velocity tensor parameters
         filename.write("\nInput['Nx']=" + '%d' %Nx) # Mann turbulence box dimensions
         filename.write("\nInput['Ny']=" + '%d' %Ny) # Mann turbulence box dimensions
         filename.write("\nInput['Nz']=" + '%d' %Nz) # Mann turbulence box dimensions
@@ -199,13 +212,13 @@ for filename in os.listdir(PATH_VICONDAR_OUTPUT):
         filename.write("\nInput['Umean']=" + '%d' %U_amb) # Ambient wind speed at hub-height
         filename.write("\nInput['BoxWidth']=" + '%d' %(Ny*dy))  # in meters
         filename.write("\nInput['BoxHeight']=" + '%d' %(Nz*dz)) # in meters
-        filename.write("\nInput['SaveToFile']=" + '%d' %1)
+        filename.write("\nInput['SaveToFile']=" + '%d' %1)# Flag for saving constrained turb. fields
         filename.write("\nInput['PrintDetailedOutput']=" + '%d' %0)
-        filename.write("\nInput['CrossSpectrumComponent1']=" + '%d' %1)
-        filename.write("\nInput['CrossSpectrumComponent2']=" + '%d' %1)
-        filename.write("\nInput['OutputFileName']=" + "'./turb%s_ti%s_av_setb_%s_c_vol%du.bin'" %(tu_seed,int(TI_amb),LidarSys,vsize))
+        filename.write("\nInput['CrossSpectrumComponent1']=" + '%d' %1) # Flag for calculating the uu-spectrum
+        filename.write("\nInput['CrossSpectrumComponent2']=" + '%d' %1) # Flag for calculating the uu-spectrum
+        filename.write("\nInput['OutputFileName']=" + "'./turb%s_ti%s_av_setb_%s_c_vol%du.bin'" %(tu_seed,int(TI_amb),LidarSys,vsize)) # Output name of the constrained turb. box
         filename.write("\nInput['Constraints']= [")  
-        filename.write(", \n".join(constraint_cells))
+        filename.write(", \n".join(constraint_cells)) # Print the constraints and their locations 
         filename.write("]\n")
         filename.write("\nprint('Start applying constraints:')")
         filename.write("\nConstrainTurbulenceBox_U_S(Input)")