Skip to content

Commit

Permalink
Gallery example "Custom symbols": Mention own coustom symbols (#3186)
Browse files Browse the repository at this point in the history
Co-authored-by: Michael Grund <[email protected]>
  • Loading branch information
yvonnefroehlich and michaelgrund committed Apr 21, 2024
1 parent bfbe444 commit 86cf1e2
Showing 1 changed file with 21 additions and 17 deletions.
38 changes: 21 additions & 17 deletions examples/gallery/symbols/custom_symbols.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,21 @@
Custom symbols
==============
The :meth:`pygmt.Figure.plot` method can plot individual custom symbols
by passing the corresponding symbol name together with the **k** shortcut to
the ``style`` parameter. In total 41 custom symbols are already included of
which the following plot shows five exemplary ones. The symbols are shown
underneath their corresponding names. For the remaining symbols see the GMT
Technical Reference :gmt-docs:`reference/custom-symbols.html`.
The :meth:`pygmt.Figure.plot` method can plot individual custom symbols by
passing the corresponding symbol name together with the **k** shortcut to the
``style`` parameter.
In total 41 custom symbols are already included of which the following plot shows
five exemplary ones. The symbols are shown underneath their corresponding names.
For the remaining symbols see the GMT Technical Reference
:gmt-docs:`reference/custom-symbols.html`.
Beside these built-in custom symbols GMT allows users to define their own custom
symbols. For this, a specific macro language is used. A detailed introduction can
be found at :gmt-docs:`reference/custom-symbols.html#the-macro-language`. After
defining such a symbol it can be used in the same way as a built-in custom symbol.
*Please note*: Custom symbols can not be used in auto-legends yet.
"""

# %%
Expand All @@ -16,32 +25,27 @@
fig = pygmt.Figure()
fig.basemap(region=[0, 8, 0, 3], projection="X12c/4c", frame=True)

# define pen and fontstyle for annotations
# Define pen and fontstyle for annotations
pen = "1p,black"
font = "15p,Helvetica-Bold"

# use the volcano symbol with a size of 1.5c,
# fill color is set to "seagreen"
# Use the volcano symbol with a size of 1.5c, fill color is set to "seagreen"
fig.plot(x=1, y=1.25, style="kvolcano/1.5c", pen=pen, fill="seagreen")
fig.text(x=1, y=2.5, text="volcano", font=font)

# use the astroid symbol with a size of 1.5c,
# fill color is set to "red3"
# Use the astroid symbol with a size of 1.5c, fill color is set to "red3"
fig.plot(x=2.5, y=1.25, style="kastroid/1.5c", pen=pen, fill="red3")
fig.text(x=2.5, y=2.5, text="astroid", font=font)

# use the flash symbol with a size of 1.5c,
# fill color is set to "darkorange"
# Use the flash symbol with a size of 1.5c, fill color is set to "darkorange"
fig.plot(x=4, y=1.25, style="kflash/1.5c", pen=pen, fill="darkorange")
fig.text(x=4, y=2.5, text="flash", font=font)

# use the star4 symbol with a size of 1.5c,
# fill color is set to "dodgerblue4"
# Use the star4 symbol with a size of 1.5c, fill color is set to "dodgerblue4"
fig.plot(x=5.5, y=1.25, style="kstar4/1.5c", pen=pen, fill="dodgerblue4")
fig.text(x=5.5, y=2.5, text="star4", font=font)

# use the hurricane symbol with a size of 1.5c,
# fill color is set to "magenta4"
# Use the hurricane symbol with a size of 1.5c, fill color is set to "magenta4"
fig.plot(x=7, y=1.25, style="khurricane/1.5c", pen=pen, fill="magenta4")
fig.text(x=7, y=2.5, text="hurricane", font=font)

Expand Down

0 comments on commit 86cf1e2

Please sign in to comment.