Notebooks in the documentation have failing code cells but no error was raised in GH Actions
A couple of Jupyter Notebooks used to create the online documentation have failing code cells:
More problematic is that GitHub Actions did not end with a failure when these breaking changes were introduced, so we were made aware much later.
The follow sequential steps are required to resolve this issue:
How to reproduce
The broken code cells can be seen in the live docs:
Floris version
The documentation builds from the develop branch.
Notebooks in the documentation have failing code cells but no error was raised in GH Actions
A couple of Jupyter Notebooks used to create the online documentation have failing code cells:
Background and Concepts - The Background and Concepts section refers to a variable
grid.xthat was removed in Add coordinates from inertial frame to grid class #578 in favor ofgrid.x_sorted. This notebook should be updated accordingly, and documentation should be included to explain the_sortedvariables, in general (see Repeated calls to calculate wake can result in wrong wake calculations #378).Turbine Library - The Turbine Library page is breaking due to a relative bath being hard-coded in the turbine definition. See Multidimensional Cp and Ct IEA 15MW definition can fail to load #737 for details.
More problematic is that GitHub Actions did not end with a failure when these breaking changes were introduced, so we were made aware much later.
The follow sequential steps are required to resolve this issue:
grid.x_sortedgrid.x,grid.x_sorted,grid.x_sorted_inertial_framefloris/examples/directoryHow to reproduce
The broken code cells can be seen in the live docs:
Floris version
The documentation builds from the
developbranch.