Merge pull request OpenFAST#3167 from OpenFAST/dev

Release 4.2.0

Author: andrew-platt

.github/PULL_REQUEST_TEMPLATE.md

@@ -14,18 +14,16 @@
 **Additional supporting information**
 <!-- Add any other context about the problem here. -->
 
+**Generative AI usage**
+<!-- describe any generative AI used
+If substantial portions are generated with AI, include a reference like one of the following:
+Co-authored-by: Google Gemini <gemini@google.com>
+Co-authored-by: OpenAI ChatGPT <chatgpt@openai.com>
+Co-authored-by: Microsoft Copilot <copilot@microsoft.com>
+Co-authored-by: Anthropic Claude <claude@anthropic.com>
+Assisted by: GitHub Copilot <support@github.com>
+-->
+
 **Test results, if applicable**
 <!-- Add the results from unit tests and regression tests here along with justification for any failing test cases. -->
-
-<!-- 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 tag
-- [ ] Compile executables for Windows builds
-    - [ ] FAST_SFunc.mexw64
-    - [ ] OpenFAST-Simulink_x64.dll
-    - [ ] openfast_x64.exe
-    - [ ] DISCON.dll
--->
+- [ ] r-test branch merging required

.github/scripts/build_windows_executables.bat

@@ -35,6 +35,7 @@ devenv vs-build/TurbSim/TurbSim.vfproj /Build "Release|x64"
 devenv vs-build/UnsteadyAero/UnsteadyAero.sln /Build "Release|x64"
 
 @REM Build MATLAB solution last
+rd /s /q .\build\lib
 devenv vs-build/FAST/FAST.sln /Build "Release_Matlab|x64"
 
 @REM Copy controllers to bin directory

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

@@ -368,10 +368,12 @@ jobs:
           path: |
             ${{github.workspace}}/build/reg_tests/glue-codes/openfast-cpp
             ${{github.workspace}}/build/reg_tests/glue-codes/python
+            ${{github.workspace}}/build/reg_tests/glue-codes/other
             ${{github.workspace}}/build/reg_tests/modules/aerodyn
             ${{github.workspace}}/build/reg_tests/modules/moordyn
             ${{github.workspace}}/build/reg_tests/modules/inflowwind
             ${{github.workspace}}/build/reg_tests/modules/hydrodyn
+            ${{github.workspace}}/build/reg_tests/modules/seastate
             !${{github.workspace}}/build/reg_tests/glue-codes/openfast-cpp/5MW_Baseline
 
 

.github/workflows/deploy.yml

@@ -149,30 +149,15 @@ jobs:
         shell: cmd
         run: .github/scripts/windows_devenv_test.bat
 
-      - name: Install Intel oneAPI BaseKit (Windows)
+      - name: Install Intel oneAPI Fortran Essentials (Windows)
         shell: cmd
         env:
-          URL: https://registrationcenter-download.intel.com/akdlm/IRC_NAS/7dff44ba-e3af-4448-841c-0d616c8da6e7/w_BaseKit_p_2024.1.0.595_offline.exe
-          COMPONENTS: intel.oneapi.win.mkl.devel
+          URL: https://registrationcenter-download.intel.com/akdlm/IRC_NAS/b626b5cf-8a15-40a4-be9a-9edabbb7cf17/intel-fortran-essentials-2025.3.0.333_offline.exe
         run: |
           curl.exe --output %TEMP%\webimage.exe --url %URL% --retry 5 --retry-delay 5
           start /b /wait %TEMP%\webimage.exe -s -x -f webimage_extracted --log extract.log
           del %TEMP%\webimage.exe
-          webimage_extracted\bootstrapper.exe -s --action install --components=%COMPONENTS% --eula=accept -p=NEED_VS2017_INTEGRATION=0 -p=NEED_VS2019_INTEGRATION=0 -p=NEED_VS2022_INTEGRATION=1 --log-dir=.
-          set installer_exit_code=%ERRORLEVEL%
-          rd /s/q "webimage_extracted"
-          exit /b %installer_exit_code%
-
-      - name: Install Intel oneAPI HPCKit (Windows)
-        shell: cmd
-        env:
-          URL: https://registrationcenter-download.intel.com/akdlm/IRC_NAS/c95a3b26-fc45-496c-833b-df08b10297b9/w_HPCKit_p_2024.1.0.561_offline.exe
-          COMPONENTS: intel.oneapi.win.ifort-compiler
-        run: |
-          curl.exe --output %TEMP%\webimage.exe --url %URL% --retry 5 --retry-delay 5
-          start /b /wait %TEMP%\webimage.exe -s -x -f webimage_extracted --log extract.log
-          del %TEMP%\webimage.exe
-          webimage_extracted\bootstrapper.exe -s --action install --components=%COMPONENTS% --eula=accept -p=NEED_VS2017_INTEGRATION=0 -p=NEED_VS2019_INTEGRATION=0 -p=NEED_VS2022_INTEGRATION=1 --log-dir=.
+          webimage_extracted\bootstrapper.exe -s --action install --eula=accept -p=NEED_VS2017_INTEGRATION=0 -p=NEED_VS2019_INTEGRATION=0 -p=NEED_VS2022_INTEGRATION=1 --log-dir=.
           set installer_exit_code=%ERRORLEVEL%
           rd /s/q "webimage_extracted"
           exit /b %installer_exit_code%

CMakeLists.txt

@@ -125,6 +125,11 @@ if (OPENMP)
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${OpenMP_CXX_FLAGS}")
     link_libraries("${OpenMP_CXX_LIBRARIES}")
   endif()
+elseif (NOT BLA_VENDOR)
+  # If we're not using OpenMP, and a specific BLAS vendor has not been set, 
+  # set MKL threading to sequential to avoid potential issues with 
+  # small calculations taking longer due to threading overhead (turbsim).
+  set(MKL_THREADING "sequential")
 endif()
 
 #-------------------------------------------------------------------------------

README.rst

@@ -16,7 +16,7 @@ OpenFAST is a wind turbine simulation tool which builds on FAST v8. FAST.Farm
 extends the capability of OpenFAST to simulate multi-turbine wind farms. They were
 created with the goal of being community models developed and used by research
 laboratories, academia, and industry. They are managed by a dedicated team at the
-National Renewable Energy Lab. Our objective is to ensure that OpenFAST and FAST.Farm
+National Laboratory of the Rockies. Our objective is to ensure that OpenFAST and FAST.Farm
 are sustainable software that are well tested and well documented. If you'd like
 to contribute, see the `Developer Documentation <https://openfast.readthedocs.io/en/dev/source/dev/index.html>`_
 and any open GitHub issues with the
@@ -30,11 +30,11 @@ tag.
 Part of the WETO Stack
 ----------------------
 
-OpenFAST is primarily developed with the support of the U.S. Department of Energy and is part of the `WETO Software Stack <https://nrel.github.io/WETOStack>`_. For more information and other integrated modeling software, see:
+OpenFAST is primarily developed with the support of the U.S. Department of Energy and is part of the `WETO Software Stack <https://NatLabRockies.github.io/WETOStack>`_. For more information and other integrated modeling software, see:
 
-* `Portfolio Overview <https://nrel.github.io/WETOStack/portfolio_analysis/overview.html>`_
-* `Entry Guide <https://nrel.github.io/WETOStack/_static/entry_guide/index.html>`_
-* `OpenFAST Workshop <https://nrel.github.io/WETOStack/workshops/user_workshops_2024.html#openfast-ecosystem>`_
+* `Portfolio Overview <https://NatLabRockies.github.io/WETOStack/portfolio_analysis/overview.html>`_
+* `Entry Guide <https://NatLabRockies.github.io/WETOStack/_static/entry_guide/index.html>`_
+* `OpenFAST Workshop <https://NatLabRockies.github.io/WETOStack/workshops/user_workshops_2024.html#openfast-ecosystem>`_
 
 
 FAST v8 - OpenFAST
@@ -155,18 +155,18 @@ Please use `GitHub Issues <https://github.com/OpenFAST/OpenFAST/issues>`_ to:
 * report bugs
 * request code enhancements
 
-Users and developers may also be interested in the NREL National Wind
-Technology Center (NWTC) `phpBB Forum <https://wind.nrel.gov/forum/wind/>`_,
+Users and developers may also be interested in the NLR National Wind
+Technology Center (NWTC) `Forum <https://forums.nrel.gov/>`_,
 which is still maintained and has a long history of FAST-related questions
 and answers.
 
 Acknowledgments
 ---------------
 
 OpenFAST and FAST.Farm are maintained and developed by researchers and software
-engineers at the `National Renewable Energy Laboratory <http://www.nrel.gov/>`_
-(NREL), with support from the US Department of Energy's Wind Energy Technology
-Office. NREL gratefully acknowledges development contributions from the following
+engineers at the `National Laboratory of the Rockies <http://www.nlr.gov/>`_
+(NLR), with support from the US Department of Energy's Wind Energy Technology
+Office. NLR gratefully acknowledges development contributions from the following
 organizations:
 
 * Envision Energy USA, Ltd

docs/changelogs/ReleaseProcess.md

@@ -33,6 +33,8 @@
 3. delete `rc-` branch if merging from one
 
 ### Windows executables build and upload
+NOTE: if available, use the `deploy` action on GitHub to build all the executables and upload those instead of this process.  This manual process is for when the GH action doesn't work.
+
 After posting and tagging release
 1. Pull main and tags
    * `git fetch --tags OpenFAST`

docs/changelogs/template.md

@@ -0,0 +1,188 @@
+**Feature or improvement description**
+Pull request to merge `dev` into `main` for release version X.Y.Z
+
+See the milestone and project pages for additional information
+
+    https://github.com/OpenFAST/openfast/milestone/XYZ
+
+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
+- [ ] Update version info in openfast\_io/pyproject.toml (`openfast_io` package)
+- [ ] Update version info in glue-codes/python/pyproject.toml (`pyOpenFAST` package for testing)
+- [ ] Verify readthedocs builds correctly
+- [ ] Create an annotated tag in OpenFAST during merge (mark as most recent if necessary)
+- [ ] Create a merge commit in r-test and add a corresponding annotated tag
+- [ ] Upload Docker image
+- [ ] Compile executables for Windows builds
+    - [ ] `AeroDisk_Driver_x64.exe`
+    - [ ] `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)`
+    - [ ] `FAST.Farm_x64.exe`
+    - [ ] `FAST.Farm_x64_OMP.exe`
+    - [ ] `FAST_SFunc.mexw64`
+    - [ ] `HydroDynDriver_x64.exe`
+    - [ ] `HydroDyn_C_Binding_x64.dll`
+    - [ ] `IinflowWind_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`
+    - [ ] `SeaStateDriver_x64.exe`
+    - [ ] `SeaState_c_binding_x64.dll`
+    - [ ] `SimpleElastoDyn_x64.exe`
+    - [ ] `SubDyn_x64.exe`
+    - [ ] `Turbsim_x64.exe`
+    - [ ] `UnsteadyAero_x64.exe`
+
+
+
+# Release Overview
+------
+
+
+
+### Contribution Acknowledgements
+
+### Statistics (since X.Y.Z)
+
+
+
+# Changelog (from X.Y.Z)
+------
+
+## General
+
+### Build systems
+
+#### CMake
+
+
+#### Visual Studio (Windows)
+
+
+
+### Docker
+
+
+### Documentation
+
+
+
+
+## Solvers
+
+### FAST.Farm
+
+
+### OpenFAST
+
+
+### OpenFAST interfaces
+
+#### OpenFASTcpp
+
+
+#### Simulink
+
+
+
+## Modules
+
+### Multiple
+
+
+### AeroDisk
+
+
+### AeroDyn
+
+#### Unsteady
+
+
+
+#### OLAF 
+
+
+#### AeroDyn Driver / AeroDyn\_Inflow\_C\_Bindings interface
+
+
+
+### ElastoDyn
+
+
+### ExtInflow
+
+
+### ExtLoads
+
+
+### HydroDyn
+
+
+### InflowWind
+
+
+### MAP++
+
+
+### MoorDyn
+
+
+### NWTC-Library
+
+
+### Registry
+
+
+### SeaState
+
+
+### Simplified-ElastoDyn
+
+
+### SubDyn
+
+
+
+## Testing and input file processing
+
+### openfast_io
+
+
+### GitHub actions
+
+
+### Regression and Unit testing
+
+
+
+
+## Input file changes
+
+
+## Known issues
+
+
+
+# Precompiled Windows Binaries
+The binary files in this release were built with the Visual Studio solution files distributed with OpenFAST (not using cmake), using
+
+- Intel Fortran Essentials 2025.3.0.333
+- Microsoft Visual Studio 2022 Version 17.14.23.
+- MATLAB 2025.2.999 (R2025b)
+- Executables with `_OpenMP` or `_OMP` in the name are built with OpenMP libraries and linked with dynamic libraries.
+   - You will need [this Intel Fortran redistributable package](https://registrationcenter-download.intel.com/akdlm/IRC_NAS/0dc56e76-d2c0-4bb8-9c83-c2ee3952b855/w_ifx_runtime_p_2025.2.1.1001.exe) installed to use these executables if you do not already have Intel Fortran OneAPI 2024 installed. See the installation instructions [here](https://software.intel.com/content/www/us/en/develop/articles/redistributable-libraries-for-intel-c-and-fortran-2022-compilers-for-windows.html).
+
+**The other OpenFAST executables DO NOT require these redistributable libraries to be installed. Instead, they were built with static libraries.**