Adapting Example 3 for FAST.Farm so it can run on github action

Author: ebranlard

openfast_toolbox/fastfarm/examples/Ex1_FASTFarm_discretization.py

@@ -44,22 +44,20 @@ def main(test=False):
     # -----------------------------------------------------------------------------
 
     # ----------- Case absolute path
-    path = os.path.join(scriptDir, '_ex1')
+    path = os.path.join(scriptDir, '_ex1') # folder (preferably new) where all the simulation files will be written
 
     # ----------- Execution parameters
 
 
     # -----------------------------------------------------------------------------
     # --------------------------- Farm parameters ---------------------------------
     # -----------------------------------------------------------------------------
-
     # ----------- General turbine parameters
-    cmax     = 5      # Maximum blade chord (m)
-    fmax     = 10/6   # Maximum excitation frequency (Hz)
+    cmax     = 5      # Maximum blade chord (m), affects dr
+    fmax     = 10/6   # Maximum excitation frequency (Hz), affects dt_high
     Cmeander = 1.9    # Meandering constant (-)
     D = 240           # Rotor diameter (m)
     zhub = 150        # Hub height (m)
-
     # ----------- Wind farm
     # The wts dictionary holds information of each wind turbine. The allowed entries
     # are: x, y, z, D, zhub, cmax, fmax, Cmeander, and phi_deg. The phi_deg is the
@@ -83,21 +81,18 @@ def main(test=False):
     # -----------------------------------------------------------------------------
     # ------------------- Inflow conditions and input files -----------------------
     # -----------------------------------------------------------------------------
-
     # ----------- Additional variables
     tmax = 120      # Total simulation time
-    nSeeds = 6      # Number of seeds
     zbot = 1        # Bottom of your domain
     mod_wake = 2    # Wake model. 1: Polar, 2: Curled, 3: Cartesian
-
     # ----------- Inflow parameters
     inflowType = 'TS'
-
-    # ----------- Desired sweeps
-    vhub       = [8]
-    shear      = [0.1]
-    TIvalue    = [10]
-    inflow_deg = [0]
+    # ----------- Desired sweeps, fill array with multiple values if necessary
+    nSeeds      = 6     # Number of seeds
+    vhub       = [8]    # Hub velocity [m/s]
+    shear      = [0.1]  # Power law exponent [-]
+    TIvalue    = [10]   # Turbulence intensity [%]
+    inflow_deg = [0]    # Wind direction [deg]
 
     # ----------- Template files
 
@@ -109,12 +104,12 @@ def main(test=False):
 
     # ----------- Low- and high-res boxes parameters
     # High-res boxes settings
-    dt_high     = None    # sampling frequency of high-res files
-    ds_high     = None    # dx, dy, dz of high-res files
+    dt_high     = None   # sampling time of high-res files [s]
+    ds_high     = None   # dx, dy, dz of high-res files [m]
     extent_high = None   # extent in y and x for each turbine, in D
     # Low-res boxes settings
-    dt_low      = None   # sampling frequency of low-res files
-    ds_low      = None   # dx, dy, dz of low-res files
+    dt_low      = None   # sampling time of low-res files [s]
+    ds_low      = None   # dx, dy, dz of low-res files [m]
     extent_low  = None   # extent in [xmin,xmax,ymin,ymax,zmax], in D
 
 

openfast_toolbox/fastfarm/examples/Ex2a_FASTFarm_TurbSim_driven.py

@@ -117,7 +117,6 @@ def main(test=False):
     TIvalue    = [10]   # Turbulence intensity [%]
     inflow_deg = [0]    # Wind direction [deg]
 
-
     # ----------- Template files
     # --- Option 1
     templateFSTF = os.path.join(scriptDir, '../../../data/IEA15MW/FF.fstf')
@@ -152,7 +151,7 @@ def main(test=False):
     # SLURM scripts
     slurm_TS_high           = os.path.join(scriptDir, './SampleFiles/runAllHighBox.sh')
     slurm_TS_low            = os.path.join(scriptDir, './SampleFiles/runAllLowBox.sh')
-    # slurm_FF_single         = './SampleFiles/runFASTFarm_cond0_case0_seed0.sh'
+    slurm_FF_single         = './SampleFiles/runFASTFarm_cond0_case0_seed0.sh'
 
 
     # -----------------------------------------------------------------------------
@@ -196,8 +195,8 @@ def main(test=False):
                             refTurb_rot=refTurb_rot, verbose=0)
 
     # ----------- Perform auxiliary steps in preparing the case
-    ffcase.setTemplateFilename(templateFiles=templateFiles, templateFSTF=templateFSTF)
-    #ffcase.setTemplateFilename(templatePath, templateFiles)   
+    ffcase.setTemplateFilename(templateFiles=templateFiles, templateFSTF=templateFSTF) # Option 1
+    #ffcase.setTemplateFilename(templatePath, templateFiles) # Option 2
     ffcase.getDomainParameters()
     ffcase.copyTurbineFilesForEachCase()
     ffcase.plot()  # add showTurbNumber=True to help with potential debugging
@@ -243,7 +242,7 @@ def main(test=False):
 
     # ----------- Prepare script for submission
     ffcase.FF_batch_prepare() # Write batch files with all commands to be run
-    #ffcase.FF_slurm_prepare(slurm_FF_single)
+    #ffcase.FF_slurm_prepare(slurm_FF_single) # Alternative, prepare a slurm batch file
 
     # We can do simple modifications:
     modifyProperty(ffcase.FFFiles[0], 'NX_Low', 100) # Making the domain longer for visualization purposes
@@ -253,7 +252,7 @@ def main(test=False):
 
     # ----------- Submit the FAST.Farm script (can be done from the command line)
     ffcase.FF_batch_run(showOutputs=True, showCommand=True, nBuffer=10, shell_cmd='bash')
-    #ffcase.FF_slurm_submit(p='debug', t='1:00:00')
+    #ffcase.FF_slurm_submit(p='debug', t='1:00:00') # Alternative, submit a slurm batch file
     return ffcase
 
 

openfast_toolbox/fastfarm/examples/Ex2b_FASTFarm_LES_driven.py

@@ -7,11 +7,14 @@
     https://openfast.readthedocs.io/en/dev/source/user/fast.farm/ModelGuidance.html
 
 """
-
+import os
 from openfast_toolbox.fastfarm.FASTFarmCaseCreation import FFCaseCreation
 from openfast_toolbox.fastfarm.AMRWindSimulation import AMRWindSimulation
 
-def main():
+
+scriptDir = os.path.dirname(__file__)
+
+def main(test=False):
 
     # -----------------------------------------------------------------------------
     # USER INPUT: Modify these
@@ -22,26 +25,25 @@ def main():
     # -----------------------------------------------------------------------------
 
     # ----------- Case absolute path
-    path = '/complete/path/of/your/case'
+    path = os.path.join(scriptDir, '_ex3') # folder (preferably new) where all the simulation files will be written
 
     # ----------- Execution parameters
     # If you are sure the correct binary is first on your $PATH and associated
     # libraries on $LD_LIBRARY_PATH, you can set the variable below to None or
     # remove it from the `FFCaseCreation` call
-    ffbin = '/full/path/to/your/binary/.../bin/FAST.Farm'
+    ffbin     = os.path.join(scriptDir, './SampleFiles/dummy_fastfarm.exe.txt') # relative or absolute path of FAST.Farm executable
 
+    libdiscon = os.path.join(scriptDir, './SampleFiles/dummy_discon.dll.dummy')  # relative or absolute path to discon shared library
 
     # -----------------------------------------------------------------------------
     # --------------------------- Farm parameters ---------------------------------
     # -----------------------------------------------------------------------------
-
     # ----------- General turbine parameters
-    cmax     = 5      # Maximum blade chord (m)
-    fmax     = 10/6   # Maximum excitation frequency (Hz)
+    cmax     = 5      # Maximum blade chord (m), affects dr
+    fmax     = 10/6   # Maximum excitation frequency (Hz), affects dt_high
     Cmeander = 1.9    # Meandering constant (-)
     D = 240           # Rotor diameter (m)
     zhub = 150        # Hub height (m)
-
     # ----------- Wind farm
     # The wts dictionary holds information of each wind turbine. The allowed entries
     # are: x, y, z, D, zhub, cmax, fmax, Cmeander, and phi_deg. The phi_deg is the
@@ -65,12 +67,10 @@ def main():
     # -----------------------------------------------------------------------------
     # ------------------- Inflow conditions and input files -----------------------
     # -----------------------------------------------------------------------------
-
     # ----------- Additional variables
     tmax = 60       # Total simulation time
     zbot = 1        # Bottom of your domain
     mod_wake = 2    # Wake model. 1: Polar, 2: Curled, 3: Cartesian
-
     # ----------- Inflow parameters
     inflowType = 'LES'
     inflowPath = '/full/path/to/LES/case/.../LESboxes'
@@ -81,36 +81,40 @@ def main():
     # executions with multiple different LES solutions, you can give inflowPath
     # as a n-sized array (related to the different LES), and give the variables
     # below as n-sized arrays as well.
-    vhub       = [8]
-    shear      = [1]
-    TIvalue    = [1]
-    inflow_deg = [0]
+    vhub       = [8]    # Hub velocity [m/s]
+    shear      = [0.1]  # Power law exponent [-]
+    TIvalue    = [10]   # Turbulence intensity [%]
+    inflow_deg = [0]    # Wind direction [deg]
 
     # ----------- Template files
-    templatePath = '/full/path/where/template/files/are'
-    # Files should be in templatePath. Put None on any input that is not applicable.
-    templateFiles = {
-        "EDfilename"              : 'ElastoDyn.T',
-        'SEDfilename'             : None,  # 'SimplifiedElastoDyn.T',
-        'HDfilename'              : None,  # 'HydroDyn.dat', # ending with .T for per-turbine HD, .dat for holisitc
-        'MDfilename'              : None,  # 'MoorDyn.T',    # ending with .T for per-turbine MD, .dat for holistic
-        'SSfilename'              : None,  # 'SeaState.dat',
-        'SrvDfilename'            : 'ServoDyn.T',
-        'ADfilename'              : 'AeroDyn.dat',
-        'ADskfilename'            : None,
-        'SubDfilename'            : 'SubDyn.dat',
-        'IWfilename'              : 'InflowWind.dat',
-        'BDfilename'              : None,
-        'EDbladefilename'         : 'ElastoDyn_Blade.dat',
-        'EDtowerfilename'         : 'ElastoDyn_Tower.dat',
-        'ADbladefilename'         : 'AeroDyn_Blade.dat',
-        'turbfilename'            : 'Model.T',
-        'libdisconfilepath'       : '/full/path/to/controller/libdiscon.so',
-        'controllerInputfilename' : 'DISCON.IN',
-        'coeffTablefilename'      : None,
-        'hydroDatapath'           : None,  # '/full/path/to/hydroData',
-        'FFfilename'              : 'Model_FFarm.fstf',
-    }
+    # --- Option 1
+    templateFSTF = os.path.join(scriptDir, '../../../data/IEA15MW/FF.fstf')
+    templateFiles = {'libdisconfilepath' : libdiscon}    
+    # --- Option 2    
+    #templatePath = '/full/path/where/template/files/are'
+    ## Files should be in templatePath. Put None on any input that is not applicable.
+    #templateFiles = {
+    #    "EDfilename"              : 'ElastoDyn.T',
+    #    'SEDfilename'             : None,  # 'SimplifiedElastoDyn.T',
+    #    'HDfilename'              : None,  # 'HydroDyn.dat', # ending with .T for per-turbine HD, .dat for holisitc
+    #    'MDfilename'              : None,  # 'MoorDyn.T',    # ending with .T for per-turbine MD, .dat for holistic
+    #    'SSfilename'              : None,  # 'SeaState.dat',
+    #    'SrvDfilename'            : 'ServoDyn.T',
+    #    'ADfilename'              : 'AeroDyn.dat',
+    #    'ADskfilename'            : None,
+    #    'SubDfilename'            : 'SubDyn.dat',
+    #    'IWfilename'              : 'InflowWind.dat',
+    #    'BDfilename'              : None,
+    #    'EDbladefilename'         : 'ElastoDyn_Blade.dat',
+    #    'EDtowerfilename'         : 'ElastoDyn_Tower.dat',
+    #    'ADbladefilename'         : 'AeroDyn_Blade.dat',
+    #    'turbfilename'            : 'Model.T',
+    #    'libdisconfilepath'       : '/full/path/to/controller/libdiscon.so',
+    #    'controllerInputfilename' : 'DISCON.IN',
+    #    'coeffTablefilename'      : None,
+    #    'hydroDatapath'           : None,  # '/full/path/to/hydroData',
+    #    'FFfilename'              : 'Model_FFarm.fstf',
+    #}
     # SLURM scripts
     slurm_FF_single         = './SampleFiles/runFASTFarm_cond0_case0_seed0.sh'
 
@@ -152,7 +156,7 @@ def main():
                            level_lr=level_lr, level_hr=level_hr, verbose=0)
 
     # -----------Save AMR-Wind sampling input
-    amr.write_sampling_params(os.path.join(path,'FF_boxes.i'), overwrite=True)
+    amr.write_sampling_params(os.path.join(path,'FF_boxes.i'), overwrite=True, terrain=False)
 
 
     # -----------------------------------------------------------------------------
@@ -166,12 +170,12 @@ def main():
 
     # ----------- Low- and high-res boxes parameters
     # High-res boxes settings
-    dt_high     = amr.dt_high_les  # sampling frequency of high-res files
-    ds_high     = amr.ds_high_les  # dx, dy, dz of high-res files
-    extent_high = amr.extent_high  # extent in y and x for each turbine, in D.
+    dt_high     = amr.dt_high_les  # sampling time of high-res files [s]
+    ds_high     = amr.ds_high_les  # dx, dy, dz of high-res files [m]
+    extent_high = amr.extent_high  # extent in y and x for each turbine, in D
     # Low-res boxes settings
-    dt_low      = amr.dt_low_les   # sampling frequency of low-res files
-    ds_low      = amr.ds_low_les   # dx, dy, dz of low-res files
+    dt_low      = amr.dt_low_les   # sampling time of low-res files [s]
+    ds_low      = amr.ds_low_les   # dx, dy, dz of low-res files [m]
     extent_low  = amr.extent_low   # extent in [xmin,xmax,ymin,ymax,zmax], in D
 
 
@@ -193,27 +197,60 @@ def main():
                             refTurb_rot=refTurb_rot, verbose=0)
 
     # ----------- Perform auxiliary steps in preparing the case
-    ffcase.setTemplateFilename(templatePath, templateFiles)   
+    ffcase.setTemplateFilename(templateFiles=templateFiles, templateFSTF=templateFSTF) # Option 1
+    #ffcase.setTemplateFilename(templatePath, templateFiles) # Option 2
     ffcase.getDomainParameters()
     ffcase.copyTurbineFilesForEachCase()
 
 
     # -----------------------------------------------------------------------------
     # ------------------ Finish FAST.Farm setup and execution ---------------------
     # -----------------------------------------------------------------------------
+    if test:
+        return amr, ffcase
     # ----------- FAST.Farm setup
-    ffcase.FF_setup()
+    ffcase.FF_setup() # Write FAST.Farm input files
     # Update wake model constants (adjust as needed for your turbine model)
     ffcase.set_wake_model_params(k_VortexDecay=0, k_vCurl=2.8)
 
     # ----------- Prepare script for submission
-    ffcase.FF_slurm_prepare(slurm_FF_single)
+    ffcase.FF_batch_prepare() # Write batch files with all commands to be run
+    #ffcase.FF_slurm_prepare(slurm_FF_single) # Alternative, prepare a slurm batch file
 
     # ----------- Submit the FAST.Farm script (can be done from the command line)
-    ffcase.FF_slurm_submit(p='debug', t='1:00:00')
-
+    ffcase.FF_batch_run(showOutputs=True, showCommand=True, nBuffer=10, shell_cmd='bash')
+    #ffcase.FF_slurm_submit(p='debug', t='1:00:00') # Alternative, submit a slurm batch file
+    return amr, ffcase
 
 
 if __name__ == '__main__':
+    amr, ffcase = main(test=True)
     # This example cannot be fully run.
+    #print(amr)
+    #print(ffcase)
     pass
+if __name__ == '__test__':
+    amr, ffcase = main(test=True)
+    # This example cannot be fully run.
+    import numpy as np
+    import shutil
+    np.testing.assert_equal(amr.ds_low_les, 20.0)
+    np.testing.assert_equal(amr.dt_low_les, 0.9)
+    np.testing.assert_array_equal(amr.extent_low, [1.5, 2.5, 1.5, 1.5, 2] )
+    np.testing.assert_equal(amr.ds_high_les, 5.0)
+    np.testing.assert_equal(amr.dt_high_les, 0.3)
+    np.testing.assert_equal(ffcase.ds_low, 20.0)
+    np.testing.assert_equal(ffcase.dt_low, 0.9)
+    np.testing.assert_equal(ffcase.ds_high, 5.0)
+    np.testing.assert_equal(ffcase.dt_high, 0.3)
+    np.testing.assert_(os.path.exists(ffcase.path), f"path does not exist {ffcase.path}")
+    for cond, _ in enumerate(ffcase.condDirList):
+        np.testing.assert_(os.path.exists(ffcase.getCondPath(cond)), f"cond path {cond} does not exist ")
+        for case in range(ffcase.nCases):
+            np.testing.assert_(os.path.exists(ffcase.getCasePath(cond, case)), f"case path {cond} {case} does not exist ")
+    if os.path.exists(ffcase.path):
+        try:
+            shutil.rmtree(ffcase.path)
+        except OSError as e:
+            print('Fail to remove FAST.Farm ex2 folder' )
+            pass

openfast_toolbox/fastfarm/tests/test_run_Examples.py

@@ -18,7 +18,8 @@ def test_run_examples(self):
         exclude_list=[]
         # Add tests to class
         MyDir=os.path.dirname(__file__)
-        files = glob.glob(os.path.join(MyDir,'../examples/[A-Za-z][_-a-zA-Z0-9]*.py'))
+        #files = glob.glob(os.path.join(MyDir,'../examples/[A-Za-z][_-a-zA-Z0-9]*.py'))
+        files = glob.glob(os.path.join(MyDir,'../examples/[a-zA-Z]*.py'))
         import matplotlib.pyplot as plt
         print('\n--------------------------------------------------------------')
         for f in files: