Merge pull request #2719 from rafmudaf/python_upgrades

Python infrastructure improvements

Author: andrew-platt

.github/workflows/automated-dev-tests.yml

@@ -50,6 +50,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
+          pip install glue-codes/python/.   # Installs the interface library
           sudo apt-get update -y
           sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
       - name: Setup workspace
@@ -347,6 +348,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
+          pip install glue-codes/python/.   # Installs the interface library
           sudo apt-get update -y
           sudo apt-get install -y libopenblas-dev
       - name: Setup workspace
@@ -406,6 +408,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
+          pip install glue-codes/python/.   # Installs the interface library
           sudo apt-get update -y
           sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
           sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ -462,6 +465,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
+          pip install glue-codes/python/.   # Installs the interface library
           sudo apt-get update -y
           sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
           sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ -521,6 +525,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
+          pip install glue-codes/python/.   # Installs the interface library
           sudo apt-get update -y
           sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
           sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ -568,6 +573,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
+          pip install glue-codes/python/.   # Installs the interface library
           sudo apt-get update -y
           sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
           sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ -618,6 +624,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
+          pip install glue-codes/python/.   # Installs the interface library
           sudo apt-get update -y
           sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
           sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ -696,6 +703,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
+          pip install glue-codes/python/.   # Installs the interface library
           pip install numpy "Bokeh>=2.4,!=3.0.0,!=3.0.1,!=3.0.2,!=3.0.3"
           sudo apt-get update -y
           sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
@@ -744,6 +752,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
+          pip install glue-codes/python/.   # Installs the interface library
           sudo apt-get update -y
           sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
           sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ -792,6 +801,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
+          pip install glue-codes/python/.   # Installs the interface library
           sudo apt-get update -y
           sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
           sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ -840,6 +850,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
+          pip install glue-codes/python/.   # Installs the interface library
           sudo apt-get update -y
           sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
           sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ -888,6 +899,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
+          pip install glue-codes/python/.   # Installs the interface library
           sudo apt-get update -y
           sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
           sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ -936,6 +948,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
+          pip install glue-codes/python/.   # Installs the interface library
           sudo apt-get update -y
           sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
           sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ -984,6 +997,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
+          pip install glue-codes/python/.   # Installs the interface library
           sudo apt-get update -y
           sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
           sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ -1031,6 +1045,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
+          pip install glue-codes/python/.   # Installs the interface library
           sudo apt-get update -y
           sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
           sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev

.gitignore

@@ -29,6 +29,7 @@
 *.app
 __pycache__/*
 *.pyc
+*.egg-info
 
 # Build specific files
 build*/

glue-codes/python/OpenFAST.py

@@ -1,20 +1,20 @@
 
-import openfast_library
+from pyOpenFAST import fast
 
-project_root = '/Users/rmudafor/Development/weis'
+project_root = '/Users/rmudafor/Development/openfast'
 library_path = project_root + '/build/modules/openfast-library/libopenfastlib.dylib'
 
 def serial(input_file):
     input_file_name = input_file # "/Users/rmudafor/Development/weis/reg_tests/r-test/glue-codes/openfast/AOC_YFix_WSt/AOC_YFix_WSt.fst"
-    openfastlib = openfast_library.FastLibAPI(library_path, input_file_name)
-    openfastlib.fast_run()
+    fastlib = fast.FastLibAPI(library_path, input_file_name)
+    fastlib.run()
 
     # Display the outputs
-    # for i, c in enumerate(openfastlib.output_channel_names):
+    # for i, c in enumerate(fastlib.output_channel_names):
     #     print(i, c)
-    # print(openfastlib.output_channel_names)
-    # print(openfastlib.output_values)
-    # print(openfastlib.output_values[:,0])   # Prints the time steps
+    # print(fastlib.output_channel_names)
+    # print(fastlib.output_values)
+    # print(fastlib.output_values[:,0])   # Prints the time steps
 
 def parallel():
     ## Parallel with MPI
@@ -24,25 +24,26 @@ def parallel():
 
     if rank == 0:
         input_file_name = "{}/reg_tests/r-test/glue-codes/openfast/AOC_WSt/AOC_WSt.fst".format(project_root)
-        openfastlib = openfast_library.FastLibAPI(library_path, input_file_name)
-        openfastlib.fast_run()
+        fastlib = fast.FastLibAPI(library_path, input_file_name)
+        fastlib.run()
     elif rank == 1:
         input_file_name = "{}/reg_tests/r-test/glue-codes/openfast/AOC_YFix_WSt/AOC_YFix_WSt.fst".format(project_root)
-        openfastlib = openfast_library.FastLibAPI(library_path, input_file_name)
-        openfastlib.fast_run()
+        fastlib = fast.FastLibAPI(library_path, input_file_name)
+        fastlib.run()
     elif rank == 2:
         input_file_name = "{}/reg_tests/r-test/glue-codes/openfast/AOC_YFree_WTurb/AOC_YFree_WTurb.fst".format(project_root)
-        openfastlib = openfast_library.FastLibAPI(library_path, input_file_name)
-        openfastlib.fast_run()
+        fastlib = fast.FastLibAPI(library_path, input_file_name)
+        fastlib.run()
     elif rank == 3:
         input_file_name = "{}/reg_tests/r-test/glue-codes/openfast/AWT_YFix_WSt/AWT_YFix_WSt.fst".format(project_root)
-        openfastlib = openfast_library.FastLibAPI(library_path, input_file_name)
-        openfastlib.fast_run()
+        fastlib = fast.FastLibAPI(library_path, input_file_name)
+        fastlib.run()
 
 if __name__=="__main__":
     import sys
     if len(sys.argv) > 1:
         input_file = sys.argv[1]
         serial(input_file)
+        # parallel()
     else:
         print("No cases run. Check the driver code.")

glue-codes/python/pyOpenFAST/__init__.py

@@ -1,5 +1,5 @@
+
 from ctypes import (
-	CDLL,
     POINTER,
     create_string_buffer,
     byref,
@@ -9,22 +9,24 @@
     c_char,
     c_bool
 )
-import os
 from typing import List, Tuple
 import numpy as np
 import math
+from pathlib import Path
+
+from .interface_abc import OpenFASTInterfaceType
 
 
 IntfStrLen = 1025    # FAST_Library global
 NumFixedInputs = 51  # FAST_Library global
 
 
-class FastLibAPI(CDLL):
+class FastLibAPI(OpenFASTInterfaceType):
 
     def __init__(self, library_path: str, input_file_name: str):
         super().__init__(library_path)
-        self.library_path = library_path
-        self.input_file_name = create_string_buffer(os.path.abspath(input_file_name).encode('utf-8'))
+        
+        self.input_file_name = create_string_buffer(str(Path(input_file_name).absolute()).encode('utf-8'))
 
         self._initialize_routines()
 
@@ -34,7 +36,7 @@ def __init__(self, library_path: str, input_file_name: str):
         self.dt = c_double(0.0)
         self.dt_out = c_double(0.0)
         self.t_max = c_double(0.0)
-        self.abort_error_level = c_int(4)  # Initialize to 4 (ErrID_Fatal) and reset to user-given value in FAST_Sizes
+        # self.abort_error_level = c_int(4)  # Initialize to 4 (ErrID_Fatal) and reset to user-given value in FAST_Sizes
         self.end_early = c_bool(False)
         self.num_outs = c_int(0)
         self.output_channel_names = []
@@ -123,11 +125,7 @@ def _initialize_routines(self) -> None:
         self.FAST_HubPosition.restype = c_int
 
 
-    def fatal_error(self, error_status) -> bool:
-        return error_status.value >= self.abort_error_level.value
-
-
-    def fast_init(self) -> None:
+    def init(self) -> None:
         _error_status = c_int(0)
         _error_message = create_string_buffer(IntfStrLen)
 
@@ -172,7 +170,7 @@ def fast_init(self) -> None:
         del _error_message
         del channel_names
 
-    def fast_sim(self) -> None:
+    def sim(self) -> None:
         _error_status = c_int(0)
         _error_message = create_string_buffer(IntfStrLen)
 
@@ -186,7 +184,7 @@ def fast_sim(self) -> None:
             _error_message
         )
         if self.fatal_error(_error_status):
-            self.fast_deinit()
+            self.deinit()
             raise RuntimeError(f"Error {_error_status.value}: {_error_message.value}")
 
         # Calculate output frequency and initialize output index
@@ -207,13 +205,13 @@ def fast_sim(self) -> None:
             if i%output_frequency == 0:
                 i_out += 1
             if self.fatal_error(_error_status):
-                self.fast_deinit()
+                self.deinit()
                 raise RuntimeError(f"Error {_error_status.value}: {_error_message.value}")
             if self.end_early:
                 break
 
 
-    def fast_deinit(self) -> None:
+    def deinit(self) -> None:
         _error_status = c_int(0)
         _error_message = create_string_buffer(IntfStrLen)
 
@@ -236,26 +234,26 @@ def fast_deinit(self) -> None:
                 raise RuntimeError(f"Error {_error_status.value}: {_error_message.value}")
 
 
-    def fast_run(self) -> None:
-        self.fast_init()
-        self.fast_sim()
-        self.fast_deinit()
-
-
-    @property
-    def total_time_steps(self) -> int:
-        # From FAST_Subs FAST_Init:
-        # p%n_TMax_m1  = CEILING( ( (p%TMax - t_initial) / p%DT ) ) - 1 ! We're going to go from step 0 to n_TMax (thus the -1 here)
-        # Then in FAST_Prog:
-        # TIME_STEP_LOOP:  DO n_t_global = Restart_step, Turbine(1)%p_FAST%n_TMax_m1 
-        # 
-        # Note that Fortran indexing starts at 1 and includes the upper bound
-        # Python indexing starts at 0 and does not include the upper bound
-        # The for-loop in this interface begins at 1 (there's an init step before)
-        # and that's why we have the +1 below
-        # 
-        # We assume here t_initial is always 0
-        return math.ceil( self.t_max.value / self.dt.value) + 1  
+    def run(self) -> None:
+        self.init()
+        self.sim()
+        self.deinit()
+
+
+    # @property
+    # def total_time_steps(self) -> int:
+    #     # From FAST_Subs FAST_Init:
+    #     # p%n_TMax_m1  = CEILING( ( (p%TMax - t_initial) / p%DT ) ) - 1 ! We're going to go from step 0 to n_TMax (thus the -1 here)
+    #     # Then in FAST_Prog:
+    #     # TIME_STEP_LOOP:  DO n_t_global = Restart_step, Turbine(1)%p_FAST%n_TMax_m1 
+    #     # 
+    #     # Note that Fortran indexing starts at 1 and includes the upper bound
+    #     # Python indexing starts at 0 and does not include the upper bound
+    #     # The for-loop in this interface begins at 1 (there's an init step before)
+    #     # and that's why we have the +1 below
+    #     # 
+    #     # We assume here t_initial is always 0
+    #     return math.ceil( self.t_max.value / self.dt.value) + 1  
 
 
     @property