Add a gallery example for the Figure.timestamp method #2391

michaelgrund · 2023-03-03T08:33:41Z

Description of proposed changes

Addresses #2390.

Preview: https://pygmt-dev--2391.org.readthedocs.build/en/2391/gallery/embellishments/timestamp.html

Reminders

Run make format and make check to make sure the code follows the style guide.
Add tests for new features or tests that would have caught the bug that you're fixing.
Add new public functions/methods/classes to doc/api/index.rst.
Write detailed docstrings for all functions/methods.
If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
If adding new functionality, add an example to docstrings or tutorials.
Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

/format: automatically format and lint the code
/test-gmt-dev: run full tests on the latest GMT development version

michaelgrund · 2023-03-06T08:17:31Z

Adding a static time format string via e.g. pygmt.config(FORMAT_TIME_STAMP="2023-03-01T20:45:15") does actually not work. Any ideas why @GenericMappingTools/pygmt-maintainers ?

michaelgrund · 2023-03-06T08:23:23Z

/format

seisman · 2023-03-06T08:45:07Z

Adding a static time format string via e.g. pygmt.config(FORMAT_TIME_STAMP="2023-03-01T20:45:15") does actually not work. Any ideas why @GenericMappingTools/pygmt-maintainers ?

It's because the timefmt parameter overrides the FORMAT_TIME_STAMP setting. See the relevant codes at:

pygmt/pygmt/src/timestamp.py

Line 100 in 8d165c1

kwdict, confdict={"FONT_LOGO": font, "FORMAT_TIME_STAMP": timefmt}

seisman · 2023-03-06T08:47:10Z

examples/gallery/embellishments/timestamp.py

+# Define static format string.
+pygmt.config(FORMAT_TIME_STAMP="2023-03-01T20:45:15")


We don't need to have a static UNIX timestamp string here, because the gallery examples are not tested in the CI.

yvonnefroehlich · 2023-03-06T08:48:19Z

Adding a static time format string via e.g. pygmt.config(FORMAT_TIME_STAMP="2023-03-01T20:45:15") does actually not work. Any ideas why @GenericMappingTools/pygmt-maintainers ?

Hm. Probably you may want to use the text parameter of pygmt.Figure.timestamp to modify the date (please see https://www.pygmt.org/dev/api/generated/pygmt.Figure.timestamp.html#pygmt.Figure.timestamp). Please note, that using the text parameter requires GMT >=6.5.0. As I have not installed the dev version of GMT, I can not test this at the moment 🙁.

text (None or str) – If None, the current UNIX timestamp is shown in the GMT timestamp logo. Set this parameter to replace the UNIX timestamp with a custom text string instead. The text must be less than 64 characters. Requires GMT>=6.5.0.

From the upstream GMT documentation I understand that FORMAT_TIME_STAMP does affect the format, not the date or text itself (please see the upstream documentation https://docs.generic-mapping-tools.org/dev/gmt.conf.html#term-FORMAT_TIME_STAMP).

Defines the format of the time information in the UNIX time stamp. This format is parsed by the C function strftime, so that virtually any text can be used (even not containing any time information) [default is %Y %b %d %H:%M:%S].

examples/gallery/embellishments/timestamp.py

michaelgrund · 2023-03-06T11:11:52Z

As already suggested by @weiji14 in #2208, in my opinion the justification shortcuts are not correct:

I would say the labels must be switched across the diagonal axis. However, I think that must be fixed upstream. Maybe @PaulWessel can tell us if this is the correct behavior or it should be fixed.

michaelgrund · 2023-03-06T11:12:25Z

/format

yvonnefroehlich · 2023-03-06T12:05:47Z

As already suggested by @weiji14 in #2208, in my opinion the justification shortcuts are not correct:
I would say the labels must be switched across the diagonal axis.

Hm. I feel they are correct. Maybe the confusion is coming from the difference between position and justification?
For the timestamp logo, only justification can be changed; the default is BL. position is fixed to BL.
For example, for an anchor point set to BR I expect everything to be left above this point, similar for the other three.
Maybe this rough sketch helps:

Edit 2023/03/11: Updated picture regarding more precise usage of "figure" and "map"/"plot".

michaelgrund · 2023-03-06T12:52:43Z

As already suggested by @weiji14 in #2208, in my opinion the justification shortcuts are not correct:
I would say the labels must be switched across the diagonal axis.

Hm. I feel they are correct. Maybe the confusion is coming from the difference between position and justification? For the timestamp logo, only justification can be changed; the default is BL. position is fixed to BL. For example, for an anchor point set to BR I expect everything to be left above this point, similar for the other three.

Ok now I got it, thanks @yvonnefroehlich.

examples/gallery/embellishments/timestamp.py

yvonnefroehlich · 2023-03-06T18:35:33Z

examples/gallery/embellishments/timestamp.py

+can be added via the ``label`` parameter. The timestamp
+will always be shown in the bottom-left corner of the
+figure.


I would be a bit more detailed here. Feel free to improve my formulation.

Suggested change

can be added via the ``label`` parameter. The timestamp

will always be shown in the bottom-left corner of the

figure.

can be added via the ``label`` parameter. The timestamp

will always be shown relative to the bottom-left corner

of the figure. By default, the ``offset`` and

``justification`` parameters are set to

``("-54p", "-54p")`` (x, y directions) and ``"BL"``

(bottom-left), respectively.

Hm. Based on @michaelgrund's comment #2395 (comment), I am wondering whether this formulation is strictly speaking also not precise / correct and "figure" should be "map" (or "plot")?

Edit 2023/03/17: Changed in PR #2434.

Perhaps open a separate issue so that we can have more discussions.

Please see issue #2437.

examples/gallery/embellishments/timestamp.py

Co-authored-by: Yvonne Fröhlich <[email protected]>

examples/gallery/embellishments/timestamp.py

Co-authored-by: Yvonne Fröhlich <[email protected]>

michaelgrund · 2023-03-07T16:31:32Z

/format

examples/gallery/embellishments/timestamp.py

seisman

This PR looks good to me except the minor fix above.

Co-authored-by: Dongdong Tian <[email protected]>

yvonnefroehlich

Looks good to me! Thanks @michaelgrund for considering all the suggestions 🙂.

Create timestamp.py

1652c57

michaelgrund added the documentation Improvements or additions to documentation label Mar 3, 2023

michaelgrund added this to the 0.9.0 milestone Mar 3, 2023

michaelgrund marked this pull request as draft March 3, 2023 08:33

michaelgrund changed the title ~~Create timestamp.py~~ WIP: Add a gallery example for the Figure.timestamp method Mar 3, 2023

michaelgrund linked an issue Mar 3, 2023 that may be closed by this pull request

Add a gallery example for the Figure.timestamp method #2390

Closed

michaelgrund added 2 commits March 3, 2023 09:44

Update timestamp.py

9842c39

Update timestamp.py

6a6756c

michaelgrund changed the title ~~WIP: Add a gallery example for the Figure.timestamp method~~ Add a gallery example for the Figure.timestamp method Mar 6, 2023

michaelgrund marked this pull request as ready for review March 6, 2023 08:16

Merge branch 'main' into add-timestamp-example

7c890e5

michaelgrund added 2 commits March 6, 2023 09:18

Update timestamp.py

118cf12

Update timestamp.py

f7e1e34

Update timestamp.py

7befea7

seisman reviewed Mar 6, 2023

View reviewed changes

Update timestamp.py

a5c651b

michaelgrund added the needs review This PR has higher priority and needs review. label Mar 6, 2023

seisman reviewed Mar 6, 2023

View reviewed changes

examples/gallery/embellishments/timestamp.py Show resolved Hide resolved

Update timestamp.py

edb05d0

Update timestamp.py

38fdb03

yvonnefroehlich reviewed Mar 6, 2023

View reviewed changes

seisman reviewed Mar 7, 2023

View reviewed changes

examples/gallery/embellishments/timestamp.py Outdated Show resolved Hide resolved

michaelgrund and others added 3 commits March 7, 2023 09:02

Apply suggestions from code review

1e1e4d9

Co-authored-by: Yvonne Fröhlich <[email protected]>

Update timestamp.py

5a1c353

Merge branch 'main' into add-timestamp-example

83aad2b

seisman reviewed Mar 7, 2023

View reviewed changes

examples/gallery/embellishments/timestamp.py Outdated Show resolved Hide resolved

yvonnefroehlich reviewed Mar 7, 2023

View reviewed changes

examples/gallery/embellishments/timestamp.py Show resolved Hide resolved

michaelgrund and others added 2 commits March 7, 2023 17:19

Apply suggestions from code review

4ac0b49

Co-authored-by: Yvonne Fröhlich <[email protected]>

Update timestamp.py

668318a

[format-command] fixes

c682b92

seisman reviewed Mar 7, 2023

View reviewed changes

examples/gallery/embellishments/timestamp.py Outdated Show resolved Hide resolved

seisman approved these changes Mar 7, 2023

View reviewed changes

seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Mar 7, 2023

michaelgrund and others added 2 commits March 8, 2023 07:23

Apply suggestions from code review

d35650a

Co-authored-by: Dongdong Tian <[email protected]>

Merge branch 'main' into add-timestamp-example

e3620ab

yvonnefroehlich reviewed Mar 8, 2023

View reviewed changes

seisman merged commit c974933 into main Mar 8, 2023

seisman deleted the add-timestamp-example branch March 8, 2023 08:34

seisman removed the final review call This PR requires final review and approval from a second reviewer label Mar 8, 2023

		# Define static format string.
		pygmt.config(FORMAT_TIME_STAMP="2023-03-01T20:45:15")

-can be added via the ``label`` parameter. The timestamp
-will always be shown in the bottom-left corner of the
-figure.
+can be added via the ``label`` parameter. The timestamp
+will always be shown relative to the bottom-left corner
+of the figure. By default, the ``offset`` and
+``justification`` parameters are set to
+``("-54p", "-54p")`` (x, y directions) and ``"BL"``
+(bottom-left), respectively.

Add a gallery example for the Figure.timestamp method #2391

Add a gallery example for the Figure.timestamp method #2391

Uh oh!

Conversation

michaelgrund commented Mar 3, 2023 • edited by seisman Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

michaelgrund commented Mar 6, 2023

Uh oh!

michaelgrund commented Mar 6, 2023

Uh oh!

seisman commented Mar 6, 2023

Uh oh!

seisman Mar 6, 2023

Choose a reason for hiding this comment

Uh oh!

yvonnefroehlich commented Mar 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

michaelgrund commented Mar 6, 2023

Uh oh!

michaelgrund commented Mar 6, 2023

Uh oh!

yvonnefroehlich commented Mar 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

michaelgrund commented Mar 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

yvonnefroehlich Mar 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yvonnefroehlich Mar 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

seisman Mar 11, 2023

Choose a reason for hiding this comment

Uh oh!

yvonnefroehlich Mar 17, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

michaelgrund commented Mar 7, 2023

Uh oh!

Uh oh!

seisman left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yvonnefroehlich left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

michaelgrund commented Mar 3, 2023 •

edited by seisman

Loading

yvonnefroehlich commented Mar 6, 2023 •

edited

Loading

yvonnefroehlich commented Mar 6, 2023 •

edited

Loading

michaelgrund commented Mar 6, 2023 •

edited

Loading

yvonnefroehlich Mar 6, 2023 •

edited

Loading

yvonnefroehlich Mar 11, 2023 •

edited

Loading

seisman left a comment •

edited

Loading