-
Notifications
You must be signed in to change notification settings - Fork 365
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Modernize the online help
- Loading branch information
Showing
4 changed files
with
288 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
.. index:: ! shake | ||
.. include:: ../module_supplements_purpose.rst_ | ||
|
||
***** | ||
shake | ||
***** | ||
|
||
|shake_purpose| | ||
|
||
Synopsis | ||
-------- | ||
|
||
.. include:: ../../common_SYN_OPTs.rst_ | ||
|
||
**gmt shake** *ingrid* |-G|\ *outgrid* | ||
|-L|\ [**-L**\ *fault.dat*] | ||
|-M|\ [**-M**\ *mag*] | ||
[ **-C**\ *a,v,i* ] | ||
[ |-F|\ [**-F**\ *mecatype*] ] | ||
[ |SYN_OPT-R| ] | ||
[ |SYN_OPT-V| ] | ||
[ |SYN_OPT-i| ] | ||
[ |SYN_OPT-:| ] | ||
|
||
|No-spaces| | ||
|
||
Description | ||
----------- | ||
|
||
Takes Vs30 velocity grid and compute the Peak Ground Acceleration/Velocity and Intensity | ||
|
||
|
||
Required Arguments | ||
------------------ | ||
|
||
*ingrid* | ||
This is the input grid file. | ||
|
||
.. _-G: | ||
|
||
**-G**\ *outgrid* | ||
This is the output grid file. If more than one component is set via -C then <outgrid> must contain %%s to format component code. | ||
|
||
.. _-L: | ||
|
||
**-L**\ *fault.dat* | ||
Name of a file with the coordinates of the fault trace. | ||
|
||
.. _-M: | ||
|
||
**-M**\ *mag* | ||
Select the magnitude of the event. | ||
|
||
|
||
Optional Arguments | ||
------------------ | ||
|
||
.. _-C: | ||
|
||
**-C**\ *a,v,i* | ||
List of comma-separated components to be written as grids (requires -G). Choose from, *a*\ (cceleration), | ||
*v*\ (elocity), *i*\ (ntensity) [Default is *i*]. | ||
|
||
.. _-F: | ||
|
||
**-F**\ *1*\|\ *2*\|\ *3*\|\ *4* | ||
Select the focal mechanism type (e.g. -F1 or -F2 ...) | ||
- 1 unknown [Default]. | ||
- 2 strike-slip. | ||
- 3 normal. | ||
- 4 thrust. | ||
|
||
.. _-R: | ||
|
||
.. |Add_-R| replace:: This defines the subregion to be operated out. | ||
.. include:: ../../explain_-R.rst_ | ||
|
||
.. _-V: | ||
|
||
.. |Add_-V| unicode:: 0x20 .. just an invisible code | ||
.. include:: ../../explain_-V.rst_ | ||
|
||
.. include:: ../../explain_-icols.rst_ | ||
|
||
.. include:: ../../explain_colon.rst_ | ||
|
||
.. include:: ../../explain_help.rst_ | ||
|
||
|
||
Examples | ||
-------- | ||
|
||
To compute the intensity grid using the previously computed Vs30 velocities (*vs30.grd*) of an | ||
event with magnitude 7 occurred along a fault whose trace is coordinates are provide in the | ||
*line.dat* file, do:: | ||
|
||
gmt vs30.grd -Gshake_intensity.grd -Lline.dat -Ci -M7 -V | ||
|
||
|
||
See Also | ||
-------- | ||
|
||
:doc:`vs30`, | ||
:doc:`gmt </gmt>` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
.. index:: ! vs30 | ||
.. include:: ../module_supplements_purpose.rst_ | ||
|
||
***** | ||
vs30 | ||
***** | ||
|
||
|vs30_purpose| | ||
|
||
Synopsis | ||
-------- | ||
|
||
.. include:: ../../common_SYN_OPTs.rst_ | ||
|
||
**gmt vs30** *ingrid* |-G|\ *outgrid* | ||
|-C|\ [**-C**\ *val*\|\ *fname*[**+g**]] | ||
[ |SYN_OPT-R| ] | ||
[ |SYN_OPT-V| ] | ||
[ |-W|\ [**-W**\ *water_vel*] ] | ||
[ |SYN_OPT-i| ] | ||
[ |SYN_OPT-r| ] | ||
[ |SYN_OPT-:| ] | ||
|
||
|No-spaces| | ||
|
||
Description | ||
----------- | ||
|
||
Takes one topographic grid in geographical coordinates and a constant craton value or a craton file | ||
which are taken as weights ranging from 1 (one) on stable shields (craton) and 0 in active tectonic regions | ||
-- values in between will be computed as the weighted average of the craton and tectonic models. | ||
|
||
An optional argument *water_vel* is the value that water-covered areas will be set to; the default is 600. | ||
|
||
|
||
Required Arguments | ||
------------------ | ||
|
||
*ingrid* | ||
This is the input grid file. | ||
|
||
.. _-C: | ||
|
||
**-C**\ *val*\|\ *fname*[**+g**] | ||
Argument *val* can be one of these three: | ||
- A value *val* between 0 and 1, where 0 means a stable Craton and 1 an Active region. | ||
- The name of a multi-segment file with the *cratons* polygons. In this case the polygons will be | ||
feed to grdmask to compute a cratons/active tectonic mask. Use **-C**\ *@cratons.xy* to download | ||
a cratons file from the GMT server. | ||
- The name of a grid with the cratons/active tectonic regions. In this case the **+g** suffix | ||
is mandatory to indicate that we are reading a grid. | ||
|
||
.. _-G: | ||
|
||
**-G**\ *outgrid* | ||
This is the output grid file. | ||
|
||
|
||
Optional Arguments | ||
------------------ | ||
|
||
.. _-R: | ||
|
||
.. |Add_-R| replace:: This defines the subregion to be operated out. | ||
.. include:: ../../explain_-R.rst_ | ||
|
||
.. _-W: | ||
|
||
**-W**\ *water_vel* | ||
*water_vel* sets the Vs30 value used in areas designated as water in the landmask [default=600] | ||
|
||
.. _-V: | ||
|
||
.. |Add_-V| unicode:: 0x20 .. just an invisible code | ||
.. include:: ../../explain_-V.rst_ | ||
|
||
.. include:: ../../explain_-icols.rst_ | ||
|
||
.. include:: ../../explain_-r.rst_ | ||
|
||
.. include:: ../../explain_colon.rst_ | ||
|
||
.. include:: ../../explain_help.rst_ | ||
|
||
|
||
Examples | ||
-------- | ||
|
||
To compute a Vs30 estimate of the *topo.grd* grid and a craton value of 0, do:: | ||
|
||
gmt vs30 topo.grd -C0 -Gvs30.grd -V | ||
|
||
|
||
Reference | ||
--------- | ||
|
||
- https://github.com/usgs/earthquake-global_vs30/blob/master/src/grad2vs30.c | ||
|
||
See Also | ||
-------- | ||
|
||
:doc:`shake`, | ||
:doc:`gmt </gmt>` |
Oops, something went wrong.