Skip to content

Commit a9776d2

Browse files
committed
Built site for gh-pages
1 parent ff400c8 commit a9776d2

29 files changed

Lines changed: 110 additions & 125 deletions

.nojekyll

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1fd4fc60
1+
2c7344ce

documentation/modules/makecpt.html

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -438,6 +438,10 @@ <h2 id="toc-title">On this page</h2>
438438
<li><a href="#color-hinges" id="toc-color-hinges" class="nav-link" data-scroll-target="#color-hinges">Color Hinges</a></li>
439439
<li><a href="#discrete-versus-continuous-cpt" id="toc-discrete-versus-continuous-cpt" class="nav-link" data-scroll-target="#discrete-versus-continuous-cpt">Discrete versus Continuous CPT</a></li>
440440
<li><a href="#examples" id="toc-examples" class="nav-link" data-scroll-target="#examples">Examples</a></li>
441+
<li><a href="#bugs" id="toc-bugs" class="nav-link" data-scroll-target="#bugs">Bugs</a></li>
442+
<li><a href="#source-code" id="toc-source-code" class="nav-link" data-scroll-target="#source-code">Source Code</a></li>
443+
<li><a href="#references" id="toc-references" class="nav-link" data-scroll-target="#references">References</a></li>
444+
<li><a href="#see-also" id="toc-see-also" class="nav-link" data-scroll-target="#see-also">See Also</a></li>
441445
</ul>
442446
</nav>
443447
</div>
@@ -533,7 +537,7 @@ <h2 class="anchored" data-anchor-id="discrete-versus-continuous-cpt">Discrete ve
533537
<section id="examples" class="level2">
534538
<h2 class="anchored" data-anchor-id="examples">Examples</h2>
535539
<p>To make a CPT with z-values from -200 to 200, with discrete color changes every 25, and using a polar blue-white-red colortable:</p>
536-
<div id="ea94898c" class="cell" data-execution_count="1">
540+
<div id="e866660d" class="cell" data-execution_count="1">
537541
<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>
538542
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a></span>
539543
<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a>C <span class="op">=</span> <span class="fu">makecpt</span>(cmap<span class="op">=:</span>polar, range<span class="op">=</span>(<span class="op">-</span><span class="fl">200</span>,<span class="fl">200</span>,<span class="fl">25</span>))</span>
@@ -551,7 +555,7 @@ <h2 class="anchored" data-anchor-id="examples">Examples</h2>
551555
<p>To use the GEBCO look-alike CPT with its default range for bathymetry and save the file on disk, run</p>
552556
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb6"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a> <span class="fu">makecpt</span>(cmap<span class="op">=:</span>gebco, write<span class="op">=</span><span class="st">"my_gebco.cpt"</span>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
553557
<p>or simply use <code>gebco</code> directly in the application that needs the color table. To create a 24-level color table suitable for plotting the depths in the remote data table v3206_06.txt (with lon, lat, depths), run</p>
554-
<div id="b577ef44" class="cell" data-execution_count="2">
558+
<div id="4ec9106e" class="cell" data-execution_count="2">
555559
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb7"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a>C <span class="op">=</span> <span class="fu">makecpt</span>(<span class="st">"@v3206_06.txt"</span>, cmap<span class="op">=:</span>gebco, nlevels<span class="op">=</span><span class="fl">24</span>)</span>
556560
<span id="cb7-2"><a href="#cb7-2" aria-hidden="true" tabindex="-1"></a><span class="fu">imshow</span>(C, horizontal<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>
557561
<div class="cell-output cell-output-display">
@@ -563,7 +567,7 @@ <h2 class="anchored" data-anchor-id="examples">Examples</h2>
563567
</div>
564568
</div>
565569
<p>To use the <code>gebco</code> color table but reverse the z-values so it can be used for positive depth values, try</p>
566-
<div id="5e99c3e3" class="cell" data-execution_count="3">
570+
<div id="2ca12231" class="cell" data-execution_count="3">
567571
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb8"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="fu">viz</span>(<span class="fu">makecpt</span>(cmap<span class="op">=:</span>gebco, reverse<span class="op">=:</span>z), horizontal<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>
568572
<div class="cell-output cell-output-display">
569573
<div>
@@ -574,7 +578,7 @@ <h2 class="anchored" data-anchor-id="examples">Examples</h2>
574578
</div>
575579
</div>
576580
<p>To make a custom discrete color table for depth of seismicity, using red color for hypocenters between 0 and 100 km, green for 100-300 km, and blue for deep (300-1000 km) earthquakes, use</p>
577-
<div id="b7084a9a" class="cell" data-execution_count="4">
581+
<div id="b9e35857" class="cell" data-execution_count="4">
578582
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb9"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a><span class="fu">imshow</span>(<span class="fu">makecpt</span>(cmap<span class="op">=</span>(<span class="op">:</span>red,<span class="op">:</span>green,<span class="op">:</span>blue), range<span class="op">=</span>[<span class="fl">0</span>,<span class="fl">100</span>,<span class="fl">300</span>,<span class="fl">1000</span>], no_bg<span class="op">=</span><span class="cn">true</span>), horizontal<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>
579583
<div class="cell-output cell-output-display">
580584
<div>
@@ -585,7 +589,7 @@ <h2 class="anchored" data-anchor-id="examples">Examples</h2>
585589
</div>
586590
</div>
587591
<p>To make a discrete CPT from white to blue as z goes from 3 to 10, try</p>
588-
<div id="993d89a3" class="cell" data-execution_count="5">
592+
<div id="e7e3ebe7" class="cell" data-execution_count="5">
589593
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb10"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a><span class="fu">imshow</span>(<span class="fu">makecpt</span>(cmap<span class="op">=</span><span class="st">"white,blue"</span>, range<span class="op">=</span>(<span class="fl">3</span>,<span class="fl">10</span>)), horizontal<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>
590594
<div class="cell-output cell-output-display">
591595
<div>
@@ -596,7 +600,7 @@ <h2 class="anchored" data-anchor-id="examples">Examples</h2>
596600
</div>
597601
</div>
598602
<p>And to get a continuous CPT, use the option <code>continuous=true</code>.</p>
599-
<div id="d590f291" class="cell" data-execution_count="6">
603+
<div id="15789a58" class="cell" data-execution_count="6">
600604
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb11"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a><span class="fu">imshow</span>(<span class="fu">makecpt</span>(cmap<span class="op">=</span><span class="st">"white,blue"</span>, range<span class="op">=</span>(<span class="fl">3</span>,<span class="fl">10</span>), continuous<span class="op">=</span><span class="cn">true</span>), horizontal<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>
601605
<div class="cell-output cell-output-display">
602606
<div>
@@ -607,7 +611,7 @@ <h2 class="anchored" data-anchor-id="examples">Examples</h2>
607611
</div>
608612
</div>
609613
<p>To make a wrapped (cyclic) CPT from the turbo table over the interval 0 to 500, i.e., the color will be wrapped every 500 z-units so that we always get a color regardless of the <em>z</em> value, try</p>
610-
<div id="c98e2bae" class="cell" data-execution_count="7">
614+
<div id="5da26fb7" class="cell" data-execution_count="7">
611615
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb12"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a><span class="fu">imshow</span>(<span class="fu">makecpt</span>(cmap<span class="op">=:</span>turbo, range<span class="op">=</span>(<span class="fl">0</span>,<span class="fl">500</span>), wrap<span class="op">=:</span>w), horizontal<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>
612616
<div class="cell-output cell-output-display">
613617
<div>
@@ -618,7 +622,7 @@ <h2 class="anchored" data-anchor-id="examples">Examples</h2>
618622
</div>
619623
</div>
620624
<p>To show the <code>turbo</code> color table.</p>
621-
<div id="fed8dd36" class="cell" data-execution_count="8">
625+
<div id="a461ac89" class="cell" data-execution_count="8">
622626
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb13"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb13-1"><a href="#cb13-1" aria-hidden="true" tabindex="-1"></a><span class="fu">imshow</span>(<span class="op">:</span>turbo, horizontal<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>
623627
<div class="cell-output cell-output-display">
624628
<div>
@@ -629,7 +633,7 @@ <h2 class="anchored" data-anchor-id="examples">Examples</h2>
629633
</div>
630634
</div>
631635
<p>To make a categorical CPT with string keys instead of numerical lookup values, try:</p>
632-
<div id="28559a2d" class="cell" data-execution_count="9">
636+
<div id="5d63e80f" class="cell" data-execution_count="9">
633637
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb14"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb14-1"><a href="#cb14-1" aria-hidden="true" tabindex="-1"></a>C <span class="op">=</span> <span class="fu">makecpt</span>(cmap<span class="op">=:</span>categorical, range<span class="op">=</span><span class="st">"wood,water,gold"</span>)</span>
634638
<span id="cb14-2"><a href="#cb14-2" aria-hidden="true" tabindex="-1"></a><span class="fu">imshow</span>(C, B<span class="op">=:</span>none, horizontal<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>
635639
<div class="cell-output cell-output-display">
@@ -641,13 +645,16 @@ <h2 class="anchored" data-anchor-id="examples">Examples</h2>
641645
</div>
642646
</div>
643647
<section id="see-more-uses-of-cmaps" class="level3">
644-
<h3 class="anchored">See more uses of cmaps</h3>
648+
<h3 class="anchored" data-anchor-id="see-more-uses-of-cmaps">See more uses of cmaps</h3>
645649
<div class="grid">
646650
<div class="g-col-6 g-col-lg-2">
647651
<div class="card h-100">
648652
<p><a href="../../examples/CPTs/01_cpt_hinge.html" class="card-title stretched-link"><strong>Color maps</strong></a> <a href="../../examples/CPTs/01_cpt_hinge.html"><img src="../..\examples/GMT_CPTscale.png" class="card-img-top img-fluid"></a></p>
649653
</div>
650654
</div>
655+
</div>
656+
</section>
657+
</section>
651658
<section id="bugs" class="level2">
652659
<h2 class="anchored" data-anchor-id="bugs">Bugs</h2>
653660
<p>Since <strong>makecpt</strong> will also interpolate from any existing CPT you may have in your directory, you should not use one of the listed cpt names as an output filename; hence the my_gebco.cpt in the example. If you do create a CPT of such a name, e.g., rainbow.cpt, then <strong>makecpt</strong> will read that file first and not look for the master CPT in the shared GMT directory.</p>
@@ -678,9 +685,6 @@ <h2 class="anchored" data-anchor-id="see-also">See Also</h2>
678685
<p><a href="../alphabetical.html">Alphabetical Function List</a></p>
679686

680687

681-
</section>
682-
</div>
683-
</section>
684688
</section>
685689

686690
</main> <!-- /main -->

documentation/utilities/Gouterjoin.html

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -424,17 +424,13 @@ <h1 class="title">Gouterjoin</h1>
424424
</header>
425425

426426

427-
<p><strong>Category:</strong> Utilities</p>
428427
<p>Documentation for the <code>Gouterjoin</code> function.</p>
429428
<section id="source-code" class="level2">
430429
<h2 class="anchored" data-anchor-id="source-code">Source Code</h2>
431430
</section>
432431
<section id="see-also" class="level2">
433432
<h2 class="anchored" data-anchor-id="see-also">See Also</h2>
434-
<ul>
435-
<li><a href="../alphabetical.html">Alphabetical Function List</a></li>
436-
<li><a href="https://www.generic-mapping-tools.org/GMTjl_doc/">GMT.jl Documentation</a></li>
437-
</ul>
433+
<p><a href="../alphabetical.html">Alphabetical Function List</a></p>
438434

439435

440436
</section>

documentation/utilities/anaglyph.html

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -496,7 +496,7 @@ <h3 class="anchored" data-anchor-id="credits">Credits</h3>
496496
<section id="examples" class="level2">
497497
<h2 class="anchored" data-anchor-id="examples">Examples</h2>
498498
<p>Create an anaglyph of first type overt the Iberian peninsula.</p>
499-
<div id="c2a0a42c" class="cell" data-execution_count="1">
499+
<div id="1b5f2989" class="cell" data-execution_count="1">
500500
<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>
501501
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a></span>
502502
<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a>I <span class="op">=</span> <span class="fu">anaglyph</span>(<span class="st">"@earth_relief_30s"</span>, region<span class="op">=</span><span class="st">"-13/-5.5/35/44"</span>)</span>
@@ -510,7 +510,7 @@ <h2 class="anchored" data-anchor-id="examples">Examples</h2>
510510
</div>
511511
</div>
512512
<p>Now let us see the Tonga Trench using the second method.</p>
513-
<div id="8cf2ff4e" class="cell" data-execution_count="2">
513+
<div id="62c4da4f" class="cell" data-execution_count="2">
514514
<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>
515515
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a></span>
516516
<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a>I <span class="op">=</span> <span class="fu">anaglyph</span>(<span class="st">"@earth_relief_30s"</span>, R<span class="op">=</span><span class="st">"-175.8/-171/-23/-14"</span>, view3d<span class="op">=</span><span class="cn">true</span>)</span>
@@ -528,19 +528,8 @@ <h2 class="anchored" data-anchor-id="examples">Examples</h2>
528528
<h2 class="anchored" data-anchor-id="source-code">Source Code</h2>
529529
<p>This function has multiple methods:</p>
530530
<ul>
531-
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/imshow.jl#L235"><code>imshow(arg1::Symbol; horizontal, kw...)</code></a> - imshow.jl:235</li>
532-
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/imshow.jl#L236"><code>imshow(arg1::GMTcpt; horizontal, kw...)</code></a> - imshow.jl:236</li>
533-
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/imshow.jl#L241"><code>imshow(arg1::GMT.Gdal.AbstractDataset; kw...)</code></a> - imshow.jl:241</li>
534-
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/imshow.jl#L270"><code>imshow(x::AbstractVector{Float64}, f::String; kw...)</code></a> - imshow.jl:270</li>
535-
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/imshow.jl#L269"><code>imshow(x::AbstractVector{Float64}, y::AbstractVector{Float64}, f::String; kw...)</code></a> - imshow.jl:269</li>
536-
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/imshow.jl#L266"><code>imshow(x::AbstractVector{Float64}, f::Function; kw...)</code></a> - imshow.jl:266</li>
537-
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/imshow.jl#L246"><code>imshow(x::AbstractVector{Float64}, y::AbstractVector{Float64}, f::Function; kw...)</code></a> - imshow.jl:246</li>
538-
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/imshow.jl#L268"><code>imshow(f::Function, x::AbstractVector{Float64}, y::AbstractVector{Float64}; kw...)</code></a> - imshow.jl:268</li>
539-
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/imshow.jl#L267"><code>imshow(f::Function, x::AbstractVector{Float64}; kw...)</code></a> - imshow.jl:267</li>
540-
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/imshow.jl#L124"><code>imshow(arg1::GItype; kw...)</code></a> - imshow.jl:124</li>
541-
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/imshow.jl#L36"><code>imshow(arg1; ...)</code></a> - imshow.jl:36</li>
542-
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/imshow.jl#L36"><code>imshow(arg1, x::AbstractVector{Float64}; ...)</code></a> - imshow.jl:36</li>
543-
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/imshow.jl#L36"><code>imshow(arg1, x::AbstractVector{Float64}, y::AbstractVector{Float64}; kw...)</code></a> - imshow.jl:36</li>
531+
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/extras/anaglyph.jl#L41"><code>anaglyph(fname::String; vscale, sscale, view3d, zsize, azim, dazim, cmap, kw...)</code></a> - anaglyph.jl:41</li>
532+
<li><a href="https://github.com/GenericMappingTools/GMT.jl/blob/master/src/extras/anaglyph.jl#L50"><code>anaglyph(G::GMTgrid; vscale, sscale, view3d, zsize, azim, dazim, cmap)</code></a> - anaglyph.jl:50</li>
544533
</ul>
545534

546535

-9 Bytes
Loading

documentation/utilities/autocor.html

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ <h1 class="title">autocor</h1>
428428
<p>Compute the autocorrelation function (ACF) of a vector or matrix <code>x</code>, optionally specifying the <code>lags</code>. <code>demean</code> denotes whether the mean of <code>x</code> should be subtracted from <code>x</code> before computing the ACF.</p>
429429
<p>If <code>x</code> is a vector, return a vector of the same length as <code>lags</code>. If <code>x</code> is a matrix, return a matrix of size <code>(length(lags), size(x,2))</code>, where each column in the result corresponds to a column in <code>x</code>.</p>
430430
<p>When left unspecified, the lags used are the integers from 0 to <code>min(size(x,1)-1, 10*log10(size(x,1)))</code>.</p>
431-
<p>The output is normalized by the variance of <code>x</code>, i.e.&nbsp;so that the lag 0 autocorrelation is 1. See <a href="@ref"><code>autocov</code></a> for the unnormalized form.</p>
431+
<p>The output is normalized by the variance of <code>x</code>, i.e.&nbsp;so that the lag 0 autocorrelation is 1. See <a href="../..\documentation/modules/autocov.html">autocov</a> for the unnormalized form.</p>
432432
<section id="source-code" class="level2">
433433
<h2 class="anchored" data-anchor-id="source-code">Source Code</h2>
434434
<p>This function has multiple methods:</p>
@@ -440,10 +440,8 @@ <h2 class="anchored" data-anchor-id="source-code">Source Code</h2>
440440
</section>
441441
<section id="see-also" class="level2">
442442
<h2 class="anchored" data-anchor-id="see-also">See Also</h2>
443-
<ul>
444-
<li><a href="../alphabetical.html">Alphabetical Function List</a></li>
445-
<li><a href="https://www.generic-mapping-tools.org/GMTjl_doc/">GMT.jl Documentation</a></li>
446-
</ul>
443+
<p><a href="../..\documentation/modules/autocov.html">autocov</a></p>
444+
<p><a href="../alphabetical.html">Alphabetical Function List</a></p>
447445

448446

449447
</section>

0 commit comments

Comments
 (0)