Documentation error in the Turbine Input File Reference, and a request for additional turbine documentation
Background: I am trying to run a simulation with the IEA 15MW floating turbine because I want to look at how the wake is affected by the fact that the tilt varies with wind speed. As such, before starting this endeavor, I had read the floating turbine examples but not the multidimensional Cp/Ct examples on GitHub. In the process of fixing an error in my code (I didn't know that I needed to add multidim_conditions to the flow field in my input file because that is mentioned in the multidimensional examples but not in the floating turbine examples), I encountered the following documentation error:
I found a blurb about the power_thrust_data_file used by the IEA 15MW floating turbine file at the bottom of this page: https://nrel.github.io/floris/input_reference_turbine.html. I noticed that the CSVs in FLORIS’ turbine_library folder did not match the same format as what is described on that webpage: the last two columns are “power” and “thrust_coefficient” instead of “Cp” and “Ct.” I tried fixing one of the CSVs to match the format described on GitHub, but doing so caused an error to appear when I ran fmodel = FlorisModel([input file path]). It turns out that the original format in the CSV files was correct, and the nominally correct format described on GitHub is incorrect/out of date. This documentation should be updated.
Relatedly, I have a documentation request: I would like a page that provides a brief description each of the turbine files in the turbine_library, including where the data in those files comes from and a list of examples in which that turbine file is used. I didn't realize at first that the IEA 15MW floating turbine was used in any examples because it isn't used in the floating turbine examples. Had I known it was used in the Multidim examples, I would have read that section sooner and saved myself a lot of time scouring the documentation. Moreover, if I had known upfront that the multidimensional thrust table for the IEA 15MW floating turbine is fictional, I wouldn't have bothered trying to get it to work at all.
Floris version
Version 4.4.2
System Information
- OS: MacOS 15.5
- Python version: 3.13.4
Documentation error in the Turbine Input File Reference, and a request for additional turbine documentation
Background: I am trying to run a simulation with the IEA 15MW floating turbine because I want to look at how the wake is affected by the fact that the tilt varies with wind speed. As such, before starting this endeavor, I had read the floating turbine examples but not the multidimensional Cp/Ct examples on GitHub. In the process of fixing an error in my code (I didn't know that I needed to add multidim_conditions to the flow field in my input file because that is mentioned in the multidimensional examples but not in the floating turbine examples), I encountered the following documentation error:
I found a blurb about the power_thrust_data_file used by the IEA 15MW floating turbine file at the bottom of this page: https://nrel.github.io/floris/input_reference_turbine.html. I noticed that the CSVs in FLORIS’ turbine_library folder did not match the same format as what is described on that webpage: the last two columns are “power” and “thrust_coefficient” instead of “Cp” and “Ct.” I tried fixing one of the CSVs to match the format described on GitHub, but doing so caused an error to appear when I ran fmodel = FlorisModel([input file path]). It turns out that the original format in the CSV files was correct, and the nominally correct format described on GitHub is incorrect/out of date. This documentation should be updated.
Relatedly, I have a documentation request: I would like a page that provides a brief description each of the turbine files in the turbine_library, including where the data in those files comes from and a list of examples in which that turbine file is used. I didn't realize at first that the IEA 15MW floating turbine was used in any examples because it isn't used in the floating turbine examples. Had I known it was used in the Multidim examples, I would have read that section sooner and saved myself a lot of time scouring the documentation. Moreover, if I had known upfront that the multidimensional thrust table for the IEA 15MW floating turbine is fictional, I wouldn't have bothered trying to get it to work at all.
Floris version
Version 4.4.2
System Information