Skip to content

Commit f551eb4

Browse files
andrew-plattandrew-platt
authored
Merge pull request #3246 from andrew-platt/r/4.2.1_releaseNotes
release notes for 4.2.1
2 parents 0a2ada4 + 71654a4 commit f551eb4

File tree

5 files changed

+151
-3
lines changed

5 files changed

+151
-3
lines changed

‎docs/changelogs/v4.2.1.md‎

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
**Feature or improvement description**
2+
Pull request to merge `dev` into `main` for release version 4.2.1
3+
4+
See the milestone and project pages for additional information
5+
6+
https://github.com/OpenFAST/openfast/milestone/27
7+
8+
No test results change
9+
10+
### Release checklist:
11+
- [ ] Update the documentation version in docs/conf.py
12+
- [ ] Update the versions in docs/source/user/api\_change.rst
13+
- [ ] Update version info in openfast\_io/pyproject.toml (`openfast_io` package)
14+
- [ ] Update version info in glue-codes/python/pyproject.toml (`pyOpenFAST` package for testing)
15+
- [ ] Verify readthedocs builds correctly
16+
- [ ] Create an annotated tag in OpenFAST during merge (mark as most recent if necessary)
17+
- [ ] Create a merge commit in r-test and add a corresponding annotated tag
18+
- [ ] Upload Docker image
19+
- [ ] Compile executables for Windows builds
20+
- [ ] `AeroDisk_Driver_x64.exe`
21+
- [ ] `AeroDyn_Driver_x64.exe`
22+
- [ ] `AeroDyn_Driver_x64_OpenMP.exe`
23+
- [ ] `AeroDyn_Inflow_c_binding_x64.dll`
24+
- [ ] `AeroDyn_Inflow_c_binding_x64_OpenMP.dll`
25+
- [ ] `BeamDyn_Driver_x64.exe`
26+
- [ ] `DISCON.dll (x64)`
27+
- [ ] `DISCON_ITIBarge.dll (x64)`
28+
- [ ] `DISCON_OC3Hywind.dll (x64)`
29+
- [ ] `FAST.Farm_x64.exe`
30+
- [ ] `FAST.Farm_x64_OMP.exe`
31+
- [ ] `FAST_SFunc.mexw64`
32+
- [ ] `HydroDynDriver_x64.exe`
33+
- [ ] `HydroDyn_C_Binding_x64.dll`
34+
- [ ] `IinflowWind_c_binding_x64.dll`
35+
- [ ] `InflowWind_Driver_x64.exe`
36+
- [ ] `InflowWind_Driver_x64_OpenMP.exe`
37+
- [ ] `MoorDyn_Driver_x64.exe`
38+
- [ ] `MoorDyn_c_binding_x64.dll`
39+
- [ ] `OpenFAST-Simulink_x64.dll`
40+
- [ ] `openfast_x64.exe`
41+
- [ ] `SeaStateDriver_x64.exe`
42+
- [ ] `SeaState_c_binding_x64.dll`
43+
- [ ] `SimpleElastoDyn_x64.exe`
44+
- [ ] `SubDyn_x64.exe`
45+
- [ ] `Turbsim_x64.exe`
46+
- [ ] `UnsteadyAero_x64.exe`
47+
48+
49+
50+
# Release Overview
51+
------------------
52+
53+
54+
55+
### Contribution Acknowledgements
56+
57+
We are grateful for a first time code contributions from @IrisMeasure.
58+
59+
60+
61+
# Changelog (from 4.2.1)
62+
------------------------
63+
64+
65+
## Solvers
66+
67+
### OpenFAST
68+
69+
#3243 Add high res windslice at `T=t_low - DT_high` (Fix for FAST.Farm issue #3183) (@andrew-platt)
70+
71+
72+
73+
## Modules
74+
75+
## AeroDyn
76+
77+
#### AeroDyn Driver / AeroDyn\_Inflow\_C\_Bindings interface
78+
79+
#3214 [BugFix] ADI c-bind: comment out code that causes segfaults with interface debugging (@andrew-platt)
80+
81+
#3227 [BugFix] AD: DTAero from input file was ignored (@andrew-platt)
82+
83+
#3230 [BugFix] AD driver: hub acceleration value incorrect in RotMotionType==1 (@andrew-platt)
84+
85+
86+
### NWTC-Library
87+
88+
#3123 Switch from xPPTRF to xPOTRF to improve TurbSim speed on macOS (@IrisMeasure)
89+
90+
#3229 Re-add the xPPTRF routines (rename xPOTRF routines from #3123) (@andrew-platt)
91+
92+
93+
### SeaState
94+
95+
#3235 backport of #3231 - SS WaveTp logic (@andrew-platt, @RBergua)
96+
97+
#3236 Add SeaSt\_C\_GetFluidDynP routine to SeaState\_C\_Binding interface (@andrew-platt)
98+
99+
100+
### TurbSim
101+
102+
#3224 Fix TurbSim compile with OpenMP and IFX compiler (@deslaughter)
103+
104+
105+
106+
## Testing and input file processing
107+
108+
### Regression and Unit testing
109+
110+
#3228 regtest: check if destination dirs exist before copyTree call (@andrew-platt)
111+
112+
113+
114+
## Input file changes
115+
116+
No input file changes since v4.2.0
117+
118+
119+
## Known issues
120+
There are several issues that have not been addressed in this release due to time constraints, but will be addressed in future releases. These include:
121+
122+
- No visualization of rectangular members from _HydroDyn_ or _SubDyn_ through the VTK output options
123+
- Missing and broken features from several c-binding library interfaces:
124+
- the _AeroDyn\_Inflow\_c-binding_ library interface does not allow for coupling to the tower. This will require an interface update.
125+
- the _HydroDyn\_c-binding_ library interface does not currently support vizualization. This will require an interface update.
126+
- the `InitNodePositions` input to _HydroDyn\_c-binding_ library interface does not currently work with any non-zero `x` or `y` coordinates (non-zero `z` is ok)
127+
- the _MoorDyn\_c-binding_ library interface does not currently support vizualization. This will require an interface update.
128+
- Documentation on the new _pyOpenFAST_ module is incomplete. Partial documentation exists on how to use it in regression testing, but no documentation or examples exist on using it to call c-bindings modules from Python.
129+
- Documentation is incomplete for _HydroDyn_, _SubDyn_, and a few other modules.
130+
131+
132+
# Precompiled Windows Binaries
133+
The binary files in this release were built with the Visual Studio solution files distributed with OpenFAST (not using cmake), using
134+
135+
- Intel Fortran Essentials 2025.3.0.333
136+
- Microsoft Visual Studio 2022 Version 17.14.23.
137+
- MATLAB 2025.2.999 (R2025b)
138+
- Executables with `_OpenMP` or `_OMP` in the name are built with OpenMP libraries and linked with dynamic libraries.
139+
- 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).
140+
141+
**The other OpenFAST executables DO NOT require these redistributable libraries to be installed. Instead, they were built with static libraries.**

‎docs/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ def runDoxygen(sourcfile, doxyfileIn, doxyfileOut):
139139
# The short X.Y version.
140140
version = f'4.2'
141141
# The full version, including alpha/beta/rc tags.
142-
release = f'v4.2.0'
142+
release = f'v4.2.1'
143143

144144
# The language for content autogenerated by Sphinx. Refer to documentation
145145
# for a list of supported languages.

‎docs/source/user/api_change.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ The line number corresponds to the resulting line number after all changes are i
1010
Thus, be sure to implement each in order so that subsequent line numbers are correct.
1111

1212

13+
OpenFAST v4.2.0 to OpenFAST v4.2.1
14+
----------------------------------
15+
16+
No input file changes were made.
17+
18+
19+
1320
OpenFAST v4.1.x to OpenFAST v4.2.0
1421
----------------------------------
1522

‎glue-codes/python/pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "pyOpenFAST"
7-
version = "4.2.0"
7+
version = "4.2.1"
88
description = "Python interface to OpenFAST FAST Library and physics modules."
99
readme = "README.md"
1010
requires-python = ">=3.9"

‎openfast_io/pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
55
[project]
66
name = "openfast_io"
77
# dynamic = ["version"]
8-
version = "4.2.0"
8+
version = "4.2.1"
99
description = "Readers and writers for OpenFAST files."
1010
license = {file = "../LICENSE"}
1111
authors = [

0 commit comments

Comments
 (0)