Browse Source

docs: continued

Sebastian Heimann 1 year ago
parent
commit
d808d42acf
6 changed files with 170 additions and 63 deletions
  1. 1 1
      AUTHORS.md
  2. 12 0
      CITATION.bib
  3. 17 0
      README-dev.md
  4. 1 1
      docs/source/conf.py
  5. 25 18
      docs/source/index.rst
  6. 114 43
      docs/source/method/index.rst

+ 1 - 1
AUTHORS.md

@@ -5,7 +5,7 @@
 * Daniela Kühn
 * Henriette Sudhaus
 * Andreas Steinberg
-* Hannes Bathke
+* Hannes Vasyura-Bathke
 * Simon Daout
 * Simone Cesca
 * Torsten Dahm

+ 12 - 0
CITATION.bib

@@ -0,0 +1,12 @@
+@software{grond,
+  title = {Grond - {{A}} probabilistic earthquake source inversion framework},
+  year = {2018},
+  rights = {GPLv3},
+  url = {http://pyrocko.org/grond/docs/current/},
+  shorttitle = {Grond},
+  version = {1.0},
+  urldate = {2018-08-27},
+  keywords = {Scientific/Engineering,Scientific/Engineering - Information Analysis,Scientific/Engineering - Physics,Scientific/Engineering - Visualization,Software Development - Libraries - Application Frameworks},
+  author = {Heimann, Sebastian and Isken, Marius and Kühn, Daniela and Sudhaus, Henriette and Steinberg, Andreas and {Vasyura-Bathke}, Hannes and Daout, Simon and Cesca, Simone and Dahm, Torsten},
+  doi = {10.5880/GFZ.2.1.2018.003}
+}

+ 17 - 0
README-dev.md

@@ -86,3 +86,20 @@ in the project root directory. Build with `make html` in `docs`.
 
 * titles: only capitalize first word
 * use British english
+
+## License
+
+GNU General Public License, Version 3, 29 June 2007
+
+Copyright © 2018 Helmholtz Centre Potsdam GFZ German Research Centre for
+Geosciences, Potsdam, Germany and University of Kiel, Kiel, Germany.
+
+Grond is free software: you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version. Grond is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+You should have received a copy of the GNU General Public License along with
+this program. If not, see <http://www.gnu.org/licenses/>.
+

+ 1 - 1
docs/source/conf.py

@@ -37,7 +37,7 @@ import sphinx_sleekcat_theme
 extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.doctest',
               'sphinx.ext.intersphinx',
-              'sphinx.ext.imgconverter',
+#              'sphinx.ext.imgconverter',
               'sphinx.ext.todo',
               'sphinx.ext.mathjax',
               'sphinx.ext.viewcode',

+ 25 - 18
docs/source/index.rst

@@ -4,24 +4,16 @@ Grond
 
 A probabilistic earthquake source inversion framework. Designed and crafted in Mordor.
 
-Introduction
-------------
+Abstract
+--------
+
+Grond is an open source software tool for robust characterization of earthquake sources. Moment tensors and finite fault rupture models can be estimated from seismic, InSAR, and GNSS observations. It serves as a modular framework for the analysis of diverse magmatic, tectonic, and other geophysical processes.
 
-Grond is a software tool and framework for robust characterization of
-earthquake sources from diverse observations. It employs efficient forward
-modelling as well as elaborate inversion strategies and is able to deliver
-meaningful model uncertainties.
+In Grond the optimisation explores the full model space and maps model parameter trade-offs. Meaningful model uncertainties are delivered through a Bayesian bootstrap-based probabilistic joint inversion scheme.
+Various data-fitting and weighting options provide easy customization of the objective function.
 
-The software implements a Bayesian bootstrap-based probabilistic joint
-inversion scheme for heterogeneous data. It explores the full model space and
-helps to map potential model parameter trade-offs. The program is highly
-flexible in how it can be adapted to specific dislocation problems, the design
-of objective functions, and the diversity of measurements.
+Rapid forward modelling is enabled by using pre-computed Green's function databases, handled through the Pyrocko software library. They serve synthetic near-field geodetic displacements (InSAR and GNSS) and synthetic seismic waveforms for arbitrary earthquake source models and geometries.
 
-Pre-computed Green's function databases handled by the Pyrocko software
-library are the backone of the forward modelling. They serve synthetic
-near-field geodetic data (InSAR and GNSS) and synthetic seismic waveforms at
-all distances and receiver depths for arbitrary earthquake source models.
 
 Contents
 --------
@@ -40,10 +32,25 @@ Contents
    library/index
 
 
-Recommended citation
---------------------
+Citation
+--------
+
+The recommended citation for Grond is 
+
+    Heimann, Sebastian; Isken, Marius; Kühn, Daniela; Sudhaus, Henriette;
+    Steinberg, Andreas; Vasyura-Bathke, Hannes; Daout, Simon; Cesca, Simone;
+    Dahm, Torsten (2018): Grond - A probabilistic earthquake source inversion
+    framework. V. 1.0. GFZ Data Services.
+    https://doi.org/10.5880/GFZ.2.1.2018.003
+
+BibTeX citatation file: :download:`CITATION.bib <../../CITATION.bib>`
+
+
+License
+-------
+
+Grond is licensed under the :download:`GPLv3 <../../LICENSE>`.
 
-TODO DOI
 
 Indices and tables
 ------------------

File diff suppressed because it is too large
+ 114 - 43
docs/source/method/index.rst