READMEs for examples

[ZedThree]

Every example should have a README.md that explains:

1. What it does
2. How it works
3. Expected output

• [X] 2Dturbulence_multigrid

• [X] 6field-simple

• [X] advdiff

• [X] advdiff2

• [X] backtrace

• [X] blob2d

• [X] blob2d-laplacexz

• [X] boundary-conditions/advection

• [X] bout_runners_example

• [X] conducting-wall-mode

• [X] conduction-snb

• [X] conduction

• [X] constraints

• [X] dalf3

• [X] eigen-box

• [X] elm-pb

• [ ] em-drift

• [X] gas-compress

• [X] gravity_reduced

• [X] gyro-gem

• [X] hasegawa-wakatani

• [X] IMEX

• [X] IMEX/advection-diffusion

• [X] IMEX/advection-reaction

• [X] IMEX/diffusion-nl

• [X] IMEX/drift-wave

• [X] IMEX/drift-wave-constraint

• [X] jorek-compare

• [X] lapd-drift

• [X] laplacexy

• [ ] make-script

• [X] monitor

• [X] monitor-newapi

• [X] orszag-tang

• [X] performance

• [X] preconditioning

• [X] reconnect-2field

• [ ] shear-alfven-wave

• [X] staggered_grid

• [X] subsampling

• [X] tokamak-2fluid

• [ ] tokamak-grids

• [X] uedge-benchmark

• [X] wave-slab

• [X] zoidberg

• [ ] test-ballooning

• [X] test-code-style

• [X] test-cyclic

• [X] test-datadir

• [ ] test-dataformat

• [ ] test-dataiterator

• [X] test-delp2

• [ ] test-drift-instability

• [ ] test-fci-slab

• [X] test-fieldfactory

• [ ] test-fieldfactory2

• [X] test-fieldgroup

• [X] test-fieldgroupComm

• [ ] test-globalfield

• [X] test-griddata

• [X] test-gyro

• [X] test-initial

• [ ] test-integrate

• [ ] test-interchange-instability

• [ ] test-interpolate

• [ ] test-invpar

• [X] test-io

• [X] test-io_hdf5

• [X] test-laplace

• [ ] test-laplace2

• [ ] test-laplace3d

• [ ] test-laplacexz

• [ ] test-nonuniform

• [ ] test-petsc_laplace

• [ ] test-petsc_laplace_MAST-grid

• [X] test-restarting

• [ ] test-simple-diffusion

• [X] test-smooth

• [X] test-stopCheck

• [X] test-subdir

• [ ] test-vec

• [ ] test-visitor

• [ ] test-yupdown

• [X] MMS

• [ ] MMS/advection

• [ ] MMS/diffusion

• [ ] MMS/diffusion2

• [ ] MMS/elm-pb

• [ ] MMS/fieldalign

• [X] MMS/GBS

• [ ] MMS/hw

• [ ] MMS/laplace

• [ ] MMS/spatial

• [ ] MMS/time

• [ ] MMS/tokamak

• [ ] MMS/wave-1d

• [ ] MMS/wave-1d-y

[ZedThree]

An example of a good README.md is IMEX/drift-wave-constraint/README.md

It describes what it does, what equations it solves, what the expected output should look like, as well as some additional information for modifying the input parameters.

[loeiten]

Would it be an idea to put a README.md in the examples folder as well, briefly describing each example?

[d7919]

That sounds like it could be a good idea; maybe each readme should have a one line summary, which is included in the examples/README.md?

[ZedThree]

There actually is already one there, it's just a bit out of date.

[dschwoerer]

It would be nice if the one in examples is auto generated.

[d7919]

Update for v4.1?