Planned documentation topics¶
This page tracks documentation gaps that are known but not safe to fill from the current code alone.
Custom interactions¶
Placeholder. A complete guide should explain how to write a callable
interaction, how to initialize interaction_params, which dynamic fields must
be refreshed, and how propagation interacts with local and non-local rules.
Boundary conditions¶
Placeholder. A complete table should list periodic, reflecting, absorbing and inflow boundary support by geometry and model family.
Plotting cookbook¶
Placeholder. A complete plotting guide should cover optional dependencies, 1D, 2D and 3D plotting differences, animation functions and property/family plots for identity-based models.
Custom initial conditions¶
Placeholder. A complete guide should describe expected nodes shapes for
classical, identity-based, NoVE and multi-species models in each geometry.