v2.0.0 Documentation megathread

[SMijin]

Currently, the rewrite on dev-v2.0.0 is poorly documented. The following still remains to be done:

• variable_container: some functions, though majority well documented
• derivations: all
• model_construction: all
• stencils: all
• integrators: all
• io_support: all
• crm_support: all
• remkit_context: all
• README
• sphinx documentation: cleanup
• sphinx documentation: basic tutorials
• sphinx documentation: advanced tutorials

[SMijin]

Most non-trivial variable functions now documented

[SMijin]

Derivation constructors now documented.

[SMijin]

Model construction documentation now added for most non-trivial functions and constructor. Also started adding class docstrings

[SMijin]

Stencils basically fully documented now, mostly reused old documentation with a few updates.

[SMijin]

Integrator documentation completed for most non-trivial functions and constructors

[sleigh2022]

Possible bug: Evolved energy variable in Term Generators is missing $$ (dollar signs) around the variable when a latexRemap is passed, see crm_support.py line 1215.

This is not seen for evolved densities which is rendering correctly.

[SMijin]

Added the $ escape characters to the line in question, should now render correctly.

[SMijin]

IO_support now fully documented

[SMijin]

Majority of crm_support now documented

[SMijin]

Non-trivial remkit_context functions and classes documented now

[SMijin]

First pass of v2.0.0 README complete

[SMijin]

Started on Sphinx docs, they now compile, so the CI passes. Working on the basic tutorials now, meant to cover the full basic workflow + some bits. These are in addition to the runnable examples.

[SMijin]

Updated Sphinx docs, first two tutorials complete.

[SMijin]

7 basic tutorials now complete.

[sleigh2022]

Docstring for common_models.logicalBCModel - and by extension model_construction LBCModelboundData - should state that ionCurrent must be both Scalar and Derived, since this is a requirement of the LBCModelboundData.getitem method

[SMijin]

Pushed commit that makes all scalar variables automatically derived.