From 5ef82a94899795672e6c53335b364e7da5568c83 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yvonne=20Fr=C3=B6hlich?= Date: Sun, 22 Mar 2026 16:37:34 +0100 Subject: [PATCH] Update links to Julia docs --- doc/rst/source/tutorial/julia/index.rst | 4 +-- doc/rst/source/tutorial/julia/session-1.rst | 7 +++-- doc/rst/source/tutorial/julia/session-3.rst | 12 ++++----- doc/rst/source/tutorial/julia/session-4.rst | 29 +++++++++------------ 4 files changed, 22 insertions(+), 30 deletions(-) diff --git a/doc/rst/source/tutorial/julia/index.rst b/doc/rst/source/tutorial/julia/index.rst index 10890b9104d..4d36c6eea98 100644 --- a/doc/rst/source/tutorial/julia/index.rst +++ b/doc/rst/source/tutorial/julia/index.rst @@ -32,9 +32,9 @@ Alternatively, you can build GMT from source by following the See also the general information about `Julia `_ as well as the introduction to the Julia wrapper at -`Introduction `_ +`Introduction `_ and the very recommendable -`Quick Learn `_. +`Quick Learn `_. Complement with the instructions on how to install `GMT.jl `_ diff --git a/doc/rst/source/tutorial/julia/session-1.rst b/doc/rst/source/tutorial/julia/session-1.rst index 79ed88f9d60..c9f06a686f4 100644 --- a/doc/rst/source/tutorial/julia/session-1.rst +++ b/doc/rst/source/tutorial/julia/session-1.rst @@ -91,8 +91,7 @@ Laboratory Exercises We will begin our adventure by making some simple plot axes and coastline basemaps. We will do this in order to introduce the all-important common options **frame**, **proj**, and **region** and to familiarize ourselves -with a few selected GMT projections. The GMT modules we will utilize are :doc:`/basemap` and -`basemap `_. +with a few selected GMT projections. The GMT modules we will utilize are :doc:`/basemap` and :doc:`/coast`. Please consult their manual pages for reference. Linear projection @@ -165,8 +164,8 @@ projections offered by GMT; here we will only have time to focus on one such pro **proj=:merc** -To make coastline maps we use `coast `_ which automatically -will access the GMT coastline, river and border data base derived from the GSHHG database [See *Wessel and Smith*, 1996]. +To make coastline maps we use :doc:`/coast` which automatically will access the GMT coastline, river and border +data base derived from the GSHHG database [See *Wessel and Smith*, 1996]. In addition to the common switches we may need to use some of several coast-specific options: ============== ================================================================================================ diff --git a/doc/rst/source/tutorial/julia/session-3.rst b/doc/rst/source/tutorial/julia/session-3.rst index c4898899f1b..6e1bcfd1f35 100644 --- a/doc/rst/source/tutorial/julia/session-3.rst +++ b/doc/rst/source/tutorial/julia/session-3.rst @@ -26,9 +26,9 @@ The file contains bathymetry for the Bermuda region and has depth values from -5 As with previous plot commands we need to set up the map projection with **proj**. Here, however, we do not have to specify the region since that is by default assumed to be the extent of the grid file. To generate any plot we -will in addition need to supply information about which contours to draw. Unfortunately, -`grdcontour `_ is a complicated module with too -many options. We put a positive spin on this situation by touting its flexibility. Here are the most useful options: +will in addition need to supply information about which contours to draw. Unfortunately, :doc:`/grdcontour` is a +complicated module with too many options. We put a positive spin on this situation by touting its flexibility. +Here are the most useful options: +-----------------------------------------------------------------+----------------------------------------------------------------------+ | Option | Purpose | @@ -201,9 +201,7 @@ Preprocessing The :doc:`/surface` module assumes that the data have been preprocessed to eliminate aliasing, hence we must ensure that this step is completed prior to gridding. GMT comes with three preprocessors, called -`blockmean `_, -`blockmedian `_, and -`blockmode `_. The first averages values inside the +:doc:`/blockmean`, :doc:`/blockmedian`, and :doc:`/blockmode`. The first averages values inside the grid-spacing boxes, the second returns median values, wile the latter returns modal values. As a rule of thumb, we use means for most smooth data (such as potential fields) and medians (or modes) for rough, non-Gaussian data (such as topography). In addition to the required **region** and **inc** switches, these preprocessors all take @@ -223,7 +221,7 @@ The output data can now be used with surface:: G = surface(D, region=(245,255,20,30), inc="5m", verbose=true); -If you rerun `grdcontour `_ on the new grid file +If you rerun :doc:`/grdcontour` on the new grid file (try it!) you will notice a big difference compared to the grid made by :doc:`/nearneighbor`: since surface is a global method it will evaluate the solution at all nodes, even if there are no data constraints. There are numerous options available to us at this point: diff --git a/doc/rst/source/tutorial/julia/session-4.rst b/doc/rst/source/tutorial/julia/session-4.rst index 7e5b595d154..aede09db206 100644 --- a/doc/rst/source/tutorial/julia/session-4.rst +++ b/doc/rst/source/tutorial/julia/session-4.rst @@ -19,13 +19,12 @@ CPTs can be created in any number of ways. GMT provides two mechanisms: #. Create simple, linear color tables given a master color table (several are built-in) and the desired *z*-values at color boundaries - (`makecpt `_) + (:doc:`/makecpt`) #. Create color tables based on a master CPT color table and the histogram-equalized distribution of *z*-values - in a gridded data file (`grd2cpt `_) + in a gridded data file (:doc:`/grd2cpt`) -One can also make these files manually. Here we will limit our discussion to -`makecpt `_. +One can also make these files manually. Here we will limit our discussion to :doc:`/makecpt`. Its main argument is the name of the master color table (a list is shown if you run the module with no arguments) and the equidistant *z*-values to go with it. The main options are given below. @@ -47,12 +46,12 @@ from -20 to 60, with color changes at every 10, try these two variants: makecpt(cmap=:rainbow, range=(-20,60,10), write="disc.cpt") makecpt(cmap=:rainbow, range=(-20,60,10), continuous=true, write="cont.cpt") -We can plot these color tables with `colorbar `_; +We can plot these color tables with :doc:`/colorbar`; the options worth mentioning here are listed below. The placement of the color bar is particularly important and we refer you to the :ref:`Plot embellishments ` section for all the details. In addition, the **frame** option can be used to set the title and unit label (and optionally to set the annotation-, tick-, and grid-line intervals for the color bars.). Note that the makecpt commands above are done in classic mode. -If you run `makecpt `_ in modern mode then you usually +If you run :doc:`/makecpt` in modern mode then you usually do not specify an output file via standard output since modern mode maintains what is known as the current CPT. However, if you must explicitly name an output CPT then you will need to add the -H option for modern mode to allow output to standard output. @@ -90,8 +89,7 @@ Your plot should look like :ref:`our example 14 below ` Exercises: -#. Redo the `makecpt `_ exercise using the - master table *hot* and redo the bar plot. +#. Redo the :doc:`/makecpt` exercise using the master table *hot* and redo the bar plot. #. Try specifying **frame**\ =(annot=10, grid=5). @@ -140,9 +138,8 @@ Here, we will extract a subset of the global 30" DEM called SRTM30+: Using :doc:`/grdinfo` we find that the data ranges from about 1000m to about 4300m so we need to make a CPT with that range. -Color images are made with `grdimage `_ -which takes the usual common command options (by default the **region** is taken from the data set) and a CPT; -the main other options are: +Color images are made with :doc:`/grdimage` which takes the usual common command options +(by default the **region** is taken from the data set) and a CPT; the main other options are: ==================== ====================================================================== Option Purpose @@ -172,8 +169,7 @@ Your plot should look like :ref:`our example 15 below ` The plain color map lacks detail and fails to reveal the topographic complexity of this Rocky Mountain region. What it needs is artificial illumination. We want to simulate shading by a sun source in the east, hence we -derive the required intensities from the gradients of the topography in the N90°E direction using -`grdgradient `_. +derive the required intensities from the gradients of the topography in the N90°E direction using :doc:`/grdgradient`. Other than the required input and output filenames, the available options are +----------------------------------------------+-----------------------------------------------------------------------------+ @@ -239,7 +235,7 @@ Exercises: #. Force a gray-shade image. -#. Rerun `grdgradient `_ with **norm**\ =1. +#. Rerun :doc:`/gragradient` with **norm**\ =1. Multi-dimensional maps ---------------------- @@ -297,7 +293,7 @@ Perspective views ----------------- Our final undertaking in this tutorial is to examine three-dimensional perspective views. The GMT module that -produces perspective views of gridded data files is `grdview `_. +produces perspective views of gridded data files is :doc:`/grdview`. It can make two kinds of plots: #. Mesh or wire-frame plot (with or without superimposed contours) @@ -384,7 +380,6 @@ Exercises: #. Choose another vantage point and scaling. -#. Redo `grdgradient `_ with another illumination - direction and plot again. +#. Redo :doc:`/grdgradient` with another illumination direction and plot again. #. Select a higher *dpi*, e.g., 200.