Random small things

[jkwashbourne]

Unconnected bits that should be cleaned up sometime. Consider these as questions not instructions to the community: "should we do this"

• [ ] add API docs section for Buffer

• [ ] update Contributing.md to include a table with tags and meaning, should include nb

• [ ] seemingly inconsistent capitalization for configuration['language'] = 'openmp' and configuration['log-level'] = 'DEBUG' Also seems inconsistent that DEVITO_LOGGING != configuration['logging']

• [ ] arguments forward and q are picked up from kwargs, should they be in the list of args in the self doc? https://github.com/devitocodes/devito/blob/master/examples/seismic/acoustic/wavesolver.py

• [ ] add configuration information to the FAQ, (note in particular configuration['opt']) Maybe a question like "what configuration options are possible with devito" taking you a table like the FAQ for environment variables, with links to subheadings for the various options.

• [ ] update the API docs

• [ ] API docs for operator.py description for expressions: expr-like or list or expr-like seems redundant

• [ ] add FAQ entry for how to show args to Operator

  op=Operator(...) 
  op.arguments()
  

• [ ] spacing arg not used in initdamp function https://github.com/devitocodes/devito/master/examples/seismic/model.py#L13

• [ ] description in unit test for checkpointing not consistent with test (likely copied from elsewhere). should say something about check consistency between checkpointing on/off. https://github.com/devitocodes/devito/blob/master/tests/test_gradient.py#L15

• [ ] examples/seismic/tutorials/01_modeling.ipynb notebook, cell 7 change Devito as a shortcut for u(t+dt) which is u.forward to Devito has a shortcut for u(t+dt) which is u.forward

• [ ] add section to API docs for laplacian what about div, grad?

• [ ] examples/seismic/tutorials/01_modeling.ipynb notebook, markdown after cell 7 This paragraph needs work. Since this is one of the first nb new folks will look at, we should improve exposition if possible. In bold the part I think needs improvement. With a numerical scheme to solve the homogenous wave equation, we need to add the source to introduce seismic waves and to implement the measurement operator, and interpolation operator

• [ ] Throw error for Operator name with illegal characters, e.g. IsoOperator}

[jkwashbourne]

@FabioLuporini should close this? it is definitely out of date.