Add pastplates & maregrams docs

Author: joa-quim

documentation/all_docs_ref/all_refs.md

@@ -30,8 +30,14 @@
 |:-----|:----|:----|:----|:----|:----|:----|:----|:----|:----|
 | \myreflink{arrows} | \myreflink{band} | \myreflink{bar} | \myreflink{bar3} | \myreflink{boxplot} | \myreflink{bubblechart} | \myreflink{contourf} | \myreflink{cornerplot} | \myreflink{decorated} | \myreflink{earthregions} |
 | \myreflink{ecdfplot} | \myreflink{feather} | \myreflink{fill_between} | \myreflink{hband} | \myreflink{hlines} | \myreflink{logo} | \myreflink{lines} | \myreflink{marginalhist} | \myreflink{parallelplot} | \myreflink{pcolor} |
-| \myreflink{plotlinefit} | \myreflink{qqplot} | \myreflink{quiver} | \myreflink{radar} | \myreflink{sealand} | \myreflink{scatter} | \myreflink{scatter3} | \myreflink{seismicity} | \myreflink{stairs} | \myreflink{stem} |
-| \myreflink{streamlines} | \myreflink{triplot} | \myreflink{trisurf} | \myreflink{vband} | \myreflink{violin} | \myreflink{vlines} |  |  |  |  |
+| \myreflink{plotlinefit} | \myreflink{qqplot} | \myreflink{quiver} | \myreflink{radar} | \myreflink{sealand} | \myreflink{scatter} | \myreflink{scatter3} | \myreflink{stairs} | \myreflink{stem} | \myreflink{streamlines} |
+| \myreflink{triplot} | \myreflink{trisurf} | \myreflink{vband} | \myreflink{violin} | \myreflink{vlines} |  |  |  |  |  |
+
+## Web download modules
+
+|  |  |  |  |  |  |  |  |
+|:-----|:----|:----|:----|:----|:----|:----|:----|
+| \myreflink{maregrams} | \myreflink{pastplates} | \myreflink{seismicity} | \myreflink{weather} | \myreflink{wmsinfo} | \myreflink{wmsread} | \myreflink{wmstest} |  |
 
 
 ## Supplemental Modules (Potential methods)
@@ -57,8 +63,7 @@ its use requires resorting to the \myreflink{Monolithic} mode.
 | \myreflink{lelandshade} | \myreflink{linearfitxy} | \myreflink{magic} | \myreflink{mat2ds} | \myreflink{mat2grid} | \myreflink{mat2img} | \myreflink{mosaic} | \myreflink{ODE2ds} |
 | \myreflink{orbits} | \myreflink{pca} | \myreflink{plotgrid!} | \myreflink{plotyy} \myreflink{pol2cart} | \myreflink{polygonlevels} | \myreflink{rasterzones!} | \myreflink{regiongeog} | \myreflink{remotegrid} |
 | \myreflink{rescale} | \myreflink{slicecube} | \myreflink{sph2cart} | \myreflink{stackgrids} | \myreflink{ter2cart} | \myreflink{theme} | \myreflink{uniqueind} | \myreflink{vecangles} |
-| \myreflink{weather} | \myreflink{whereami} | \myreflink{wmsinfo} | \myreflink{wmsread} | \myreflink{wmstest} | \myreflink{worldrectgrid} | \myreflink{worldrectcoast} | \myreflink{worldrectangular} |
-| \myreflink{xyzw2cube} | \myreflink{yeardecimal} | \myreflink{zonal_stats} |  |  |  |  |  |
+| \myreflink{weather} | \myreflink{whereami} | \myreflink{worldrectgrid} | \myreflink{worldrectcoast} | \myreflink{worldrectangular} | \myreflink{xyzw2cube} | \myreflink{yeardecimal} | \myreflink{zonal_stats} |
 
 ## Solids functions
 

documentation/utilities/maregrams.md

@@ -0,0 +1,57 @@
+# maregrams
+
+```
+D = maregrams(list::Bool=false, code="", name="", days::Real=2, starttime::String="", printurl=false)
+or
+
+D = maregrams(lon::Real, lat::Real; days=2, starttime::String="")
+```
+
+*keywords: GMT, Julia, Plate Kinematics*
+
+Download maregrams data from [www.ioc-sealevelmonitoring.org](http://www.ioc-sealevelmonitoring.org).
+
+The default is to download the last 2 days, but length and duration is configurable by input options.
+Since the use of this function requires knowing the station code or name, we provide also the possibility
+to use coordinates to find the nearest station. The file with stations data locations and names is stored in
+the `TESTSDIR/assets/maregs_online.csv` file, which can be accessed using `d = GMT.read_maregrams()` and its
+contents are returned in the `d` dictionary. Note that not all stations sites are always on and running, so
+errors when requesting data from some stations are, unfortunately, not so uncommon.
+
+Our reference stations data is a bit old (needs update) and we can find more stations online listed at the
+[www.ioc-sealevelmonitoring.org](http://www.ioc-sealevelmonitoring.org) site. If user provides a station code
+that we don't know about, but is a valid one, we still return the data for that station. Example:
+`D = maregrams(code="tdoj")`
+
+### Args
+- `lon, lat`: (Second form) Coordinates of a point that is used to find the closest station to that point.
+   This is an alternative way of selecting a station instead of using `code` or `name` that require knowing them.
+
+### Kwargs
+- `list::Bool`: If true, returns a GMTdataset with the list all available stations and their codes and coords.
+
+- `code`: Station code (See the output of `list`)
+
+- `name`: In alternative to `code` give the station name (See the output of `list`)
+
+- `days`: Number of days to be downloaded. It can be a decimal number.
+
+- `starttime`: Start time in ISO8601 format (_e.g._ `"2019-01-01T00:00:00"`, or just the date `"2019-01-01"`).
+
+- `printurl`: If true, prints the station's URL. Useful for getting more info about the sation and its data.
+
+### Returns
+- `D`: \myreflink{GMTdataset} with the maregrams data.
+
+### Example
+
+Get the time series for 4 days starting at February 1 2025 for the station with code "lgos" (Lagos, Portugal)
+
+\begin{examplefig}{}
+```julia
+using GMT
+
+D = maregrams(code="lgos", days=4, starttime="2025-02-01");
+viz(D, title="Tide Gauge at Lagos (Portugal)")
+```
+\end{examplefig}

documentation/utilities/pastplates.md

@@ -0,0 +1,40 @@
+# pastplates
+
+```
+pastplates(; time=100, proj="", title="time", coastlines=true, fmt="png", name="", data=false, show=true)
+```
+
+*keywords: GMT, Julia, Plate Kinematics*
+
+Plots the reconstruction of the past plates at a given time. Data is extracted from the GPLATES
+https://gws.gplates.org website.
+
+# Kwargs
+- `time`: Time in Ma. Default is 100 Ma.
+
+- `proj`: A projection string like that used, or example, in `coast()`. 
+
+- `title`: Title of the plot
+
+- `coastlines`: A boolean indicating if want to plot the coastlines.
+
+- `fmt`: Format of the plot (Default is `png`)
+
+- `name`: Name of the plot. Instead of using a default name, provide one and figure will be saved with that name.
+
+- `data`: If true `pastplates` return the data in a form of a vector of `GMTdataset` instead of plotting it.
+   The default is produce a minimally nice plot but for further enhancements, download the data and make a plot yourself. 
+
+- `show`: If true (the default), automatically show the plot (ignored if `data=true`).
+
+# Examples
+
+Make a figure representing plates positions at 100 Ma ago.
+
+\begin{examplefig}{}
+```julia
+using GMT
+
+pastplates()
+```
+\end{examplefig}