Release 3.5.4

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

@@ -43,7 +43,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
+          # cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -128,7 +128,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
+          # cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -173,7 +173,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
+          # cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -226,7 +226,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
+          # cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -263,7 +263,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
+          # cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -300,7 +300,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
+          # cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -339,7 +339,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
+          # cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -400,7 +400,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
+          # cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -455,7 +455,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
+          # cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -513,7 +513,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
+          # cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -560,7 +560,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
+          # cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -612,7 +612,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
+          # cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -661,7 +661,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
+          # cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -710,7 +710,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
+          # cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -759,7 +759,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
+          # cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -808,7 +808,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
+          # cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -857,7 +857,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
+          # cache: 'pip'
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
@@ -906,7 +906,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
-          cache: 'pip'
+          # 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/install-poetry@v1.3.4
+
+      - name: Build a binary wheel and a source tarball
+        run: poetry build
+        working-directory: openfast_python
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.8.14
+        with:
+          packages-dir: openfast_python/dist
+
+
+  docker-build-and-push:
     runs-on: ubuntu-latest
     timeout-minutes: 300
     env:

.gitignore

@@ -43,6 +43,7 @@ vs-build/
 .fortls
 .devcontainer
 .idea
+.env
 
 # backup files
 *.asv

cmake/OpenfastFortranOptions.cmake

@@ -158,7 +158,9 @@ endmacro(set_fast_intel_fortran)
 # arch
 #
 macro(set_fast_intel_fortran_posix)
-  set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} -fpic -fpp")
+  # Set size where temporary are stored on heap instead of stack
+  #   1000: size in kB (1 MB)
+  set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} -fpic -fpp -heap-arrays 1000")
 
   # debug flags
   if(CMAKE_BUILD_TYPE MATCHES Debug)
@@ -201,7 +203,9 @@ macro(set_fast_intel_fortran_windows)
   # Turn off specific warnings
   # - 5199: too many continuation lines
   # - 5268: 132 column limit
-  set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} /Qdiag-disable:5199,5268 /fpp")
+  # Set size where temporary are stored on heap instead of stack
+  #   1000: size in kB (1 MB)
+  set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} /Qdiag-disable:5199,5268 /fpp /heap-arrays:1000")
 
   # If double precision, make constants double precision
   if (DOUBLE_PRECISION)

docs/changelogs/v3.5.4.md

@@ -0,0 +1,92 @@
+**Feature or improvement description**
+Pull request to merge `rc-3.5.4` into `main` and create a tagged release for v3.5.4.
+
+See the milestone and project pages for additional information
+
+    https://github.com/OpenFAST/openfast/milestone/14
+
+Test results, if applicable
+See GitHub Actions
+
+### Release checklist:
+- [ ] Update the documentation version in docs/conf.py
+- [ ] Update the versions in docs/source/user/api_change.rst
+- [ ] Verify readthedocs builds correctly
+- [ ] Create a tag in OpenFAST
+- [ ] Create a merge commit in r-test and add a corresponding annotated tag
+- [ ] Compile executables for Windows builds
+    - [ ] AeroDyn_Driver_x64.exe
+    - [ ] AeroDyn_Driver_x64_OpenMP.exe
+    - [ ] AeroDyn_Inflow_C_Binding_x64.dll
+    - [ ] AeroDyn_Inflow_C_Binding_x64_OpenMP.dll
+    - [ ] BeamDyn_Driver_x64.exe
+    - [ ] DISCON.dll (x64)
+    - [ ] DISCON_ITIBarge.dll (x64)
+    - [ ] DISCON_OC3Hywind.dll (x64)
+    - [ ] DISCON_SC.dll (x64)
+    - [ ] FAST.Farm_x64.exe
+    - [ ] FAST.Farm_x64_OMP.exe
+    - [ ] FAST_SFunc.mexw64
+    - [ ] HydroDynDriver_x64.exe
+    - [ ] HydroDyn_C_Binding_x64.dll
+    - [ ] IfW_C_Binding_x64.dll
+    - [ ] InflowWind_Driver_x64.exe
+    - [ ] InflowWind_Driver_x64_OpenMP.exe
+    - [ ] MoorDyn_Driver_x64.exe
+    - [ ] MoorDyn_C_Binding_x64.dll
+    - [ ] OpenFAST-Simulink_x64.dll
+    - [ ] openfast_x64.exe
+    - [ ] Turbsim_x64.exe
+
+# Changelog
+
+## Overview
+
+This release includes performance improvements for BeamDyn (up to 30% speed increase), python file readers and writers from WEIS, and a fix for stack overflows with FAST.Farm (Intel compilation).  A few other minor updates are inluded as outlined below.
+
+Anyone using BeamDyn will want to update to this version.
+
+
+## General
+
+### Build systems
+
+#2311 Always build `openfastcpplib` as shared. Use `BUILD_OPENFAST_CPP_DRIVER` to disable `openfastcpp` executable (@deslaughter)
+#2173 Fix crash in `MAP_End` when using Intel's new icx compiler and disable caching in setup-python GH action (@deslaughter)
+
+
+### Python file readers/writers
+
+#2188 Add WEIS file readers and writers (@cortadocodes and @mayankchetan)
+
+
+## Solvers
+
+### FAST.Farm
+
+#2452  Fix for some stack overflow issues with FAST.Farm when copying large amounts of wind data (closes #2053) (@andrew-platt)
+#2340  Add `!$ OMP critical` around file opening for VTK to prevent file collision (@andrew-platt)
+
+
+## Module changes
+
+### BeamDyn
+
+#2399 BeamDyn performance improvements (@deslaughter)
+
+
+### ElastoDyn
+
+#2321 Backport of #2317: Explicitly initialize `ED` `RtHS` to zero -- corrects issue with inccorect linearization results (@andrew-platt)
+
+
+
+
+## Input file changes
+
+No input files change with this release, as this only includes minor bugfixes.
+
+Full list of changes: https://openfast.readthedocs.io/en/main/source/user/api_change.html
+
+Full input file sets: https://github.com/OpenFAST/r-test/tree/v3.5.4 (example input files from the regression testing)
+

docs/conf.py

@@ -130,7 +130,7 @@ def runDoxygen(sourcfile, doxyfileIn, doxyfileOut):
 # The short X.Y version.
 version = u'3.5'
 # The full version, including alpha/beta/rc tags.
-release = u'v3.5.3'
+release = u'v3.5.4'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

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: