We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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.x that was removed in Add coordinates from inertial frame to grid class #578 in favor of grid.x_sorted. This notebook should be updated accordingly, and documentation should be included to explain the _sorted variables, in general (see Repeated calls to calculate wake can result in wrong wake calculations #378).
grid.x
grid.x_sorted
_sorted
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_sorted_inertial_frame
floris/examples/
The broken code cells can be seen in the live docs:
The documentation builds from the develop branch.
develop
The text was updated successfully, but these errors were encountered:
@rafmudaf, this configuration may help, but I'm not entirely sure how it translates to the jupyter-book build process. Specifically, nb_execution_raise_on_error=True in conf.py doesn't have a translation in https://jupyterbook.org/en/stable/customize/config.html under the execute configurations. https://myst-nb.readthedocs.io/en/latest/computation/execute.html#error-reporting-warning-vs-failure
nb_execution_raise_on_error=True
conf.py
execute
Sorry, something went wrong.
rafmudaf
No branches or pull requests
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.x
that 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_sorted
variables, 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_sorted
grid.x
,grid.x_sorted
,grid.x_sorted_inertial_frame
floris/examples/
directoryHow to reproduce
The broken code cells can be seen in the live docs:
Floris version
The documentation builds from the
develop
branch.The text was updated successfully, but these errors were encountered: