Updates to openfast_io to match current dev branch API

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

@@ -535,7 +535,8 @@ jobs:
       - name: Run Interface / API tests
         working-directory: ${{runner.workspace}}/openfast/build
         run: |
-          ctest -VV -L "cpp|python|fastlib"
+          ctest -VV -L "cpp|python|fastlib" \
+              -LE "openfast_io"
       - name: Failing test artifacts
         uses: actions/upload-artifact@v4
         if: failure()
@@ -601,6 +602,51 @@ jobs:
             !${{runner.workspace}}/openfast/build/reg_tests/glue-codes/openfast/UAE_VI
             !${{runner.workspace}}/openfast/build/reg_tests/glue-codes/openfast/WP_Baseline
 
+  rtest-openfast_io:
+    runs-on: ubuntu-22.04
+    needs: build-openfast-release
+    steps:
+      - name: Cache the workspace
+        uses: actions/cache@v4
+        with:
+          path: ${{runner.workspace}}
+          key: build-openfast-release-${{ github.sha }}
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt
+          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
+      - name: Install openfast_io
+        working-directory: ${{runner.workspace}}/openfast/openfast_io
+        run: |
+          pip install -e .
+      - name: Configure Tests
+        working-directory: ${{runner.workspace}}/openfast/build
+        run: |
+          cmake \
+            -DPython_ROOT_DIR:STRING=${{env.pythonLocation}} \
+            -DBUILD_TESTING:BOOL=ON \
+            -DCTEST_PLOT_ERRORS:BOOL=ON \
+            ${GITHUB_WORKSPACE}
+          cmake --build . --target regression_test_controllers
+      - name: Run openfast_io tests
+        working-directory: ${{runner.workspace}}/openfast/build
+        run: |
+          ctest -VV -j4 \
+          -L openfast_io 
+      - name: Failing test artifacts
+        uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: rtest-openfast_io
+          path: |
+            ${{runner.workspace}}/openfast/build/reg_tests/openfast_io
+
 
   rtest-OF-simulink:
     runs-on: ubuntu-22.04

.github/workflows/deploy.yml

@@ -6,38 +6,75 @@ name: deploy
 
 on:
   workflow_dispatch:
-
+  
   release:
     types:
       - released
 
+
 jobs:
-  publish-to-pypi:
+  publish-to-pypi-test:
     runs-on: ubuntu-latest
-    permissions:
-      id-token: write
-      contents: read
-
+    if: github.event_name == 'workflow_dispatch' 
     steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+          cache: 'pip'
 
-      - name: Install Poetry
-        uses: snok/install-poetry@v1.3.4
+      - name: Install Hatch
+        uses: pypa/hatch@install
 
-      - name: Build a binary wheel and a source tarball
-        run: poetry build
-        working-directory: openfast_python
+      - name: Install dependencies
+        run: pip install keyring[file]
 
-      - name: Publish package distributions to PyPI
-        uses: pypa/gh-action-pypi-publish@v1.8.14
+      - name: Build package
+        run: hatch build
+        working-directory: openfast_io
+
+      - name: Publish to PyPI test
+        env:
+          HATCH_INDEX_USER: __token__
+          HATCH_INDEX_AUTH: ${{ secrets.PYPI_TEST_TOKEN }}
+        run: hatch publish -r test
+        working-directory: openfast_io
+
+  publish-to-pypi:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release' 
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
         with:
-          packages-dir: openfast_python/dist
+          python-version: '3.12'
+          cache: 'pip'
+
+      - name: Install Hatch
+        uses: pypa/hatch@install
+
+      - name: Install dependencies
+        run: pip install keyring[file]
+
+      - name: Build package
+        run: hatch build
+        working-directory: openfast_io
 
+      - name: Publish to PyPI
+        env:
+          HATCH_INDEX_USER: __token__
+          HATCH_INDEX_AUTH: ${{ secrets.PYPI_TOKEN }}
+        run: hatch publish 
+        working-directory: openfast_io
 
   docker-build-and-push:
     runs-on: ubuntu-latest
-    timeout-minutes: 300
+    if: github.event_name == 'release'
+    timeout-minutes: 500
     env:
       DOCKERFILE_PATH: share/docker/Dockerfile
       DOCKERHUB_REPOSITORY: nrel/openfast

.gitignore

@@ -58,3 +58,7 @@ vs-build/
 #Simulink cache files
 varcache
 *.slxc
+
+# Python cache files
+openfast_io/dist/
+openfast_io/openfast_io/_version.py

docs/source/install/index.rst

@@ -217,17 +217,29 @@ You can also build your own custom images using our `Dockerfile` or base your im
 Install the ``openfast_io`` python wrapper
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 The ``openfast_io`` python package is a wrapper comprising readers and writers for converting OpenFAST files to/from
-python objects. You can install it with:
+python objects.
 
-.. code-block::
+To use `openfast_io` as a library for incorporation into other scripts or tools, it is available via (assuming that you have already setup your python environment):
+
+.. code-block:: bash
 
     pip install openfast_io
 
-or
+These instructions are for interaction directly with the `openfast_io` source code.
+
+1. Follow this step only if you have not cloned the OpenFAST repo:
+
+.. code-block:: bash
+
+    git clone https://github.com/OpenFAST/OpenFAST.git
+    cd OpenFAST
 
-.. code-block::
+2. Assuming you are within the OpenFAST directory:
+
+.. code-block:: bash
 
-    poetry add openfast_io
+    cd openfast_io
+    pip install -e .
 
 For more information and installation options, see the `OpenFAST Python readme <https://github.com/OpenFAST/openfast/blob/main/openfast_python/README.md>`_.
 

openfast_io/README.md

@@ -0,0 +1,51 @@
+# OpenFAST python readers/writers
+
+This package is a python wrapper comprising readers and writers for converting OpenFAST files to/from python objects. It
+was originally written for [WEIS](https://github.com/WISDEM/WEIS/tree/77a878d7989b8c1d07d2244135ccd308a193a924/weis/aeroelasticse) and has been ported over to OpenFAST to make it more widely accessible. 
+
+## Installation
+Installation with [Anaconda](https://www.anaconda.com) is the recommended approach because of the ability to create self-contained environments suitable for testing and analysis.
+
+### Installation as a "library"
+
+To use `openfast_io` as a library for incorporation into other scripts or tools, it is available via (assuming that you have already setup your python environment):
+
+```shell
+pip install openfast_io
+```
+
+### Installation as an editable library
+
+These instructions are for interaction directly with the `openfast_io` source code.
+
+0. Follow this step only if you have not cloned the OpenFAST repo.
+    ```shell
+    git clone https://github.com/OpenFAST/OpenFAST.git
+    cd OpenFAST
+    ```
+
+1. Assuming you are within the OpenFAST directory.
+    ```shell
+    cd openfast_io
+    pip install -e .
+    ```
+
+2. To test `openfast_io`, OpenFAST must be compiled within the build folder, then run:
+
+    ```shell
+    cd tests
+    pytest test_of_io_pytest.py
+    ```
+
+### Extra options
+[ROSCO](https://github.com/NREL/ROSCO) can be installed as an optional dependency. Run either
+```shell
+pip install openfast_io[rosco]
+```
+
+## Development and testing
+To contribute to the development of `openfast_io`, install additioal depemndancies using:
+
+```shell
+pip install -e ".[all]"
+```

openfast_python/openfast_io/FAST_output_reader.py → openfast_io/openfast_io/FAST_output_reader.py

@@ -103,15 +103,15 @@ def toDataFrame(self):
         return df
 
 
-def load_ascii_output(filename):
+def load_ascii_output(filename, headerLines = 8, descriptionLine = 4, attributeLine = 6, unitLine = 7, delimiter = None):
     with open(filename) as f:
         info = {}
         info['name'] = os.path.splitext(os.path.basename(filename))[0]
-        header = [f.readline() for _ in range(8)]
-        info['description'] = header[4].strip()
-        info['attribute_names'] = header[6].split()
-        info['attribute_units'] = [unit[1:-1] for unit in header[7].split()]  #removing "()"
-        data = np.array([line.split() for line in f.readlines()], dtype=float)
+        header = [f.readline() for _ in range(headerLines)]
+        info['description'] = header[descriptionLine].strip()
+        info['attribute_names'] = header[attributeLine].strip().split(delimiter)
+        info['attribute_units'] = [unit[1:-1] for unit in header[unitLine].strip().split(delimiter)]  #removing "()"
+        data = np.array([line.split(delimiter) for line in f.readlines()], dtype=float)
         return data, info
 
 def load_binary_output(filename):
@@ -211,16 +211,20 @@ def fread(fid, n, type):
 
 
 if __name__=="__main__":
-    d,i = load_binary_output('Test18.T1.outb')
-    types = []
-    for j in range(39):
-        types.append('f8')
-    print(type(i['attribute_names']))
 
-    print(np.dtype({'names':tuple(i['attribute_names']), 'formats': tuple(types) }))
-    print(type(d))
-    print(np.array(d,dtype=np.dtype({'names':tuple(i['attribute_names']), 'formats': tuple(types) })))
+    from openfast_io.FileTools import check_rtest_cloned
+
+    parent_dir = os.path.dirname( os.path.dirname( os.path.dirname( os.path.realpath(__file__) ) ) ) + os.sep
+
+    of_outputfile = os.path.join(parent_dir, 'reg_tests', 'r-test', 'glue-codes', 
+                                 'openfast', '5MW_Land_BD_DLL_WTurb', '5MW_Land_BD_DLL_WTurb.outb')
 
+    check_rtest_cloned(of_outputfile)
+
+    d,i,p = load_binary_output(of_outputfile)
+
+    print(tuple(i['attribute_names']))
+    print(type(d))
     print(i)
     print(len(i['attribute_names']))
     print(np.shape(d))