pygmt.Figure.solar

Figure.solar(terminator='day_night', terminator_datetime=None, fill=None, pen=None, projection=None, region=None, frame=False, verbose=False, panel=False, perspective=False, transparency=None, **kwargs)

Plot day-night terminators and other sunlight parameters.

This method plots the day-night terminator. Alternatively, it can plot the terminators for civil twilight, nautical twilight, or astronomical twilight.

Full GMT docs at https://docs.generic-mapping-tools.org/6.7/solar.html.

Aliases:

  • B = frame

  • G = fill

  • J = projection

  • R = region

  • T = terminator, +d/+z: terminator_datetime

  • V = verbose

  • W = pen

  • c = panel

  • p = perspective

  • t = transparency

Parameters:

  • terminator (Literal['astronomical', 'civil', 'day_night', 'nautical'], default: 'day_night') –

    Set the type of terminator. Choose one of the following:

    • "astronomical": Astronomical twilight

    • "civil": Civil twilight

    • "day_night": Day-night terminator

    • "nautical": Nautical twilight

    Refer to https://en.wikipedia.org/wiki/Twilight for the definitions of different types of twilight.

  • terminator_datetime (str or datetime object) – Set the date and time for the terminator calculation. It can be provided as a string or any datetime-like object recognized by pandas.to_datetime. The time can be specified in UTC or using a UTC offset. The offset must be an integer number of hours (e.g., -8 or +5); fractional hours are truncated towards zero (e.g., -8.5 becomes -8 and +5.5 becomes +5). [Default is the current UTC date and time].

  • fill (str | None, default: None) – Set color or pattern for filling terminators [Default is no fill].

  • pen (str | None, default: None) – Set pen attributes for lines [Default is "0.25p,black,solid"].

  • projection (str | None, default: None) – projcode[projparams/]width|scale. Select map projection.

  • region (Sequence[float | str] | str | None, default: None) – [xmin, xmax, ymin, ymax] or xmin/xmax/ymin/ymax[+r][+uunit]. Specify the region of interest.

  • frame (Frame | Axis | Literal['none'] | str | Sequence[str] | bool, default: False) – Set frame and axes attributes for the plot. It can be a bool, "none", a pygmt.params.Frame or pygmt.params.Axis object. Raw GMT strings or sequences of strings are also supported for backward compatibility. If frame=True, the frame will be drawn with the default attributes. If frame="none", no frame will be drawn. Use a pygmt.params.Frame or pygmt.params.Axis object for more control over the attributes of the frame and axes. A tutorial is available at frame and axes attributes. Full documentation is at https://docs.generic-mapping-tools.org/6.7/gmt.html#b-full.

  • verbose (Literal['quiet', 'error', 'warning', 'timing', 'info', 'compat', 'debug'] | bool, default: False) – 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 (Perspective | float | Sequence[float] | bool, default: False) – Select perspective view and set the viewpoint. Pass a pygmt.params.Perspective object to control the viewpoint. Alternatively, set perspective=True to reuse the perspective setting from the previous plotting method. It also accepts following shortcuts: a single value azimuth, a sequence of two values (azimuth, elevation), or a sequence of three values (azimuth, elevation, level). Refer to pygmt.params.Perspective for meaning of the parameters.

  • transparency (float | None, default: None) – 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).

Example

>>> # import the Python module "datetime"
>>> import datetime
>>> import pygmt
>>> # create a datetime object at 8:52:18 on June 24, 1997 (time in UTC)
>>> date = datetime.datetime(
...     year=1997, month=6, day=24, hour=8, minute=52, second=18
... )
>>> # create a new plot with pygmt.Figure()
>>> fig = pygmt.Figure()
>>> # create a map of the Earth with the coast method
>>> fig.coast(land="darkgreen", water="lightblue", projection="W10c", region="d")
>>> fig.solar(
...     # set the terminator to "day_night"
...     terminator="day_night",
...     # pass the datetime object
...     terminator_datetime=date,
...     # fill the night-section with navyblue at 75% transparency
...     fill="navyblue@75",
...     # draw the terminator with a 1-point black line
...     pen="1p,black",
... )
>>> # show the plot
>>> fig.show()

Examples using pygmt.Figure.solar

Day-night terminator and twilights

Day-night terminator and twilights

Bit and hachure patterns

Bit and hachure patterns