devito
devito copied to clipboard
Devito compiler tutorials
00_index.ipynb
- [x] Broken link to operator class in first para
01_data_regions.ipynb
- [x] Where to find descriptions of operator options like dle='noop'
- [ ] Could the generated code have a comment at the top of the structs to define what the members are (size, npsize, dsize, hsize, hofs, oofs). Yeah, I know it isn't really for human reading ... I suppose I would see those used once dle/mpi does something.
- [ ] Suggest removing the deprecated padding stuff
- [ ] Suggest adding the same disclaimer about dle='noop' as in 02_indexification.ipynb: ... we disable all performance-related optimizations, to maximize the simplicity of the ... generated code.
02_indexification.ipynb
- [ ] What happens when save is an integer less than the total times asked for in a computation?
- [ ] It is unclear what trying to do with cells 9,10. Suggest using "!=" and evaluating to true instead.
04_iet-B.ipynb
- [ ] The use of indexify in cell 2 is a tiny bit confusing, as I was looking carefully at that list. Is this only to generate [] instead of ()? Suggest removing. I suppose that cell is just a demonstration so it doesn't really matter.
- [ ] I would like more clarification for DummyEq: "An IET Expression wraps a SymPy equation. Below, DummyEq is a subclass of sympy.Eq with some metadata attached.", suggest adding "with no iteration or data", and possibly describing a use case for DummyEq. I think when you add/use a class it it worth a description of what/how.
Other
- [ ] In the API docs, could you generate a (re-usable) section on the options available to the staggered keyword, and add to the various Function derived classes
- [ ] Publish the OPT tutorials
TODO:
- [ ] We need a notebook describing "clustering" and in particular how a list of
Eq
s -- the input to anOperator
-- gets lowered into a series of loops, which lies at the heart of the Devito compiler
Intialized this https://github.com/devitocodes/devito/tree/compiler-tutofix1182 for that issue. Feel free to push if anyone has time.
I took the liberty to edit your message @jkwashbourne to add a TODO section at the end