|
| 1 | +**Feature or improvement description** |
| 2 | +Pull request to merge `dev` into `main` for release version X.Y.Z |
| 3 | + |
| 4 | +See the milestone and project pages for additional information |
| 5 | + |
| 6 | + https://github.com/OpenFAST/openfast/milestone/XYZ |
| 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 | + - [ ] `FAST.Farm_x64.exe` |
| 31 | + - [ ] `FAST.Farm_x64_OMP.exe` |
| 32 | + - [ ] `FAST_SFunc.mexw64` |
| 33 | + - [ ] `HydroDynDriver_x64.exe` |
| 34 | + - [ ] `HydroDyn_C_Binding_x64.dll` |
| 35 | + - [ ] `IinflowWind_c_binding_x64.dll` |
| 36 | + - [ ] `InflowWind_Driver_x64.exe` |
| 37 | + - [ ] `InflowWind_Driver_x64_OpenMP.exe` |
| 38 | + - [ ] `MoorDyn_Driver_x64.exe` |
| 39 | + - [ ] `MoorDyn_c_binding_x64.dll` |
| 40 | + - [ ] `OpenFAST-Simulink_x64.dll` |
| 41 | + - [ ] `openfast_x64.exe` |
| 42 | + - [ ] `SeaStateDriver_x64.exe` |
| 43 | + - [ ] `SeaState_c_binding_x64.dll` |
| 44 | + - [ ] `SimpleElastoDyn_x64.exe` |
| 45 | + - [ ] `SubDyn_x64.exe` |
| 46 | + - [ ] `Turbsim_x64.exe` |
| 47 | + - [ ] `UnsteadyAero_x64.exe` |
| 48 | + |
| 49 | + |
| 50 | + |
| 51 | +# Release Overview |
| 52 | +------ |
| 53 | + |
| 54 | + |
| 55 | + |
| 56 | +### Contribution Acknowledgements |
| 57 | + |
| 58 | +### Statistics (since X.Y.Z) |
| 59 | + |
| 60 | + |
| 61 | + |
| 62 | +# Changelog (from X.Y.Z) |
| 63 | +------ |
| 64 | + |
| 65 | +## General |
| 66 | + |
| 67 | +### Build systems |
| 68 | + |
| 69 | +#### CMake |
| 70 | + |
| 71 | + |
| 72 | +#### Visual Studio (Windows) |
| 73 | + |
| 74 | + |
| 75 | + |
| 76 | +### Docker |
| 77 | + |
| 78 | + |
| 79 | +### Documentation |
| 80 | + |
| 81 | + |
| 82 | + |
| 83 | + |
| 84 | +## Solvers |
| 85 | + |
| 86 | +### FAST.Farm |
| 87 | + |
| 88 | + |
| 89 | +### OpenFAST |
| 90 | + |
| 91 | + |
| 92 | +### OpenFAST interfaces |
| 93 | + |
| 94 | +#### OpenFASTcpp |
| 95 | + |
| 96 | + |
| 97 | +#### Simulink |
| 98 | + |
| 99 | + |
| 100 | + |
| 101 | +## Modules |
| 102 | + |
| 103 | +### Multiple |
| 104 | + |
| 105 | + |
| 106 | +### AeroDisk |
| 107 | + |
| 108 | + |
| 109 | +### AeroDyn |
| 110 | + |
| 111 | +#### Unsteady |
| 112 | + |
| 113 | + |
| 114 | + |
| 115 | +#### OLAF |
| 116 | + |
| 117 | + |
| 118 | +#### AeroDyn Driver / AeroDyn\_Inflow\_C\_Bindings interface |
| 119 | + |
| 120 | + |
| 121 | + |
| 122 | +### ElastoDyn |
| 123 | + |
| 124 | + |
| 125 | +### ExtInflow |
| 126 | + |
| 127 | + |
| 128 | +### ExtLoads |
| 129 | + |
| 130 | + |
| 131 | +### HydroDyn |
| 132 | + |
| 133 | + |
| 134 | +### InflowWind |
| 135 | + |
| 136 | + |
| 137 | +### MAP++ |
| 138 | + |
| 139 | + |
| 140 | +### MoorDyn |
| 141 | + |
| 142 | + |
| 143 | +### NWTC-Library |
| 144 | + |
| 145 | + |
| 146 | +### Registry |
| 147 | + |
| 148 | + |
| 149 | +### SeaState |
| 150 | + |
| 151 | + |
| 152 | +### Simplified-ElastoDyn |
| 153 | + |
| 154 | + |
| 155 | +### SubDyn |
| 156 | + |
| 157 | + |
| 158 | + |
| 159 | +## Testing and input file processing |
| 160 | + |
| 161 | +### openfast_io |
| 162 | + |
| 163 | + |
| 164 | +### GitHub actions |
| 165 | + |
| 166 | + |
| 167 | +### Regression and Unit testing |
| 168 | + |
| 169 | + |
| 170 | + |
| 171 | + |
| 172 | +## Input file changes |
| 173 | + |
| 174 | + |
| 175 | +## Known issues |
| 176 | + |
| 177 | + |
| 178 | + |
| 179 | +# Precompiled Windows Binaries |
| 180 | +The binary files in this release were built with the Visual Studio solution files distributed with OpenFAST (not using cmake), using |
| 181 | + |
| 182 | +- Intel Fortran compiler 2021.12 (`p_oneAPI_2024.1.0.595`) with Microsoft Visual Studio 2022 |
| 183 | +- Microsoft Visual C++ 2022 (C), for build in Matlab |
| 184 | +- MATLAB Version: 2024.2.999 (R2024b) |
| 185 | +- Executables with `_OpenMP` or `_OMP` in the name are built with OpenMP libraries and linked with dynamic libraries. |
| 186 | + - You will need [this Intel Fortran redistributable package](https://registrationcenter-download.intel.com/akdlm/IRC_NAS/f6a44238-5cb6-4787-be83-2ef48bc70cba/w_ifort_runtime_p_2024.1.0.968.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). |
| 187 | + - You may also need [a redistributable library for Visual Studio](https://aka.ms/vs/17/release/vc_redist.x64.exe) installed. See instructions [here](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170). |
| 188 | + |
| 189 | +**The other OpenFAST executables DO NOT require these redistributable libraries to be installed. Instead, they were built with static libraries.** |
0 commit comments