Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the gallery example for datetime inputs #919

Merged
merged 10 commits into from
Feb 18, 2021
Merged

Improve the gallery example for datetime inputs #919

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
3cfc0b5
Correct typo in datetime-inputs gallery example
michaelgrund Feb 17, 2021
3a05ea5
Update datetime-inputs.py
michaelgrund Feb 17, 2021
f1e9eb3
Merge branch 'master' into correct-typo-gallery-datetime
michaelgrund Feb 18, 2021
de8b232
updates
michaelgrund Feb 18, 2021
283ffe0
Update examples/gallery/plot/datetime-inputs.py
michaelgrund Feb 18, 2021
b37bfe5
shortened lines
michaelgrund Feb 18, 2021
fea5c2c
updated docstring
michaelgrund Feb 18, 2021
7861884
updated docstring
michaelgrund Feb 18, 2021
904551c
updated docstring
michaelgrund Feb 18, 2021
21fdf2a
Update examples/gallery/plot/datetime-inputs.py
michaelgrund Feb 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions examples/gallery/plot/datetime-inputs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,16 @@
- :class:`numpy.datetime64`
- :class:`pandas.DatetimeIndex`
- :class:`xarray.DataArray`: datetimes included in a *xarray.DataArray*
- raw datetime strings in `ISO format <https://en.wikipedia.org/wiki/ISO_8601>`__ (e.g. ``"YYYY-MM-DD"``, ``"YYYY-MM-DDTHH"``, and ``"YYYY-MM-DDTHH:MM:SS"``)
- raw datetime strings in `ISO format <https://en.wikipedia.org/wiki/ISO_8601>`__
(e.g. ``"YYYY-MM-DD"``, ``"YYYY-MM-DDTHH"``, and ``"YYYY-MM-DDTHH:MM:SS"``)
- Python built-in :class:`datetime.datetime` and :class:`datetime.date`

We can pass datetime inputs based on one of the types listed above directly to the ``x`` and ``y`` arguments
of e.g. the :meth:`pygmt.Figure.plot` method:
We can pass datetime inputs based on one of the types listed above directly to
the ``x`` and ``y`` parameters of e.g. the :meth:`pygmt.Figure.plot` method.

The ``region`` argument has to include the :math:`x` and :math:`y` axis limits as *str* in the form
*date_min/date_max/ymin/ymax*.
The ``region`` parameter has to include the :math:`x` and :math:`y` axis limits
in the form [*date_min*, *date_max*, *ymin*, *ymax*]. Here *date_min* and
*date_max* can be directly defined as datetime input.

"""

Expand All @@ -30,7 +32,9 @@
# create a basemap with limits of 2010-01-01 to 2020-06-01 on the x axis and
# 0 to 10 on the y axis
fig.basemap(
projection="X15c/5c", region="2010-01-01/2020-06-01/0/10", frame=["WSen", "af"]
projection="X15c/5c",
region=[datetime.date(2010, 1, 1), datetime.date(2020, 6, 1), 0, 10],
frame=["WSen", "af"],
)

# numpy.datetime64 types
Expand Down