Reworked folder structure for input files

Author: phil-brad

example_data/Discon.dll example_data/bin/Discon.dll

@@ -16,14 +16,14 @@ PRANDtl     HLModel     - Hub-loss model (EQUIL only) [PRANdtl or NONE] (unquote
    1.464E-5 KinVisc     - Kinematic air viscosity [CURRENTLY IGNORED] (m^2/sec)
    0.02479  DTAero      - Time interval for aerodynamic calculations (sec)
    8        NumFoil     - Number of airfoil files (-)
-"AeroData\Cylinder1.dat"                         FoilNm      - Names of the airfoil files [NumFoil lines] (quoted strings)
-"AeroData\Cylinder2.dat"
-"AeroData\DU40_A17.dat"
-"AeroData\DU35_A17.dat"
-"AeroData\DU30_A17.dat"
-"AeroData\DU25_A17.dat"
-"AeroData\DU21_A17.dat"
-"AeroData\NACA64_A17.dat"
+"..\AeroData\Cylinder1.dat"                         FoilNm      - Names of the airfoil files [NumFoil lines] (quoted strings)
+"..\AeroData\Cylinder2.dat"
+"..\AeroData\DU40_A17.dat"
+"..\AeroData\DU35_A17.dat"
+"..\AeroData\DU30_A17.dat"
+"..\AeroData\DU25_A17.dat"
+"..\AeroData\DU21_A17.dat"
+"..\AeroData\NACA64_A17.dat"
   17        BldNodes    - Number of blade nodes used for analysis (-)
 RNodes   AeroTwst  DRNodes  Chord  NFoil  PrnElm
  2.8667  13.308    2.7333   3.542  1      NOPRINT

example_data/FASTv7.0.2.exe example_data/bin/FASTv7.0.2.exe

@@ -63,7 +63,7 @@ False         CompNTMD     - Compute nacelle tuned mass damper {true/false} (fla
 False         CompTTMD     - Compute tower tuned mass damper {true/false} (flag)
 "NRELOffshrBsline5MW_ServoDyn_TMD.dat"    TTMDfile     - Name of the file for tower tuned mass damper (quoted string) [unused when CompTTMD is false]
 ---------------------- BLADED INTERFACE ---------------------------------------- [used only with Bladed Interface]
-"../../Discon.dll"    DLL_FileName - Name/location of the dynamic library {.dll [Windows] or .so [Linux]} in the Bladed-DLL format (-) [used only with Bladed Interface]
+"../../bin/Discon.dll"    DLL_FileName - Name/location of the dynamic library {.dll [Windows] or .so [Linux]} in the Bladed-DLL format (-) [used only with Bladed Interface]
 "DISCON.IN"    DLL_InFile   - Name of input file sent to the DLL (-) [used only with Bladed Interface]
 "DISCON"      DLL_ProcName - Name of procedure in DLL to be called (-) [case sensitive; used only with DLL Interface]
 "default"     DLL_DT       - Communication interval for dynamic library (s) (or "default") [used only with Bladed Interface]

example_data/bin/FASTv8.16_Win32.exe

@@ -23,13 +23,13 @@
 from spawn.util.validation import validate_file, validate_dir
 
 from .simulation_input import TurbsimInput
-from .fast_input import Fast7Input
+from .fast_input import Fast7Input, Fast8Input
 from .turbsim_spawner import TurbsimSpawner
 from .fast_spawner import FastSimulationSpawner
 from .tasks import WindGenerationTask, FastSimulationTask
 
 def create_spawner(
-        turbsim_exe, fast_exe, turbsim_base_file, fast_base_file,
+        turbsim_exe, fast_exe, turbsim_base_file, fast_base_file, fast_version,
         runner_type, turbsim_working_dir, fast_working_dir, outdir, prereq_outdir
     ):
     """
@@ -40,6 +40,7 @@ def create_spawner(
         from which wind file generation tasks are spawned
     :param fast_base_file: FAST input file (typically `.fst`) to which all parameter
         editions are made and from which simulations are spawned
+    :param fast_version: Major version of FAST {'v7', 'v8'}
     :param runner_type: default is `process`
     :param turbsim_working_dir: Directory in which TurbSim wind generation tasks are executed
     :param fast_working_dir: Directory in which FAST simulations are executed.
@@ -65,7 +66,13 @@ def create_spawner(
     luigi_config.set(FastSimulationTask.__name__, '_working_dir', fast_working_dir)
 
     wind_spawner = TurbsimSpawner(TurbsimInput.from_file(turbsim_base_file))
-    return FastSimulationSpawner(Fast7Input.from_file(fast_base_file), wind_spawner, path.join(outdir, prereq_outdir))
+    fast_input_cls = {
+        'v7': Fast7Input,
+        'v8': Fast8Input
+    }
+    return FastSimulationSpawner(fast_input_cls[fast_version].from_file(fast_base_file),
+                                 wind_spawner,
+                                 path.join(outdir, prereq_outdir))
 
 
 #pylint: disable=invalid-name

example_data/bin/MAP_Win32.dll

@@ -27,30 +27,37 @@
 
 __home_dir = path.dirname(path.realpath(__file__))
 _example_data_folder = path.join(__home_dir, pardir, 'example_data')
+_fast_exe_paths = {
+    'v7': path.join(_example_data_folder, 'bin', 'FASTv7.0.2.exe'),
+    'v8': path.join(_example_data_folder, 'bin', 'FASTv8.16_Win32.exe')
+}
 
 @pytest.fixture(scope='session')
-def exe_paths():
-    return {
-        'turbsim': path.join(_example_data_folder, 'TurbSim.exe'),
-        'fast_v7': path.join(_example_data_folder, 'FASTv7.0.2.exe'),
-        'fast_v8': path.join(_example_data_folder, 'FASTv8.16_Win32.exe')
-    }
+def turbsim_exe():
+    return path.join(_example_data_folder, 'bin', 'TurbSim.exe')
 
 @pytest.fixture(scope='session', autouse=True)
-def configure_luigi(exe_paths):
+def configure_luigi(turbsim_exe):
     luigi.configuration.get_config().set('WindGenerationTask', '_runner_type', 'process')
-    luigi.configuration.get_config().set('WindGenerationTask', '_exe_path', exe_paths['turbsim'])
+    luigi.configuration.get_config().set('WindGenerationTask', '_exe_path', turbsim_exe)
     luigi.configuration.get_config().set('FastSimulationTask', '_runner_type', 'process')
-    luigi.configuration.get_config().set('FastSimulationTask', '_exe_path', exe_paths['fast_v8'])
 
 @pytest.fixture(params=['v7', 'v8'], scope='module')
-def fast_version(request, exe_paths):
-    if request.param == 'v8':
-        luigi.configuration.get_config().set('FastSimulationTask', '_exe_path', exe_paths['fast_v8'])
-    elif request.param == 'v7':
-        luigi.configuration.get_config().set('FastSimulationTask', '_exe_path', exe_paths['fast_v7'])
+def fast_version(request):
+    luigi.configuration.get_config().set('FastSimulationTask', '_exe_path', _fast_exe_paths[request.param])
     return request.param
 
+@pytest.fixture(scope='module')
+def exe_paths(turbsim_exe, fast_version):
+    return {
+        'turbsim': turbsim_exe,
+        'fast': _fast_exe_paths[fast_version]
+    }
+
+@pytest.fixture()
+def fast_exe(exe_paths):
+    return exe_paths['fast']
+
 @pytest.fixture(scope='module')
 def turbsim_input_file():
     return path.join(_example_data_folder, 'fast_input_files', 'TurbSim.inp')
@@ -60,11 +67,19 @@ def inflowwind_input_file():
     return path.join(_example_data_folder, 'fast_input_files', 'v8', 'InflowWind.inp')
 
 @pytest.fixture(scope='module')
-def fast_input_file(fast_version):
+def base_fast_input_folder():
+    return path.join(_example_data_folder, 'fast_input_files')
+
+@pytest.fixture(scope='module')
+def fast_input_folder(fast_version):
+    return path.join(_example_data_folder, 'fast_input_files', fast_version)
+
+@pytest.fixture(scope='module')
+def fast_input_file(fast_version, fast_input_folder):
     if fast_version == 'v7':
-        return path.join(_example_data_folder, 'fast_input_files', 'NRELOffshrBsline5MW_Onshore.fst')
+        return path.join(fast_input_folder, 'NRELOffshrBsline5MW_Onshore.fst')
     elif fast_version == 'v8':
-        return path.join(_example_data_folder, 'fast_input_files', 'v8', 'NREL5MW.fst')
+        return path.join(fast_input_folder, 'NREL5MW.fst')
 
 @pytest.fixture(scope='function')
 def fast_input(fast_version, fast_input_file):
@@ -77,10 +92,6 @@ def fast_input(fast_version, fast_input_file):
 def example_data_folder():
     return _example_data_folder
 
-@pytest.fixture
-def examples_folder(example_data_folder):
-    return path.join(example_data_folder, 'fast_input_files')
-
 @pytest.fixture
 def wind_gen_spawner(turbsim_input_file):
     return TurbsimSpawner(TurbsimInput.from_file(turbsim_input_file))
@@ -90,14 +101,15 @@ def spawner(wind_gen_spawner, fast_v7_input_file, tmpdir):
     return FastSimulationSpawner(Fast7Input.from_file(fast_v7_input_file), wind_gen_spawner, tmpdir)
 
 @pytest.fixture
-def plugin_loader(tmpdir, exe_paths):
+def plugin_loader(tmpdir, fast_version, fast_input_file, exe_paths, turbsim_input_file):
     default_config = DefaultConfiguration()
     command_line_configuration = CommandLineConfiguration(
-        turbsim_exe=exe_paths['turbsim'], fast_exe=exe_paths['fast_v7'],
-        turbsim_base_file=path.join(_example_data_folder, 'fast_input_files', 'TurbSim.inp'),
-        fast_base_file=path.join(_example_data_folder, 'fast_input_files', 'NRELOffshrBsline5MW_Onshore.fst'),
-        turbsim_working_dir=_example_data_folder,
-        fast_working_dir=_example_data_folder,
+        turbsim_exe=exe_paths['turbsim'], fast_exe=exe_paths['fast'],
+        turbsim_base_file=turbsim_input_file,
+        fast_base_file=fast_input_file,
+        fast_version=fast_version,
+        turbsim_working_dir=path.join(_example_data_folder, 'bin'),
+        fast_working_dir=path.join(_example_data_folder, 'bin'),
         outdir=str(tmpdir)
     )
     return PluginLoader(CompositeConfiguration(command_line_configuration, default_config))

example_data/TurbSim.exe example_data/bin/TurbSim.exe

@@ -24,8 +24,8 @@
 from spawnwind.nrel import TurbsimSpawner, FastSimulationSpawner, TurbsimInput, WindGenerationTask
 
 @pytest.fixture(scope='function')
-def turbsim_input(examples_folder):
-    return TurbsimInput.from_file(path.join(examples_folder, 'TurbSim.inp'))
+def turbsim_input(turbsim_input_file):
+    return TurbsimInput.from_file(turbsim_input_file)
 
 
 @pytest.mark.skipif('sys.platform != "win32"')

example_data/dlc_spec.json

@@ -19,56 +19,78 @@
 import tempfile
 
 from spawnwind.nrel.nrel_input_line import NrelInputLine
-from spawnwind.nrel import TurbsimInput, AerodynInput, FastInput, NRELSimulationInput
+from spawnwind.nrel import TurbsimInput, AerodynInput, NRELSimulationInput, Fast7Input, Fast8Input, TurbsimSpawner
 
 
-@pytest.mark.parametrize('cls,file,key', [
-    (TurbsimInput, 'TurbSim.inp', 'CTStartTime'),
-    (AerodynInput, 'NRELOffshrBsline5MW_AeroDyn.ipt', 'BldNodes'),
-    (FastInput, 'NRELOffshrBsline5MW_Onshore.fst', 'NBlGages')
+@pytest.fixture(scope='function')
+def turbsim_input(turbsim_input_file):
+    return TurbsimInput.from_file(turbsim_input_file)
+
+@pytest.fixture(scope='function')
+def aerodyn_input(turbsim_input_file, base_fast_input_folder):
+    input_file = path.join(base_fast_input_folder, 'v7', 'NRELOffshrBsline5MW_AeroDyn.ipt')
+    return AerodynInput.from_file(input_file, TurbsimSpawner(TurbsimInput.from_file(turbsim_input_file)))
+
+@pytest.fixture(scope='function')
+def fast7_input(base_fast_input_folder):
+    input_file = path.join(base_fast_input_folder, 'v7', 'NRELOffshrBsline5MW_Onshore.fst')
+    return Fast7Input.from_file(input_file)
+
+@pytest.fixture(scope='function')
+def fast8_input(base_fast_input_folder):
+    input_file = path.join(base_fast_input_folder, 'v8', 'NREL5MW.fst')
+    return Fast8Input.from_file(input_file)
+
+
+@pytest.mark.parametrize('input_fixture,key', [
+    ('turbsim_input', 'CTStartTime'),
+    ('fast7_input', 'NBlGages'),
+    ('fast8_input', 'TMax')
 ])
-def test_read_write_round_trip(examples_folder, cls, file, key):
-    _input = cls.from_file(path.join(examples_folder, file))
+def test_read_write_round_trip(input_fixture, key, request):
+    _input = request.getfixturevalue(input_fixture)
     with tempfile.TemporaryDirectory() as outfile:
         name = path.join(outfile, 'temp.txt')
         _input.to_file(name)
-        _input2 = cls.from_file(name)
+        _input2 = _input.__class__.from_file(name)
     assert _input[key] == _input2[key]
 
 
-@pytest.mark.parametrize('cls,file,key,value', [
-    (TurbsimInput, 'TurbSim.inp', 'URef', 11.0),
-    (AerodynInput, 'NRELOffshrBsline5MW_AeroDyn.ipt', 'WindFile', 'Other.wnd'),
-    (FastInput, 'NRELOffshrBsline5MW_Onshore.fst', 'TMax', 300.0)
+@pytest.mark.parametrize('input_fixture,key,value', [
+    ('turbsim_input', 'URef', 11.0),
+    ('fast7_input', 'TMax', 300.0),
+    ('fast8_input', 'DT', 0.001)
 ])
-def test_writes_edited_Specification(examples_folder, cls, file, key, value):
-    _input = cls.from_file(path.join(examples_folder, file))
+def test_writes_edited_Specification(input_fixture, key, value, request):
+    _input = request.getfixturevalue(input_fixture)
     _input[key] = value
     with tempfile.TemporaryDirectory() as outfile:
         name = path.join(outfile, 'temp.txt')
         _input.to_file(name)
-        _input2 = cls.from_file(name)
+        _input2 = _input.__class__.from_file(name)
     assert _input2[key] == str(value)
 
 
-@pytest.mark.parametrize('cls,file,keys', [
-    (AerodynInput, 'NRELOffshrBsline5MW_AeroDyn.ipt', ['FoilNm']),
-    (FastInput, 'NRELOffshrBsline5MW_Onshore.fst', ['BldFile(1)', 'BldFile(3)', 'TwrFile'])
+@pytest.mark.parametrize('input_fixture,keys', [
+    ('aerodyn_input', ['FoilNm']),
+    ('fast7_input', ['BldFile(1)', 'BldFile(3)', 'TwrFile']),
+    ('fast8_input', ['EDFile', 'InflowFile', 'ServoFile', 'AeroFile'])
 ])
-def test_paths_are_absolute(examples_folder, cls, file, keys):
-    _input = cls.from_file(path.join(examples_folder, file))
+def test_paths_are_absolute(input_fixture, keys, request):
+    _input = request.getfixturevalue(input_fixture)
     for k in keys:
         f = _input[k]
         #sanitise windows paths
         assert path.isfile(path.sep.join(f.split('\\')))
 
 
-@pytest.mark.parametrize('cls,file,key', [
-    (AerodynInput, 'NRELOffshrBsline5MW_AeroDyn.ipt', 'WindFile'),
-    (FastInput, 'NRELOffshrBsline5MW_Onshore.fst', 'TwrFile')
+@pytest.mark.parametrize('input_fixture,key', [
+    ('aerodyn_input', 'WindFile'),
+    ('fast7_input', 'TwrFile'),
+    ('fast8_input', 'EDFile')
 ])
-def test_can_handle_spaces_in_paths(examples_folder, cls, file, key):
-    _input = cls.from_file(path.join(examples_folder, file))
+def test_can_handle_spaces_in_paths(input_fixture, key, request):
+    _input = request.getfixturevalue(input_fixture)
     spacey_path = '"C:/this is a spacey/path.ipt"'
     _input[key] = spacey_path
     assert spacey_path.strip('"') == _input[key].strip('"')