Figure.solar: Plot day-night terminators and other sunlight parameters.

[seisman]

This issue serves as the central tracker for the implementation of the Figure.solar method.

• GMT doc: https://docs.generic-mapping-tools.org/6.5/solar.html
• PyGMT doc: https://www.pygmt.org/dev/api/generated/pygmt.Figure.solar.html

Options

Checked: Implemented; Unchecked: To be implemented/discussed and help wanted; Strikethrough: Won't implement.

• -B: frame
• -G: fill. Clipping will be implemented in POC: Figure.clip: Clip paths by polygons, land or water #3878
• -J: projection
• -R: region
• -Tdcna[+ddate][+zTZ]]:
  • dcna: terminator. It can be one of "astronomical", "civil", "day_night", "nautical"
  • +d: terminator_datetime
  • +z: use tzinfo from terminator_datetime. Figure.solar: Support terminator datetime with timezone #4112
• -U: Use Figure.timestamp
• -V: verbose
• -W: pen
• -X/-Y: Use Figure.shift_origin
• -p: perspective
• -t: transparency
• --PAR=value: Use pygmt.config

Options related to clipping

• -G POC: Figure.clip: Clip paths by polygons, land or water #3878
• -N POC: Figure.clip: Clip paths by polygons, land or water #3878

Options for inquiring about the sun's position

• -C
• -I

Options for dumping the lines

• -M
• -b
• -o

Progresses

• Initial feature implementation PR Wrap solar #804
• All functionality are implemented
• Add a tutorial/gallery
• Docstrings are complete and easy to read
• Full type hints