From 8bf949a0ece1a3af56ba64e00cd979010d751854 Mon Sep 17 00:00:00 2001 From: Paul Wessel Date: Sun, 18 Jun 2023 19:44:04 +0200 Subject: [PATCH] More formatting of references --- doc/rst/source/rose.rst | 2 +- doc/rst/source/spectrum1d.rst | 12 ++++++------ doc/rst/source/sph2grd.rst | 3 ++- doc/rst/source/supplements/mgd77/mgd77convert.rst | 2 +- doc/rst/source/supplements/mgd77/mgd77info.rst | 2 +- doc/rst/source/supplements/mgd77/mgd77manage.rst | 2 +- doc/rst/source/supplements/mgd77/mgd77track.rst | 2 +- doc/rst/source/supplements/potential/gmtflexure.rst | 2 +- doc/rst/source/supplements/potential/talwani2d.rst | 2 +- doc/rst/source/supplements/potential/talwani3d.rst | 2 +- doc/rst/source/supplements/spotter/backtracker.rst | 8 ++++---- doc/rst/source/supplements/spotter/grdspotter.rst | 2 +- doc/rst/source/supplements/spotter/hotspotter.rst | 2 +- doc/rst/source/supplements/spotter/originater.rst | 2 +- 14 files changed, 23 insertions(+), 22 deletions(-) diff --git a/doc/rst/source/rose.rst b/doc/rst/source/rose.rst index 1e08b5bfeb6..00a66827878 100644 --- a/doc/rst/source/rose.rst +++ b/doc/rst/source/rose.rst @@ -174,7 +174,7 @@ Optional Arguments **-Q**\ [*alpha*] Sets the confidence level used to determine if the mean resultant is significant (i.e., Lord Rayleigh test for uniformity) [0.05]. - **Note**: The critical values are approximated [Berens, 2009] and + **Note**: The critical values are approximated [*Berens*, 2009] and requires at least 10 points; the critical resultants are accurate to at least 3 significant digits. For smaller data sets you should consult exact statistical tables. diff --git a/doc/rst/source/spectrum1d.rst b/doc/rst/source/spectrum1d.rst index a0342a150d4..464935e4a9d 100644 --- a/doc/rst/source/spectrum1d.rst +++ b/doc/rst/source/spectrum1d.rst @@ -36,8 +36,8 @@ columns on standard input [or *x[y]file*]. These values are treated as timeseries X(t) [Y(t)] sampled at equal intervals spaced *dt* units apart. There may be any number of lines of input. **spectrum1d** will create file[s] containing auto- [and cross- ] spectral density estimates -by Welch's method of ensemble averaging of multiple overlapped windows, -using standard error estimates from Bendat and Piersol. +by *Welch*\ 's [1967] method of ensemble averaging of multiple overlapped windows, +using standard error estimates from *Bendat and Piersol* [1986]. The output files have 3 columns: f or w, p, and e. f or w is the frequency or wavelength, p is the spectral density estimate, and e is @@ -229,7 +229,7 @@ Another is to form a parametric model for the auto-correlation structure in x(t) the spectrum of that model. This last approach is what is done in what is called the "maximum entropy" or "Berg" or "Box-Jenkins" or "ARMA" or "ARIMA" methods. -Welch's method is a tried-and-true method. In his method, you choose a segment length, +*Welch*\ 's method is a tried-and-true method. In his method, you choose a segment length, **-S**\ *N*, so that estimates will be made from segments of length *N*. The frequency samples (in cycles per delta_t unit) of your P_useful will then be at *k* /(*N* \* *delta_t*), where *k* is an integer, and you will get *N* samples (since the spectrum is an even @@ -246,7 +246,7 @@ the spectral bandwidth of each estimate, because the estimate at frequency sampl is now a little correlated with the estimate at frequency sample k+1. (Of course this would also happen if you simply formed P_raw and then smoothed it.) -Finally, Welch's method also uses overlapped processing. Since the Von Hann window is +Finally, *Welch*\ 's method also uses overlapped processing. Since the Von Hann window is large in the middle and tapers to near zero at the ends, only the middle of the segment of length *N* contributes much to its estimate. Therefore in taking the next segment of data, we move ahead in the x(t) sequence only *N*/2 points. In this way, the next @@ -254,9 +254,9 @@ segment gets large weight where the segments on either side of it will get littl and vice versa. This doubles the smoothing effect and ensures that (if *N* << *M*) nearly every point in x(t) contributes with nearly equal weight in the final answer. -Welch's method of spectral estimation has been widely used and widely studied. It is very +*Welch*\ 's method of spectral estimation has been widely used and widely studied. It is very reliable and its statistical properties are well understood. It is highly recommended in -such textbooks as "Random Data: Analysis and Measurement Procedures" by Bendat and Piersol. +such textbooks as "Random Data: Analysis and Measurement Procedures" [*Bendat and Piersol*, 1986]. In all problems of estimating parameters from data, there is a classic trade-off between resolution and variance. If you want to try to squeeze more resolution out of your data diff --git a/doc/rst/source/sph2grd.rst b/doc/rst/source/sph2grd.rst index 459fe6c0190..b055c910fb4 100644 --- a/doc/rst/source/sph2grd.rst +++ b/doc/rst/source/sph2grd.rst @@ -34,7 +34,8 @@ Description ----------- **sph2grd** reads a spherical harmonics coefficient table with records of -L, M, C[L,M], S[L,M] and evaluates the spherical harmonic model on the specified grid. +L, M, C[L,M], S[L,M] and evaluates the spherical harmonic model on the specified grid +[*Holmes and Featherstone*, 2002]. Required Arguments ------------------ diff --git a/doc/rst/source/supplements/mgd77/mgd77convert.rst b/doc/rst/source/supplements/mgd77/mgd77convert.rst index db299955442..430052cc1fb 100644 --- a/doc/rst/source/supplements/mgd77/mgd77convert.rst +++ b/doc/rst/source/supplements/mgd77/mgd77convert.rst @@ -27,7 +27,7 @@ Description **mgd77convert** reads versions of MGD77 files and writes the same data in (probably) another format to a new file in the current directory. -Both pre- and post-Y2K MGD77 formats can be processed. +Both pre- and post-Y2K MGD77 formats can be processed [*Wessel and Chandler*, 2007]. Required Arguments ------------------ diff --git a/doc/rst/source/supplements/mgd77/mgd77info.rst b/doc/rst/source/supplements/mgd77/mgd77info.rst index 53f2acd5b77..840ee4160c8 100644 --- a/doc/rst/source/supplements/mgd77/mgd77info.rst +++ b/doc/rst/source/supplements/mgd77/mgd77info.rst @@ -31,7 +31,7 @@ record of information about each cruise specified. The information includes beginning and end times, total track distances in km, longitude and latitude range, and the total number of geophysical observations. Optionally, choose instead to see the original MGD77 header meta-data -section or its individual members. +section or its individual members [*Wessel and Chandler*, 2007]. If you need to know which tracks are crossing through a given region and what kinds of geophysical observations are available, consider using the diff --git a/doc/rst/source/supplements/mgd77/mgd77manage.rst b/doc/rst/source/supplements/mgd77/mgd77manage.rst index 82fd1c75f13..48cb4ce5126 100644 --- a/doc/rst/source/supplements/mgd77/mgd77manage.rst +++ b/doc/rst/source/supplements/mgd77/mgd77manage.rst @@ -42,7 +42,7 @@ obtained by sampling a grid (choose between GMT grid or a Sandwell/Smith Mercator \*.img grid) along track. The new data will be appended to the MGD77+ file in the form of an extra data column of specified type. The data file will be modified; no new file will be created. For the big -issues, see the DISCUSSION section below. +issues, see the DISCUSSION section below [*Wessel and Chandler*, 2007]. Required Arguments ------------------ diff --git a/doc/rst/source/supplements/mgd77/mgd77track.rst b/doc/rst/source/supplements/mgd77/mgd77track.rst index 9b51b0432e3..e68d976f3e2 100644 --- a/doc/rst/source/supplements/mgd77/mgd77track.rst +++ b/doc/rst/source/supplements/mgd77/mgd77track.rst @@ -41,7 +41,7 @@ Description ----------- **mgd77track** reads NCEI MGD77 cruises and plots one or more ship tracks -on a map using the specified projection. +on a map using the specified projection [*Wessel and Chandler*, 2007]. Required Arguments ------------------ diff --git a/doc/rst/source/supplements/potential/gmtflexure.rst b/doc/rst/source/supplements/potential/gmtflexure.rst index 7aaf221f6ed..e8559ff63fd 100644 --- a/doc/rst/source/supplements/potential/gmtflexure.rst +++ b/doc/rst/source/supplements/potential/gmtflexure.rst @@ -43,7 +43,7 @@ Description of user-selectable options, such as boundary conditions, pre-existing deformations, variable rigidity and restoring force, and more. The solutions are obtained using finite difference approximations to the differential -equations. +equations [*Bodine*,\ 1980]. Required Arguments ------------------ diff --git a/doc/rst/source/supplements/potential/talwani2d.rst b/doc/rst/source/supplements/potential/talwani2d.rst index 80f52921cc7..8e793bc3b00 100644 --- a/doc/rst/source/supplements/potential/talwani2d.rst +++ b/doc/rst/source/supplements/potential/talwani2d.rst @@ -43,7 +43,7 @@ We can compute anomalies on an equidistant lattice (by specifying a lattice with **-T**) or provide arbitrary output points specified in a file via |-N|. Choose between free-air anomalies, vertical gravity gradient anomalies, or geoid anomalies. Options are available to control axes units and direction. - +For theory, see references at the end. Required Arguments ------------------ diff --git a/doc/rst/source/supplements/potential/talwani3d.rst b/doc/rst/source/supplements/potential/talwani3d.rst index 1d43e0e458e..921edef68d9 100644 --- a/doc/rst/source/supplements/potential/talwani3d.rst +++ b/doc/rst/source/supplements/potential/talwani3d.rst @@ -47,7 +47,7 @@ We can compute anomalies on an equidistant grid (by specifying a new grid with **-R** and |-I| or provide an observation grid with desired elevations) or at arbitrary output points specified via |-N|. Choose between free-air anomalies, vertical gravity gradient anomalies, or geoid anomalies. Options are available to control -axes units and direction. +axes units and direction. For theory, see *Kim and Wessel* [2016] and *Talwani and Ewing* [1960]. Required Arguments diff --git a/doc/rst/source/supplements/spotter/backtracker.rst b/doc/rst/source/supplements/spotter/backtracker.rst index 63f54ba3f72..ac40244f13b 100644 --- a/doc/rst/source/supplements/spotter/backtracker.rst +++ b/doc/rst/source/supplements/spotter/backtracker.rst @@ -45,8 +45,8 @@ Description **backtracker** reads (longitude, latitude, age) positions from *infiles* [or standard input] and computes rotated (x,y,t) coordinates using the specified rotation parameters. It can either calculate final -positions [Default] or create a sampled track (flowline or hotspot -track) between the initial and final positions. The former mode allows +positions [Default] or create a sampled track (flowline or hotspot track) +between the initial and final positions [*Wessel*, 1999]. The former mode allows additional data fields after the first 3 columns which must have (longitude,latitude,age). See option **-:** on how to read (latitude,longitude,age) files. @@ -208,14 +208,14 @@ total reconstruction rotations for the plate (PAC_APM.txt), try echo 204 19 80 | gmt backtracker -Df -EPAC_APM.txt -Lb1 > path.txt To predict Hawaiian-Emperor seamount trail using the Pacific absolute plate -and plume motion from Doubrovine et al. (2012), use +and plume motion from *Doubrovine et al.* [2012], use :: echo -155.2872 19.3972 80 | gmt backtracker -Df -Lb1 -ED2012.txt -FD2012_HI_drift.txt > traildrift.txt To predict the Hawaiian-Emperor seamount trail that would have resulted if no plume drift had been in effect, -using the Pacific absolute plate motion model from Doubrovine et al. (2012), use +using the Pacific absolute plate motion model from *Doubrovine et al.* [2012], use :: diff --git a/doc/rst/source/supplements/spotter/grdspotter.rst b/doc/rst/source/supplements/spotter/grdspotter.rst index c37871c8112..001c5b9a07e 100644 --- a/doc/rst/source/supplements/spotter/grdspotter.rst +++ b/doc/rst/source/supplements/spotter/grdspotter.rst @@ -40,7 +40,7 @@ Description calculates flowlines from each node that exceeds a minimum value using the specified rotations file. These flowlines are then convolved with the volume of the prism represented by each grid node and added up to -give a Cumulative Volcano Amplitude grid (CVA). +give a Cumulative Volcano Amplitude grid (CVA) [*Wessel*, 1999; 2008]. Required Arguments ------------------ diff --git a/doc/rst/source/supplements/spotter/hotspotter.rst b/doc/rst/source/supplements/spotter/hotspotter.rst index 4fd20c27f38..9ade518b666 100644 --- a/doc/rst/source/supplements/spotter/hotspotter.rst +++ b/doc/rst/source/supplements/spotter/hotspotter.rst @@ -43,7 +43,7 @@ using the specified stage or total reconstruction rotations. These flowlines are convolved with the shape of the seamount (using a Gaussian shape given amplitude and radius = 6 sigma) and added up to give a Cumulative Volcano Amplitude grid (CVA). See option **-:** on how to -read (latitude,longitude,...) files. +read (latitude,longitude,...) files [*Wessel*, 1999; 2008]. Required Arguments ------------------ diff --git a/doc/rst/source/supplements/spotter/originater.rst b/doc/rst/source/supplements/spotter/originater.rst index b3ea11f254e..3b6eb579ec4 100644 --- a/doc/rst/source/supplements/spotter/originater.rst +++ b/doc/rst/source/supplements/spotter/originater.rst @@ -44,7 +44,7 @@ records from *table* [or standard input] and uses the given Absolute Plate Motion (APM) stage or total reconstruction rotation file and the list of hotspot locations to determine the most likely origin (hotspot) for each seamount. It does so by calculating flowlines back in time and -determining the closest approach to all hotspots. The output consists of +determining the closest approach to all hotspots [*Wessel*, 1999]. The output consists of the input records with four additional fields added for each of the *n_hs* closest hotspots. The four fields are the hotspot id (e.g., HWI), the stage id of the flowline segment that came closest, the