Merge remote-tracking branch 'OpenFAST/dev' into f/ifw_driver_XYslice

.github/actions/tests-module-aerodyn/action.yml

@@ -14,7 +14,7 @@ runs:
     - run: |
 
         if [[ ${{ inputs.test-target }} == "unit" ]] || [[ ${{ inputs.test-target }} == "all" ]]; then
-          ctest -VV -R fvw_utest
+          ctest -VV -R aerodyn_utest
         fi
 
         if [[ ${{ inputs.test-target }} == "regression" ]] || [[ ${{ inputs.test-target }} == "all" ]]; then

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

@@ -43,7 +43,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
       - name: Set up MATLAB
         uses: matlab-actions/setup-matlab@v2
         with:
@@ -133,7 +132,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -178,7 +176,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
       - name: Set up MATLAB
         uses: matlab-actions/setup-matlab@v2
         with:
@@ -236,7 +233,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -273,7 +269,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -310,7 +305,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -349,7 +343,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -409,7 +402,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -466,7 +458,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -526,7 +517,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -573,7 +563,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -657,7 +646,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
@@ -706,7 +694,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.10'
-          cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -755,7 +742,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -804,7 +790,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -853,7 +838,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -902,7 +886,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -951,7 +934,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -999,7 +981,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt

.github/workflows/build-docker-image-automatic.yml → .github/workflows/deploy.yml

@@ -1,16 +1,41 @@
-# This workflow builds an OpenFAST docker image for the linux/amd64 and linux/aarch64 architectures on merge into
-# `main` from a release candidate branch. The image is tagged both with "latest" and the version extracted from the
-# release candidate branch's name (e.g. "rc-3.5.3") before being pushed to the `nrel/openfast` repository. The build
-# cache is stored in GitHub actions.
-name: build-docker-image-automatic
+# This workflow uploads the `openfast` python package to PyPI before building an OpenFAST docker image for the
+# linux/amd64 and linux/aarch64 architectures on release. The image is tagged both with "latest" and the version
+# extracted from the release candidate branch's name (e.g. "rc-3.5.3") before being pushed to the `nrel/openfast`
+# repository. The build cache is stored in GitHub actions.
+name: deploy
 
 on:
+  workflow_dispatch:
+
   release:
     types:
       - released
 
 jobs:
-  build-and-push:
+  publish-to-pypi:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Install Poetry
+        uses: snok/[email protected]
+
+      - name: Build a binary wheel and a source tarball
+        run: poetry build
+        working-directory: openfast_python
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/[email protected]
+        with:
+          packages-dir: openfast_python/dist
+
+
+  docker-build-and-push:
     runs-on: ubuntu-latest
     timeout-minutes: 300
     env:

.gitignore

@@ -43,10 +43,12 @@ vs-build/
 .fortls
 .devcontainer
 .idea
+.env
 
 # backup files
 *.asv
 ~$*.xlsx
+.*.swp
 
 # LaTeX compiling files
 *.aux

.gitmodules

@@ -1,6 +1,3 @@
 [submodule "reg_tests/r-test"]
 	path = reg_tests/r-test
-	url = https://github.com/OpenFAST/r-test.git
-[submodule "unit_tests/pfunit"]
-	path = unit_tests/pfunit
-	url = https://github.com/Goddard-Fortran-Ecosystem/pFUnit.git
+	url = https://github.com/OpenFAST/r-test.git

CMakeLists.txt

@@ -110,13 +110,8 @@ include(${CMAKE_SOURCE_DIR}/cmake/set_rpath.cmake)
 # OpenMP
 #-------------------------------------------------------------------------------
 
-if (OPENMP OR BUILD_FASTFARM OR BUILD_OPENFAST_CPP_API)
-  if (OPENMP)
-    FIND_PACKAGE(OpenMP REQUIRED)
-  else()
-    # Optional for FF or the CPP interface
-    FIND_PACKAGE(OpenMP)
-  endif()
+if (OPENMP)
+  FIND_PACKAGE(OpenMP REQUIRED)
   if (OpenMP_Fortran_FOUND)
     set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} ${OpenMP_Fortran_FLAGS}")
     link_libraries("${OpenMP_Fortran_LIBRARIES}")
@@ -194,7 +189,7 @@ set(OPENFAST_MODULES
   inflowwind
   extloads
   aerodyn
-  aerodyn14
+  aerodisk
   servodyn
   elastodyn
   beamdyn
@@ -215,6 +210,7 @@ set(OPENFAST_MODULES
   supercontroller
   externalinflow
   openfast-library
+  simple-elastodyn
 )
 
 set(OPENFAST_REGISTRY_INCLUDES "" CACHE INTERNAL "Registry includes paths")

docs/OtherSupporting/OpenFAST_Algorithms/OpenFAST_Algorithms.tex

@@ -41,7 +41,6 @@ \section{Definitions and Nomenclature}
       \hline 
       ElastoDyn          & ED                    & ED        \\
       BeamDyn            & BD                    & BD        \\
-      AeroDyn14          & AD14                  & AD14      \\
       AeroDyn            & AD                    & AD        \\
       ServoDyn           & SrvD                  & SrvD      \\
       SubDyn             & SD                    & SD        \\

docs/source/install/index.rst

@@ -15,6 +15,9 @@ code,** refer to the table in the :ref:`download_binaries` or :ref:`use_docker`
 sections and read the corresponding documentation for specific instructions.
 For instructions on compiling, see :ref:`compile_from_source`.
 
+To manipulate OpenFAST files using python, see :ref:`python_wrapper`.
+
+
 .. _download_binaries:
 
 Download binaries
@@ -193,19 +196,40 @@ To pull and run with local files:
 
 .. code-block:: shell
 
-    docker run --rm -it --volume=/path/to/files:/files ghcr.io/OpenFAST/openfast:latest openfast /files/main.fst
+    docker run --rm -it --volume=/path/to/files:/files ghcr.io/openfast/openfast:latest openfast /files/main.fst
 
 For running the container interactively:
 
 .. code-block:: shell
 
-    docker run --rm -it --volume=/path/to/files:/files ghcr.io/OpenFAST/openfast:latest /bin/bash
+    docker run --rm -it --volume=/path/to/files:/files ghcr.io/openfast/openfast:latest /bin/bash
 
+To pull a specific release, substitute the version number in place of `latest` in the above commands (i.e. `ghcr.io/openfast/openfast:3.5.3`).
 
 Build your own images
 ---------------------
-You can also build your own custom images using our `Dockerfile` or base your images on ours. See
-`here <https://github.com/OpenFAST/openfast/blob/main/share/docker/README.md>`_ for more information on this.
+You can also build your own custom images using our `Dockerfile` or base your images on ours. See the
+`Docker readme <https://github.com/OpenFAST/openfast/blob/main/share/docker/README.md>`_ for more information on this.
+
+
+.. _python_wrapper:
+
+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:
+
+.. code-block::
+
+    pip install openfast_io
+
+or
+
+.. code-block::
+
+    poetry add openfast_io
+
+For more information and installation options, see the `OpenFAST Python readme <https://github.com/OpenFAST/openfast/blob/main/openfast_python/README.md>`_.
 
 
 .. _compile_from_source:

docs/source/testing/regression_test.rst

@@ -224,11 +224,11 @@ Flags can be compounded making useful variations such as
 
 .. code-block:: bash
 
-    # Run all cases that use AeroDyn14 with verbose output
-    ctest -V -L aerodyn14
+    # Run all cases that use SubDyn with verbose output
+    ctest -V -L subdyn
 
-    # Run all cases that use AeroDyn14 in 16 concurrent processes
-    ctest -j 16 -L aerodyn14
+    # Run all cases that use SubDyn in 16 concurrent processes
+    ctest -j 16 -L subdyn
 
     # Run the case with name "5MW_DLL_Potential_WTurb" with verbose output
     ctest -V -R 5MW_DLL_Potential_WTurb