Documentation for DOLFIN demos
The infrastructure for documenting DOLFIN demos is in place. Now we just need to start writing documentation for all demos in dolfin/
The complete list of undocumented demos is on the Whiteboard, it would be nice if everybody would sign up for a couple of demos each. Remember, a demo is not complete until it exists in both a C++ and Python version.
We currently have the categories 'la' and 'pde' but since all demos does not fall under these two categories we will have to add more.
Blueprint information
- Status:
- Started
- Approver:
- None
- Priority:
- Low
- Drafter:
- Anders Logg
- Direction:
- Needs approval
- Assignee:
- Kristian B. Ølgaard
- Definition:
- Discussion
- Series goal:
- None
- Implementation:
-
Good progress
- Milestone target:
- None
- Started by
- Kristian B. Ølgaard
- Completed by
Related branches
Related bugs
Sprints
Whiteboard
MER:
I think documenting all is ambitious, unless we have a common doc-sprint.
KBO:
The following demos lack documentation:
adaptive-pde
adaptive-poisson
advection-diffusion
ale
aliev-panfilov
assembly
bcs
block-matrix
built-in
collection
complex
conditional
courtemanche
curl-curl
dg-advection-
dg-poisson
dielectric
distancequeries
elasticity
elastodynamics
entityintersection
equality
eval
extrapolation
functional
harmonic
interpolation
lift-drag
lorenz
meshfunction
meshintersection
method-weights
neumann-poisson
nonlinear-poisson
nonmatching-
nonmatching-
optimization
parameters
partitioning
periodic
plot
poisson1D
projection-
quadrature
reaction
reaction-diffusion
refinement
restriction
simple
smoothing
spatial-coordinates
stiff
stokes-iterative
stokes-mini
stokes-stabilized
stokes-taylor-hood
subdomains
submesh
sym-dirichlet-bc
tensor-
time-series
trilinos
waveguide