pygmt.Figure.pygmtlogo

Figure.pygmtlogo(shape='circle', theme='light', wordmark='none', color=True, width=None, height=None, position=None, box=False, verbose=False, panel=False, perspective=False, transparency=None)

Plot the PyGMT logo.

The design of the logo is kindly provided by @sfrooti and consists of a visual and the wordmark “PyGMT”.

Parameters:

• shape (Literal['circle', 'hexagon'], default: 'circle') – Shape of the visual logo. Use "circle" for a circle shape [Default] or "hexagon" for a hexagon shape.

• theme (Literal['light', 'dark'], default: 'light') – Use "light" for light mode (i.e., a white background) [Default] and "dark" for dark mode (i.e., a darkgray background).

• wordmark (Literal['none', 'horizontal', 'vertical'], default: 'none') –

  Add the wordmark “PyGMT” and adjust its orientation relative to the visual. Valid values are:

  • "none": no wordmark [Default].

  • "horizontal": wordmark at the right side of the visual.

  • "vertical": wordmark below the visual.

• color (bool, default: True) – True for a color logo, and False for a black and white logo.

• position (Position | Sequence[float | str] | Literal['TL', 'TC', 'TR', 'ML', 'MC', 'MR', 'BL', 'BC', 'BR'] | None, default: None) –

  Position of the GMT logo on the plot. It can be specified in multiple ways:

  • A pygmt.params.Position object to fully control the reference point, anchor point, and offset.

  • A sequence of two values representing the x- and y-coordinates in plot coordinates, e.g., (1, 2) or ("1c", "2c").

  • A 2-character justification code for a position inside the plot, e.g., "TL" for Top Left corner inside the plot.

  If not specified, defaults to the Bottom Left corner of the plot (position (0, 0) with anchor "BL").

• width (float | str | None, default: None)

• height (float | str | None, default: None) – Width or height of the PyGMT logo. Since the aspect ratio is fixed, only one of the two can be specified.

• box (Box | bool, default: False) – Draw a background box behind the logo. If set to True, a simple rectangular box is drawn using MAP_FRAME_PEN. To customize the box appearance, pass a pygmt.params.Box object to control style, fill, pen, and other box properties.

• verbose (bool or str) – Select verbosity level [Full usage].

• panel (int | Sequence[int] | bool, default: False) –

  Select a specific subplot panel. Only allowed when used in Figure.subplot mode.

  • True to advance to the next panel in the selected order.

  • index to specify the index of the desired panel.

  • (row, col) to specify the row and column of the desired panel.

  The panel order is determined by the Figure.subplot method. row, col and index all start at 0.

• perspective (float | Sequence[float] | str | bool, default: False) –

  Select perspective view and set the azimuth and elevation of the viewpoint.

  Accepts a single value or a sequence of two or three values: azimuth, (azimuth, elevation), or (azimuth, elevation, zlevel).

  • azimuth: Azimuth angle of the viewpoint in degrees [Default is 180, i.e., looking from south to north].

  • elevation: Elevation angle of the viewpoint above the horizon [Default is 90, i.e., looking straight down at nadir].

  • zlevel: Z-level at which 2-D elements (e.g., the plot frame) are drawn. Only applied when used together with zsize or zscale. [Default is at the bottom of the z-axis].

  Alternatively, set perspective=True to reuse the perspective setting from the previous plotting method, or pass a string following the full GMT syntax for finer control (e.g., adding +w or +v modifiers to select an axis location other than the plot origin). See https://docs.generic-mapping-tools.org/6.6/gmt.html#perspective-full for details.

• transparency (float) – Set transparency level, in [0-100] percent range [Default is 0, i.e., opaque]. Only visible when PDF or raster format output is selected. Only the PNG format selection adds a transparency layer in the image (for further processing).

Examples

>>> import pygmt

The simplest way to plot the PyGMT logo is to call the method without any arguments.

>>> fig = pygmt.Figure()
>>> fig.pygmtlogo()
>>> fig.show()

Plot the PyGMT logo with the wordmark “PyGMT” with a height of 1 centimeter at the right side in the Bottom Right corner on an existing basemap:

>>> fig = pygmt.Figure()
>>> fig.basemap(region=[-90, -70, 0, 20], projection="M10c", frame=True)
>>> fig.pygmtlogo(wordmark="horizontal", position="BR", height="1c")
>>> fig.show()