Browse Source

docs: add todos

whitelist
Sebastian Heimann 3 years ago
parent
commit
fce1d43701
  1. 2
      docs/source/analysers/index.rst
  2. 4
      docs/source/dataset/index.rst
  3. 6
      docs/source/examples/index.rst
  4. 3
      docs/source/install/index.rst
  5. 31
      docs/source/method/index.rst
  6. 5
      docs/source/optimisers/index.rst
  7. 2
      docs/source/overview/index.rst
  8. 3
      docs/source/problems/index.rst
  9. 2
      docs/source/quickstart/index.rst
  10. 3
      docs/source/report/index.rst
  11. 6
      docs/source/targets/index.rst

2
docs/source/analysers/index.rst

@ -1,2 +1,4 @@
Analysers
=========
TODO: add textual description of the analysers available in Grond

4
docs/source/dataset/index.rst

@ -1,2 +1,6 @@
Dataset
=======
TODO: add details about the dataset configuration. How to use name templates.
Start with a config snippet. Add details here keep the overview/dataset section
short. Technical details can be looked up in library reference.

6
docs/source/examples/index.rst

@ -1,2 +1,8 @@
Examples
========
Regional full waveform CMT inversion
------------------------------------
TODO: select example earthquake, describe briefly step-by-step what must be
done, show some example plots

3
docs/source/install/index.rst

@ -15,6 +15,9 @@ Next, install the Grond library and command line program with
sudo python3 setup.py install
Updating
--------
For updating an existing installation of Grond:
.. code-block :: sh

31
docs/source/method/index.rst

@ -1,2 +1,33 @@
Method
======
TODO: this section should be as self-contained as possible, describe the method
in general - give references to other sections how things are implemented in
Grond.
Forward modelling with precalculated Green's functions
------------------------------------------------------
Objective function design
-------------------------
Tapering
........
Filtering
.........
Misfit calculation
..................
Weighting
.........
The bootstrap method
--------------------
Optimisation
------------
The BABO optimiser
..................

5
docs/source/optimisers/index.rst

@ -1,2 +1,7 @@
Optimisers
==========
TODO: add textual description of the optimiser(s) implemented in Grond,
possibly with some examples and some background how these can be tuned.
Technical details can be moved to the library reference, the theoretical
concept should be put to method/optimiser subsection.

2
docs/source/overview/index.rst

@ -138,6 +138,8 @@ velocity model.
Terminology
-----------
TODO: describe entries
* Rundir
* Event
* Misfit

3
docs/source/problems/index.rst

@ -1,2 +1,5 @@
Problems
========
TODO: add textual description of the different problem types and source
parameterisations which are avaibable in Grond.

2
docs/source/quickstart/index.rst

@ -1,2 +1,4 @@
Quickstart
==========
TODO: describe how to run a minimal default synthetic scenario

3
docs/source/report/index.rst

@ -1,2 +1,5 @@
Report
======
TODO: describe how to create and configure Grond's reports. Describe what
output plots are available.

6
docs/source/targets/index.rst

@ -1,2 +1,8 @@
Targets
=======
TODO: describe the different target types available in Grond, and when to use
what. Special things like alignment with picks, cross correlation based fitting
log amp spec fitting, overall amplitude fitting, envelope fitting, etc can be
described here (with examples). Technical details should go to the library
reference.
Loading…
Cancel
Save