The bandframework repository contains different content, including Jupyter notebooks, that could be presented to the public via a single BAND framework Jupyter book.
In the case of the notebooks, this could be useful because releases presently require reviewers to manually confirm that such notebooks not only run through but generate correct content. If we had a GH action that renders the Jupyter book, then the action would automatically confirm that the notebooks run through. If the notebooks included assert statements, which could be hidden in the Jupyter book rendering, then the action would become a test suite that confirms correct content as well.
This proposal requires quite a bit of thought. For example
- How would the book be structured?
- Would it include both "examples" and "BAND software uses" elements?
- If so, would it include just the notebooks or all such BAND framework elements?
- Would this require substantial maintenance effort with each release that might be impossible without active participation from external contributors?
The
bandframeworkrepository contains different content, including Jupyter notebooks, that could be presented to the public via a single BAND framework Jupyter book.In the case of the notebooks, this could be useful because releases presently require reviewers to manually confirm that such notebooks not only run through but generate correct content. If we had a GH action that renders the Jupyter book, then the action would automatically confirm that the notebooks run through. If the notebooks included assert statements, which could be hidden in the Jupyter book rendering, then the action would become a test suite that confirms correct content as well.
This proposal requires quite a bit of thought. For example