Skip to content

Commit a60dbe4

Browse files
andrew-plattandrew-platt
committed
Update release notes for v4.1.2
1 parent 4eeb7c1 commit a60dbe4

File tree

5 files changed

+145
-3
lines changed

5 files changed

+145
-3
lines changed

‎docs/changelogs/v4.1.2.md‎

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
**Feature or improvement description**
2+
Pull request to merge `rc-4.1.2` into `main` and create a tagged release for v4.1.2
3+
4+
See the milestone and project pages for additional information
5+
6+
https://github.com/OpenFAST/openfast/milestone/25
7+
8+
Test results, if applicable
9+
See GitHub Actions
10+
11+
### Release checklist:
12+
- [ ] Update the documentation version in docs/conf.py
13+
- [ ] Update the versions in docs/source/user/api\_change.rst
14+
- [ ] Update version info in openfast\_io/pyproject.toml (`openfast_io` package)
15+
- [ ] Update version info in glue-codes/python/pyproject.toml (`pyOpenFAST` package for testing)
16+
- [ ] Verify readthedocs builds correctly
17+
- [ ] Create an annotated tag in OpenFAST during merge (mark as most recent if necessary)
18+
- [ ] Create a merge commit in r-test and add a corresponding annotated tag
19+
- [ ] Upload Docker image
20+
- [ ] Compile executables for Windows builds
21+
- [ ] `AeroDisk_Driver_x64.exe`
22+
- [ ] `AeroDyn_Driver_x64.exe`
23+
- [ ] `AeroDyn_Driver_x64_OpenMP.exe`
24+
- [ ] `AeroDyn_Inflow_c_binding_x64.dll`
25+
- [ ] `AeroDyn_Inflow_c_binding_x64_OpenMP.dll`
26+
- [ ] `BeamDyn_Driver_x64.exe`
27+
- [ ] `DISCON.dll (x64)`
28+
- [ ] `DISCON_ITIBarge.dll (x64)`
29+
- [ ] `DISCON_OC3Hywind.dll (x64)`
30+
- [ ] `DISCON_SC.dll (x64)`
31+
- [ ] `FAST.Farm_x64.exe`
32+
- [ ] `FAST.Farm_x64_OMP.exe`
33+
- [ ] `FAST_SFunc.mexw64`
34+
- [ ] `HydroDynDriver_x64.exe`
35+
- [ ] `HydroDyn_C_Binding_x64.dll`
36+
- [ ] `IinflowWind_c_binding_x64.dll`
37+
- [ ] `InflowWind_Driver_x64.exe`
38+
- [ ] `InflowWind_Driver_x64_OpenMP.exe`
39+
- [ ] `MoorDyn_Driver_x64.exe`
40+
- [ ] `MoorDyn_c_binding_x64.dll`
41+
- [ ] `OpenFAST-Simulink_x64.dll`
42+
- [ ] `openfast_x64.exe`
43+
- [ ] `SeaStateDriver_x64.exe`
44+
- [ ] `SeaState_c_binding_x64.dll`
45+
- [ ] `SimpleElastoDyn_x64.exe`
46+
- [ ] `SubDyn_x64.exe`
47+
- [ ] `Turbsim_x64.exe`
48+
- [ ] `UnsteadyAero_x64.exe`
49+
50+
# Changelog (from 4.1.1)
51+
52+
## Overview
53+
54+
This release includes several bug fixes and improvements for _OpenFAST_ and fixes a critical error in the Visual Studio build system for _OpenFAST_ and _MoorDyn_.
55+
56+
57+
## General
58+
59+
### Visual Studio build system
60+
61+
#2914 Add SeaState path when running MoorDyn registry in RunRegistry.bat (@deslaughter)
62+
63+
64+
65+
66+
67+
68+
## Solvers
69+
70+
### OpenFAST
71+
72+
#2915 Don't allow MAP when writing checkpoint files (@deslaughter)
73+
74+
75+
76+
## Module changes
77+
78+
### HydroDyn
79+
80+
#2941 HD: Switched to an equivalent but numerically more reliable expression for the hydrostatic moment on (partially wetted) circular endplates (@luwang00)
81+
82+
83+
84+
### ServoDyn
85+
86+
#2942 SrvD: bugfix linearization of StC `_dYdx` was not using `x_perturb` (@andrew-platt)
87+
88+
### SubDyn
89+
90+
#2919 Backport of #2906 ( SeaState: Allow WaveStMod=1 with WaveMod=0) (@luwang00)
91+
92+
#2934 Backport of 2905: SD: Fix a bug where interface DoF loads are incomplete if the interface joint is part of a rigid assembly (@luwang00)
93+
94+
95+
96+
97+
## Code API changes
98+
99+
#### CPP interface
100+
101+
102+
103+
### HydroDyn c-binding library interface
104+
105+
106+
## Documentation
107+
108+
#2931 docs: add guide for WSL+VScode (@skvibimigger)
109+
110+
#2937 Docs update recomendations from issue #1822 (FAST.Farm) (@andrew-platt)
111+
112+
113+
## Testing
114+
115+
Test results for the `StC_test_OC4Semi_Linear_Nac` and `StC_test_OC4Semi_Linear_Tow` cases were updated in #2942 - these were missing effects from the state variables for structural controls.
116+
117+
118+
## Input file changes
119+
120+
No input file changes since v4.1.0
121+
122+
123+
## Known issues
124+
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:
125+
126+
- No visualization of rectangular members from _HydroDyn_ or _SubDyn_ through the VTK output options
127+
- Missing and broken features from several c-binding library interfaces:
128+
- the _AeroDyn\_Inflow\_c-binding_ library interface does not allow for coupling to the tower. This will require an interface update.
129+
- the _HydroDyn\_c-binding_ library interface does not currently support vizualization. This will require an interface update.
130+
- 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)
131+
- the _MoorDyn\_c-binding_ library interface does not currently support vizualization. This will require an interface update.
132+
- error messages from c-binding library interfaces will get truncated to 1024 characters. A fix is nearly ready, but will have to wait until the next release.
133+
- A `glue-codes/labview/src/WaveTank.f90` file is included in this release, but it is incomplete and untested. This is a placeholder for internal development work that may be released in complete form at a later date.
134+
- The GitHub `deploy` action to build Windows executables does not currently catch failed builds. This might be addressed at a later date. We are manually checking these builds for now.
135+
- 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.
136+
- Documentation is incomplete for _HydroDyn_, _SubDyn_, and a few other modules.

‎docs/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ def runDoxygen(sourcfile, doxyfileIn, doxyfileOut):
138138
# The short X.Y version.
139139
version = u'4.1'
140140
# The full version, including alpha/beta/rc tags.
141-
release = u'v4.1.1'
141+
release = u'v4.1.2'
142142

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

‎docs/source/user/api_change.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ 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.1.1 to OpenFAST v4.1.2
14+
----------------------------------
15+
16+
No input file changes were made.
17+
18+
1319
OpenFAST v4.1.0 to OpenFAST v4.1.1
1420
----------------------------------
1521

‎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.1.1"
7+
version = "4.1.2"
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.1.1"
8+
version = "4.1.2"
99
description = "Readers and writers for OpenFAST files."
1010
license = {file = "../LICENSE"}
1111
authors = [

0 commit comments

Comments
 (0)