Taking the existing examples, new examples from published papers (see #75) and further ideas for a certain completeness into account, I just tried to plan some examples (list can be extended). Whereas tutorials aim at teaching the reader something (not trying to provide the simplest code), examples should give easy-to-follow instructions how (typical) specific tasks can be solved.
Examples can cover different abstraction levels (see CG paper, Fig. 1):
Application Level (AL): using ready managers (and possibly frameworks): most examples are naturally AL with managers (framework examples are tutorials)
Modelling Level (ML): using ready fops or ready functions (a few)
Equation Level (EL): from the problem (much too less examples)
Mesh
[x] Gmesh
[x] BERT logo
[x] hybrid mesh
DC/IP
[x] VES Manager (AL)
[x] Geoelectrics in 2.5D (EL)
[x] ERT manager using a simple forward model (check lightweight vs. BERT manager!)
actually most modern (Python) ERT modellings could go here as the FOP is in the pyGIMLi core and the modelling examples are more about mesh generation and plotting anyway, but we better spare it for the BERT documentation? Maybe at least some simple 2D cases (tetgen is external).
EM
[ ] FDEM manager (AL): to be redesigned (see #77)
[ ] TDEM manager (AL): currently only circular transmitter and central loop receiver dB/dt
[x] MRS manager (AL): basis for many other examples
[ ] MT manager (AL): not yet there, maybe good for a tutorial "How to code a manager"?
Grav/Mag
[x] Grav Part 1 (ML)
[x] Grav Part 2 (ML)
[ ] Grav manager???
Traveltime and Seismics
[x] Refraction manager (AL)
[x] Fast Marching Method (ML)
[ ] Some seismic modelling (EL): There
Spectroscopy
[x] Spectral Induced polarisation (AL)
[ ] Dielectric Spectroscopy (AL): almost ready
[ ] Combined SIP and Dielectric Spectroscopy (AL): coming after
[ ] NMR Spectroscopy: not quite sure
Joint inversion
[x] 1D DC-EM joint inversion (ML)
[x] 1D DC-EM joint inversion (AL) using the paper framework
[x] 1D Block joint inversion VES+MRS (AL)
[x] Petrophysical Joint inversion (AL): like in the paper
Miscellaneous
[x] Petrophysical inversion (ML) like in the paper appendix
[ ] MRS Inversion for pedophysical parameters (old script->new style)
[ ] Borehole NMR tool (to be recoded)
[x] MRS with Genetic Algorithms (to be extracted from MRS manager in inversion framework)
Most of the tasks are either outdated, the methods inactive or the documented otherwise. The bandwidth is too wide to be handles in one issue so I am closing it.
Taking the existing examples, new examples from published papers (see #75) and further ideas for a certain completeness into account, I just tried to plan some examples (list can be extended). Whereas tutorials aim at teaching the reader something (not trying to provide the simplest code), examples should give easy-to-follow instructions how (typical) specific tasks can be solved.
Examples can cover different abstraction levels (see CG paper, Fig. 1):
Mesh
DC/IP
actually most modern (Python) ERT modellings could go here as the FOP is in the pyGIMLi core and the modelling examples are more about mesh generation and plotting anyway, but we better spare it for the BERT documentation? Maybe at least some simple 2D cases (tetgen is external).
EM
Grav/Mag
Traveltime and Seismics
Spectroscopy
Joint inversion
Miscellaneous