Browse Source

docs: fixing init references // renaming example

priors
miili 2 years ago
parent
commit
512ada4fb1
9 changed files with 6 additions and 6 deletions
  1. +1
    -1
      docs/source/examples/satellite_insar/index.rst
  2. +1
    -1
      docs/source/examples/waveform_regional/index.rst
  3. +1
    -1
      docs/source/examples/waveform_wphase/index.rst
  4. +3
    -3
      docs/source/overview/index.rst
  5. +0
    -0
      src/data/examples/example_regional_cmt/README.md
  6. +0
    -0
      src/data/examples/example_regional_cmt/bin/download_gf_stores.sh
  7. +0
    -0
      src/data/examples/example_regional_cmt/bin/grondown
  8. +0
    -0
      src/data/examples/example_regional_cmt/bin/grondown_regional.sh
  9. +0
    -0
      src/data/examples/example_regional_cmt/config/regional_cmt.gronf

+ 1
- 1
docs/source/examples/satellite_insar/index.rst View File

@ -126,7 +126,7 @@ The project folder already contains a configuration file for rectangular source
It's a `YAML`_ file: This file format has been chosen for the Grond configuration because it can represent arbitrarily nested data structures built from mappings, lists, and scalar values. It also provides an excellent balance between human and machine readability. When working with YAML files, it is good to know that the **indentation is part of the syntax** and that comments can be introduced with the ``#`` symbol. The type markers, like ``!grond.RectangularProblemConfig``, select the Grond object type of the following mapping and it's documentation can likely be found in the :doc:`/library/index`.
.. literalinclude :: ../../../../examples/grond-playground-insar/config/insar_rectangular.gronf
.. literalinclude :: ../../../../examples/example_insar/config/insar_rectangular.gronf
:language: yaml
:caption: config/insar_rectangular.gronf (in project folder)


+ 1
- 1
docs/source/examples/waveform_regional/index.rst View File

@ -122,7 +122,7 @@ optimisation with Grond, so let's have a look at it. It is a `YAML`_ file. If
you have never heard about this file format, read section
:doc:`/config/structure` for an overview.
.. literalinclude :: ../../../../examples/grond-playground-regional/config/regional_cmt.gronf
.. literalinclude :: ../../../../examples/example_regional_cmt/config/regional_cmt.gronf
:language: yaml
:caption: config/regional_cmt.gronf (in project folder)


+ 1
- 1
docs/source/examples/waveform_wphase/index.rst View File

@ -125,7 +125,7 @@ optimisation with Grond, so let's have a look at it. It is a `YAML`_ file. If
you have never heard about this file format, read section
:doc:`/config/structure` for an overview.
.. literalinclude :: ../../../../examples/grond-playground-wphase/config/wphase_cmt.gronf
.. literalinclude :: ../../../../examples/example_wphase/config/wphase_cmt.gronf
:language: yaml
:caption: config/wphase_cmt.gronf (in project folder)


+ 3
- 3
docs/source/overview/index.rst View File

@ -213,9 +213,9 @@ Grond is configured in in ``.gronf`` files using YAML markup language, see secti
The :doc:`/examples/index` section provides commented configuration files for different earthquake source problems explaining many of the options:
* Regional point-source optimizations based on waveforms: :download:`regional_cmt.gronf <../../../examples/grond-playground-regional/config/regional_cmt.gronf>`
* Teleseismic point-source optimizations based on W phase waveforms: :download:`wphase_cmt.gronf <../../../examples/grond-playground-wphase/config/wphase_cmt.gronf>`
* Finite source optimizations based on unwrapped InSAR observations: :download:`insar_rectangular.gronf <../../../examples/grond-playground-insar/config/insar_rectangular.gronf>`
* Regional point-source optimizations based on waveforms: :download:`regional_cmt.gronf <../../../examples/example_regional_cmt/config/regional_cmt.gronf>`
* Teleseismic point-source optimizations based on W phase waveforms: :download:`wphase_cmt.gronf <../../../examples/example_wphase/config/wphase_cmt.gronf>`
* Finite source optimizations based on unwrapped InSAR observations: :download:`insar_rectangular.gronf <../../../examples/example_insar/config/insar_rectangular.gronf>`
See the :doc:`/examples/index` for a detailed walk-through.


src/data/examples/example_regional-cmt/README.md → src/data/examples/example_regional_cmt/README.md View File


src/data/examples/example_regional-cmt/bin/download_gf_stores.sh → src/data/examples/example_regional_cmt/bin/download_gf_stores.sh View File


src/data/examples/example_regional-cmt/bin/grondown → src/data/examples/example_regional_cmt/bin/grondown View File


src/data/examples/example_regional-cmt/bin/grondown_regional.sh → src/data/examples/example_regional_cmt/bin/grondown_regional.sh View File


src/data/examples/example_regional-cmt/config/regional_cmt.gronf → src/data/examples/example_regional_cmt/config/regional_cmt.gronf View File


Loading…
Cancel
Save