Add feature-centric demos as Jupyter notebooks
Our demos are mostly on the form "The PDE FOO which models BAR can be implemented as CODE.", which leads to a lack of coverage of the details and corner cases of many features. The unit tests on the other hand can be quite technical and are usually designed to produce easy verifiable output, not to explain features.
I suggest adding a new class of feature-centric examples, showing e.g. "ways of setting boundary conditions", "ways of traversing mesh topology", "ways of working with matrices", "ways of reading/writing things to file", etc. These should be executable and thus automatically testable, possibly in the form of Jupyter notebooks allowing users to fire up the notebook and tweak things.
We are funding someone to do some work on documentation now, so please provide feedback soon if you have any.
Comments (2)
-
-
- removed milestone
Removing milestone: 1.8 (automated comment)
- Log in to comment
Sounds good. I would suggest that we remove some of the present demo as part of this change. There are too many.