Skip to content

Commit 2155cfe

Browse files
committed
Built site for gh-pages
1 parent 4502957 commit 2155cfe

17 files changed

Lines changed: 7134 additions & 5872 deletions

File tree

.nojekyll

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
68479d7c
1+
62cdaf84

documentation/alphabetical.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -969,6 +969,10 @@ <h2 class="anchored" data-anchor-id="f">F</h2>
969969
<td>GDAL Functions</td>
970970
</tr>
971971
<tr class="odd">
972+
<td><a href="utilities/funcurve.html"><code>funcurve</code></a></td>
973+
<td>Utilities</td>
974+
</tr>
975+
<tr class="even">
972976
<td><a href="utilities/fv2fv.html"><code>fv2fv</code></a></td>
973977
<td>Utilities</td>
974978
</tr>

documentation/modules/basemap.html

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -526,6 +526,8 @@ <h2 class="anchored" data-anchor-id="description">Description</h2>
526526
</ul></li>
527527
<li><p><strong>t</strong> or <strong>transparency</strong> or <strong>alpha</strong>: – <em>alpha=50</em><br>
528528
Set PDF transparency level for an overlay, in (0-100] percent range. [Default is 0, <em>i.e.</em>, opaque]. Works only for the PDF and PNG formats.</p></li>
529+
<li><p><strong>figname</strong> or <strong>savefig</strong> or <strong>name</strong> : – <em>figname=<code>name.png</code></em><br>
530+
Save the figure with the <code>figname=name.ext</code> where <code>ext</code> chooses the figure image format.</p></li>
529531
</ul>
530532
</section>
531533
<section id="examples" class="level2">
@@ -538,15 +540,28 @@ <h2 class="anchored" data-anchor-id="non-geographical-projections">Non-geographi
538540
<section id="linear-x-y-plot" class="level3">
539541
<h3 class="anchored" data-anchor-id="linear-x-y-plot">Linear x-y plot</h3>
540542
<p>To make a linear x/y frame with all axes, but with only left and bottom axes annotated, using xscale = yscale = 1 cm per unit, ticking every 1 unit and annotating every 2, and using xlabel = “Distance” and ylabel = “No of samples”, use</p>
541-
<div id="735f3771" class="cell" data-execution_count="1">
543+
<div id="793e0bdf" class="cell" data-execution_count="1">
542544
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb2"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">GMT</span></span>
543545
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a></span>
544546
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="fu">basemap</span>(region<span class="op">=</span>(<span class="fl">0</span>,<span class="fl">9</span>,<span class="fl">0</span>,<span class="fl">5</span>), figscale<span class="op">=</span><span class="fl">1</span>,</span>
545547
<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a> frame<span class="op">=</span>(axes<span class="op">=:</span>WeSn, annot<span class="op">=</span><span class="fl">2</span>, ticks<span class="op">=</span><span class="fl">1</span>, xlabel<span class="op">=:</span>Distance, ylabel<span class="op">=</span><span class="st">"No of samples"</span>), show<span class="op">=</span><span class="cn">true</span>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
548+
<div class="cell-output cell-output-stderr">
549+
<div class="ansi-escaped-output">
550+
<pre><span class="ansi-green-fg ansi-bold">Precompiling</span> packages...
551+
552+
56654.4 ms<span class="ansi-green-fg"></span>GMT
553+
554+
1 dependency successfully precompiled in 58 seconds. 80 already precompiled.
555+
556+
557+
<span class="ansi-cyan-fg ansi-bold">[ </span><span class="ansi-cyan-fg ansi-bold">Info: </span>Precompiling GMTParkerFFTExt [35a23bc9-6f20-5cbc-8971-9cdf66427582]
558+
</pre>
559+
</div>
560+
</div>
546561
<div class="cell-output cell-output-display">
547562
<div>
548563
<figure class="figure">
549-
<p><img src="basemap_files/figure-html/cell-2-output-1.png" class="img-fluid figure-img"></p>
564+
<p><img src="basemap_files/figure-html/cell-2-output-2.png" class="img-fluid figure-img"></p>
550565
</figure>
551566
</div>
552567
</div>
@@ -555,7 +570,7 @@ <h3 class="anchored" data-anchor-id="linear-x-y-plot">Linear x-y plot</h3>
555570
<section id="log-log-plot" class="level3">
556571
<h3 class="anchored" data-anchor-id="log-log-plot">Log-log plot</h3>
557572
<p>To make a log-log frame with only the left and bottom axes, where the x-axis is 25 cm and annotated every 1-2-5 and the y-axis is 15 cm and annotated every power of 10 but has tick-marks every 0.1, run</p>
558-
<div id="e2ddb4b9" class="cell" data-execution_count="2">
573+
<div id="61a31138" class="cell" data-execution_count="2">
559574
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb3"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">GMT</span></span>
560575
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a></span>
561576
<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a><span class="fu">basemap</span>(region<span class="op">=</span>(<span class="fl">1</span>,<span class="fl">10000</span>,<span class="fl">1e20</span>,<span class="fl">1e25</span>), figsize<span class="op">=</span>(<span class="fl">25</span>,<span class="fl">15</span>), proj<span class="op">=:</span>logxy, frame<span class="op">=</span>(axes<span class="op">=:</span>WS,),</span>
@@ -573,7 +588,7 @@ <h3 class="anchored" data-anchor-id="log-log-plot">Log-log plot</h3>
573588
<section id="power-axes" class="level3">
574589
<h3 class="anchored" data-anchor-id="power-axes">Power axes</h3>
575590
<p>To design an axis system to be used for a depth-sqrt(age) plot with depth positive down, ticked and annotated every 500m, and ages (in millions of years) annotated at 1 My, 4 My, 9 My etc., use</p>
576-
<div id="ffb91125" class="cell" data-execution_count="3">
591+
<div id="862b2a9b" class="cell" data-execution_count="3">
577592
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb4"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">GMT</span></span>
578593
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a> <span class="co"># This still fails to generate the intended GMT command. (maybe let scale="pow0.5")</span></span>
579594
<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a> <span class="co">#basemap(region=(0,100,0,5000), figscale=(1,-0.001), xaxis=(annot=1, label="Crustal age", scale=:pow), yaxis=(annot=500, label=:Depth), show=true)</span></span>
@@ -590,7 +605,7 @@ <h3 class="anchored" data-anchor-id="power-axes">Power axes</h3>
590605
<section id="polar-thetar-plot" class="level3">
591606
<h3 class="anchored" data-anchor-id="polar-thetar-plot">Polar (theta,r) plot</h3>
592607
<p>For a base map for use with polar coordinates, where the radius from 0 to 1000 should correspond to 5 cm and with gridlines and ticks intervals automatically determined, use</p>
593-
<div id="feb075c9" class="cell" data-execution_count="4">
608+
<div id="9338e89c" class="cell" data-execution_count="4">
594609
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb5"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">GMT</span></span>
595610
<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a><span class="fu">basemap</span>(region<span class="op">=</span>(<span class="fl">0</span>,<span class="fl">360</span>,<span class="fl">0</span>,<span class="fl">1000</span>), figsize<span class="op">=</span><span class="fl">10</span>, frame<span class="op">=:</span>afg, proj<span class="op">=:</span>polar, show<span class="op">=</span><span class="cn">true</span>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
596611
<div class="cell-output cell-output-display">
16.5 KB
Loading

documentation/modules/biplot.html

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -504,11 +504,13 @@ <h1 class="title">biplot</h1>
504504
<li><p><code>xlabel</code>: a String with the x-axis label. Default is ““, which prints”PC[PC[1]]“.</p></li>
505505
<li><p><code>ylabel</code>: a String with the y-axis label. Default is ““, which prints”PC[PC[2]]“.</p></li>
506506
<li><p><code>kw...</code>: Any additional keyword argument to be passed to the <code>plot()</code> function.</p></li>
507+
<li><p><strong>figname</strong> or <strong>savefig</strong> or <strong>name</strong> : – <em>figname=<code>name.png</code></em><br>
508+
Save the figure with the <code>figname=name.ext</code> where <code>ext</code> chooses the figure image format.</p></li>
507509
</ul>
508510
<section id="examples" class="level2">
509511
<h2 class="anchored" data-anchor-id="examples">Examples</h2>
510512
<p>See the classic analysis of the <em>Iris</em> dataset.</p>
511-
<div id="7d475505" class="cell" data-execution_count="1">
513+
<div id="f87e09a0" class="cell" data-execution_count="1">
512514
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb2"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">GMT</span></span>
513515
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="fu">biplot</span>(TESTSDIR <span class="op">*</span> <span class="st">"iris.dat"</span>, show<span class="op">=</span><span class="cn">true</span>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
514516
<div class="cell-output cell-output-display">
@@ -520,7 +522,7 @@ <h2 class="anchored" data-anchor-id="examples">Examples</h2>
520522
</div>
521523
</div>
522524
<p>Plot a 6 cm fig with the observarion numbers.</p>
523-
<div id="9f35916b" class="cell" data-execution_count="2">
525+
<div id="e95876e4" class="cell" data-execution_count="2">
524526
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb3"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">GMT</span></span>
525527
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="fu">biplot</span>(TESTSDIR <span class="op">*</span> <span class="st">"iris.dat"</span>, figsize<span class="op">=</span><span class="fl">6</span>, obsnumbers<span class="op">=</span><span class="cn">true</span>, show<span class="op">=</span><span class="cn">true</span>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
526528
<div class="cell-output cell-output-display">
@@ -536,9 +538,9 @@ <h2 class="anchored" data-anchor-id="examples">Examples</h2>
536538
<h2 class="anchored" data-anchor-id="source-code">Source Code</h2>
537539
<p>This function has multiple methods:</p>
538540
<ul>
539-
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/plot.jl#L2145"><code>biplot(cmd0::String; first, PC, xlabel, ylabel, varlabels, cmap, marker, ms, obsnumbers, colorbar, arrow, kw...)</code></a> - plot.jl:2145</li>
540-
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/plot.jl#L2166"><code>biplot(coefs::Matrix{Float64}, scores::Matrix{Float64}, explained::Vector{Float64}, varlabels::Vector{&lt;:String}, obslabels::Vector{&lt;:String}, obsnumb::Bool, xlabel::String, ylabel::String, cmap::String, marker::String, ms::String, colorbar::Bool, arrow_pars::Tuple{Float64, Float64, Float64, String}, first::Bool, d::Dict{Symbol, Any})</code></a> - plot.jl:2166</li>
541-
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/plot.jl#L2150"><code>biplot(D::GMTdataset{T, 2}; first, PC, cmap, xlabel, ylabel, varlabels, marker, ms, obsnumbers, colorbar, arrow, kw...) where T&lt;:Real</code></a> - plot.jl:2150</li>
541+
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/plot.jl#L2148"><code>biplot(cmd0::String; first, PC, xlabel, ylabel, varlabels, cmap, marker, ms, obsnumbers, colorbar, arrow, kw...)</code></a> - plot.jl:2148</li>
542+
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/plot.jl#L2169"><code>biplot(coefs::Matrix{Float64}, scores::Matrix{Float64}, explained::Vector{Float64}, varlabels::Vector{&lt;:String}, obslabels::Vector{&lt;:String}, obsnumb::Bool, xlabel::String, ylabel::String, cmap::String, marker::String, ms::String, colorbar::Bool, arrow_pars::Tuple{Float64, Float64, Float64, String}, first::Bool, d::Dict{Symbol, Any})</code></a> - plot.jl:2169</li>
543+
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/plot.jl#L2153"><code>biplot(D::GMTdataset{T, 2}; first, PC, cmap, xlabel, ylabel, varlabels, marker, ms, obsnumbers, colorbar, arrow, kw...) where T&lt;:Real</code></a> - plot.jl:2153</li>
542544
</ul>
543545

544546

documentation/modules/earthregions.html

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -498,6 +498,8 @@ <h1 class="title">earthregions</h1>
498498
<li><p><code>res</code>: The dataset resolution. Possible resolutions are: “<code>01d", "30m", "20m", "15m", "10m", "06m", "05m", "04m", "03m", "02m", "01m", "30s", "15s", "03s", "01s"</code>. However, they are not all available to all datasets. For example, only <code>"earth_relief", "earth_synbath", "earth_gebco"</code> exist for all those resolutions. In case a <code>dataset</code> is specified but no resolution, we make estimate of that resolution based on map extents and what would be good to create a map with 15 cm width.</p></li>
499499
<li><p><code>registration</code>: The dataset registration. Either <code>grid</code> or <code>pixel</code>. If not provided we choose one.</p></li>
500500
<li><p><code>exact</code>: The region boundaries in the collections were rounded to more friendly numbers (few decimals). This means that they differ slightly from the pure <code>GMT</code> (<a href="../..\documentation/modules/plot.html">plot</a>) numbers. Setting <code>exact=true</code> will force using the strict <code>GMT</code> limits.</p></li>
501+
<li><p><strong>figname</strong> or <strong>savefig</strong> or <strong>name</strong> : – <em>figname=<code>name.png</code></em><br>
502+
Save the figure with the <code>figname=name.ext</code> where <code>ext</code> chooses the figure image format.</p></li>
501503
</ul>
502504
<table class="caption-top table">
503505
<tbody>
@@ -523,7 +525,7 @@ <h1 class="title">earthregions</h1>
523525
header=["W(lon)","E(lon)","S(lat)","N(lat)","Code","Region","Ref"], backend=Val(:html)) # hide
524526
println("~~~" * String(take!(io)) * "~~~") # hide</code></pre>
525527
<p>Consulting the <code>UN</code> collection we would have found that the “Caribbean” region has the code <code>UN029</code>. So, making a map of the Caribe is as simple as:</p>
526-
<div id="c8090775" class="cell" data-execution_count="1">
528+
<div id="7ec460c6" class="cell" data-execution_count="1">
527529
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb3"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">GMT</span></span>
528530
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="fu">earthregions</span>(<span class="st">"UN029"</span>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
529531
<div class="cell-output cell-output-display">
@@ -535,7 +537,7 @@ <h1 class="title">earthregions</h1>
535537
</div>
536538
</div>
537539
<p>But the examples above do not let us plot the country’s borders that help referencing a map. For the time being that is only possible when we use the <code>DCW</code> collection. Next example shows a case with country borders. Also note that for the regions in the <code>DCW</code> (there are 248 of them) we can combine as many countries as we want.</p>
538-
<div id="db450bd7" class="cell" data-execution_count="2">
540+
<div id="54d1327a" class="cell" data-execution_count="2">
539541
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb4"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">GMT</span></span>
540542
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a><span class="fu">earthregions</span>(<span class="st">"PT,ES,FR"</span>, country<span class="op">=</span><span class="cn">true</span>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
541543
<div class="cell-output cell-output-display">
@@ -547,7 +549,7 @@ <h1 class="title">earthregions</h1>
547549
</div>
548550
</div>
549551
<p>Our last example shows how to extract a topo/bathymetric grid of the “Sea of Azov” and letting the <code>earthregions</code> select the grid resolution. We also show how to make a pretty map with very few commands. Note that for this later case we have much more plotting possibilities than with the <code>earthregions</code> function that is only a tool to select named regions and quickly visualize them.</p>
550-
<div id="2c662735" class="cell" data-execution_count="3">
552+
<div id="219ef03e" class="cell" data-execution_count="3">
551553
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb5"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">GMT</span></span>
552554
<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a>G <span class="op">=</span> <span class="fu">earthregions</span>(<span class="st">"IHO31"</span>, grid<span class="op">=</span><span class="cn">true</span>);</span>
553555
<span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a><span class="fu">viz</span>(G, shade<span class="op">=</span><span class="cn">true</span>, coast<span class="op">=</span><span class="cn">true</span>, cmap<span class="op">=:</span>earth)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>

documentation/modules/histogram.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -540,12 +540,14 @@ <h2 class="anchored" data-anchor-id="optional-arguments">Optional Arguments</h2>
540540
<p>To use weights provided as a second data column instead of pure counts, use a tuple. <em>e.g.</em> <strong>kind=(counts=true, weights=true)</strong>. If no <em>weights</em> are used then we may use the simpler form <strong>kind=??</strong> where <em>??</em> is the name of any of the 6 types. <em>e.g.</em> <strong>kind=frequency</strong></p></li>
541541
<li><p><strong>zoom</strong> : – <em>zoom=true</em><br>
542542
When input is a <a href="../..\documentation/general/types.html#sec-image-type">GMTimage</a> of UInt16 type this option will set <strong>auto=true</strong> and show histogram only on the region of interest.</p></li>
543+
<li><p><strong>figname</strong> or <strong>savefig</strong> or <strong>name</strong> : – <em>figname=<code>name.png</code></em><br>
544+
Save the figure with the <code>figname=name.ext</code> where <code>ext</code> chooses the figure image format.</p></li>
543545
</ul>
544546
</section>
545547
<section id="examples" class="level2">
546548
<h2 class="anchored" data-anchor-id="examples">Examples</h2>
547549
<p>To draw a histogram of the data <em>v3206_06.txt</em> containing seafloor depths, using a 250 meter bin width, center bars, and draw bar outline, use:</p>
548-
<div id="d790e810" class="cell" data-execution_count="1">
550+
<div id="c226baf0" class="cell" data-execution_count="1">
549551
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb4"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">GMT</span></span>
550552
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a><span class="fu">histogram</span>(<span class="st">"@v3206_06.txt"</span>, bin<span class="op">=</span><span class="fl">250</span>, center<span class="op">=</span><span class="cn">true</span>, pen<span class="op">=</span><span class="st">"0.5p"</span>, show<span class="op">=</span><span class="cn">true</span>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
551553
<div class="cell-output cell-output-display">

0 commit comments

Comments
 (0)