Skip to content

Introducing astro_support, to enable time_support and quantity_support simultaneously #17575

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

Closed
spranav1205 wants to merge 24 commits into from
Closed

Introducing astro_support, to enable time_support and quantity_support simultaneously #17575

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
3819d1b
Introducing astro_support for quantity and time objects
spranav1205 Dec 22, 2024
c18fd55
Updated Docstring
spranav1205 Dec 22, 2024
98437d3
Formatting
spranav1205 Dec 22, 2024
c98b236
New module for astropy_support
spranav1205 Dec 23, 2024
5d730bf
Adding test for astropy_support
spranav1205 Dec 23, 2024
ae1d1ff
Changelog entry
spranav1205 Dec 23, 2024
07ada01
Formatting
spranav1205 Dec 24, 2024
9a100e5
Docstring edit
spranav1205 Dec 24, 2024
520529e
Docstring edit 2.0
spranav1205 Dec 24, 2024
60208c2
doc test correction
spranav1205 Dec 25, 2024
a1d03c8
Doc string changes 2.0
spranav1205 Dec 25, 2024
4d82d36
doc string 3.0
spranav1205 Dec 25, 2024
b8b402c
doc test 4.0
spranav1205 Dec 25, 2024
4f860cc
testing ..plot::
spranav1205 Dec 26, 2024
ba1c660
revising mistake
spranav1205 Dec 26, 2024
3ad0c25
Using other docstring example refs
spranav1205 Dec 26, 2024
277e452
Formatting
spranav1205 Dec 26, 2024
235bd4e
style 1.0
spranav1205 Dec 28, 2024
43652b8
style 2.0
spranav1205 Dec 28, 2024
9f00dc1
style 3.0
spranav1205 Dec 28, 2024
667f457
style (finally figured it out)
spranav1205 Dec 28, 2024
8f32067
Update astropy/tests/figures/py311-test-image-mpl360-cov.json
spranav1205 Jan 1, 2025
44f5abf
tests in alphabetical order
spranav1205 Jan 1, 2025
5830e98
Attempt to update the other JSON file
spranav1205 Jan 1, 2025
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
3 changes: 2 additions & 1 deletion astropy/tests/figures/py311-test-image-mpl360-cov.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,6 @@
"astropy.visualization.wcsaxes.tests.test_transform_coord_meta.TestTransformCoordMeta.test_coords_overlay_auto_coord_meta": "2f737bb70fb1a5452cb0efa79010376614dc559e9aff607f638f044ac6b04448",
"astropy.visualization.wcsaxes.tests.test_transform_coord_meta.TestTransformCoordMeta.test_direct_init": "1f24c5243bfdf0f30e88afc4f2f5d66db85954cea50a2910af94975ff8765b45",
"astropy.visualization.wcsaxes.tests.test_wcsapi.test_wcsapi_5d_with_names": "c90ae6f3b0f9f407ca7a866fa648dc3ef4bea78369315292bc82f16104ed5736",
"astropy.visualization.wcsaxes.tests.test_wcsapi.test_wcsapi_2d_celestial_arcsec": "4b743d645a85d7516decbcf4a831c127af5a1800072597c2a1299d17fb186adb"
"astropy.visualization.wcsaxes.tests.test_wcsapi.test_wcsapi_2d_celestial_arcsec": "4b743d645a85d7516decbcf4a831c127af5a1800072597c2a1299d17fb186adb",
"astropy.visualization.wcsaxes.tests.test_images.test_astropy_support": "aee3dd8cfc0998ec2d904549c6527fa55f3b16cbe9a30c222a2c0ac6a6db155e"
Copy link
Copy Markdown
Member

@pllim pllim Jan 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency with existing entries, I would still like this to be moved higher up (where other astropy.visualization.wcsaxes.tests.test_images entries are), ordered alphabetically if possible.

}
3 changes: 2 additions & 1 deletion astropy/tests/figures/py311-test-image-mpldev-cov.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,6 @@
"astropy.visualization.wcsaxes.tests.test_transform_coord_meta.TestTransformCoordMeta.test_coords_overlay_auto_coord_meta": "2f737bb70fb1a5452cb0efa79010376614dc559e9aff607f638f044ac6b04448",
"astropy.visualization.wcsaxes.tests.test_transform_coord_meta.TestTransformCoordMeta.test_direct_init": "1f24c5243bfdf0f30e88afc4f2f5d66db85954cea50a2910af94975ff8765b45",
"astropy.visualization.wcsaxes.tests.test_wcsapi.test_wcsapi_5d_with_names": "c90ae6f3b0f9f407ca7a866fa648dc3ef4bea78369315292bc82f16104ed5736",
"astropy.visualization.wcsaxes.tests.test_wcsapi.test_wcsapi_2d_celestial_arcsec": "4b743d645a85d7516decbcf4a831c127af5a1800072597c2a1299d17fb186adb"
"astropy.visualization.wcsaxes.tests.test_wcsapi.test_wcsapi_2d_celestial_arcsec": "4b743d645a85d7516decbcf4a831c127af5a1800072597c2a1299d17fb186adb",
"astropy.visualization.wcsaxes.tests.test_images.test_astropy_support": "aee3dd8cfc0998ec2d904549c6527fa55f3b16cbe9a30c222a2c0ac6a6db155e"
Copy link
Copy Markdown
Member

@pllim pllim Jan 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as https://github.com/astropy/astropy/pull/17575/files#r1904638767

}
44 changes: 44 additions & 0 deletions astropy/visualization/astropy_support.py
View file
Open in desktop
Copy link
Copy Markdown
Member

@pllim pllim Jan 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I cannot find any mention of this new module in https://astropy--17575.org.readthedocs.build/en/17575/visualization/ref_api.html , so none of this docstring is actually being rendered.

You might need to modify https://github.com/astropy/astropy/blob/main/astropy/visualization/__init__.py to fix this. Therefore, defining __all__ in this module is also very important, which I do not see here.

Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
from contextlib import ExitStack, contextmanager

from astropy.visualization.time import time_support
from astropy.visualization.units import quantity_support


@contextmanager
def astropy_support(*, quantity_support_kwargs=None, time_support_kwargs=None):
"""
Enable support for plotting `astropy.units.Quantity` and `astropy.time.Time` instances in
matplotlib.

It can be used as a decorator or with a ``with`` statement.
Copy link
Copy Markdown
Contributor

@neutrinoceros neutrinoceros Dec 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit, but I'd like the examples to be presented in the same order they are introduced in this sentence.
(out of scope here, but I'm also realizing that quantity_support and time_support's respective docstrings currently do not demonstrate the decorator style, although they both support it)

Copy link
Copy Markdown
Author

@spranav1205 spranav1205 Dec 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that makes sense. I've made the correction.
Maybe after this PR, another issue can be opened to fix quantity_support and time_support, and have all three in the same module.

Copy link
Copy Markdown
Contributor

@neutrinoceros neutrinoceros Dec 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thinkg that moving code around is rarely worth the cost of making git blame less useful. However, +1 on doing a follow up to complete docstrings !


Examples
--------

.. plot::
:include-source:

import matplotlib.pyplot as plt
import astropy.units as u
from astropy.time import Time
from astropy.visualization.astropy_support import astropy_support

@astropy_support()
def plot_example():
plt.figure()
plt.plot([1, 2, 3] * u.m)
plt.plot(Time(['2000-01-01', '2000-01-02', '2000-01-03']).plot_date)
plt.draw()
plt.show()

with astropy_support(): # doctest: +IGNORE_OUTPUT
plt.figure()
plt.plot([1, 2, 3] * u.m)
plt.plot(Time(['2000-01-01', '2000-01-02', '2000-01-03']).plot_date)
plt.draw()

"""
with ExitStack() as stack:
stack.enter_context(quantity_support(**(quantity_support_kwargs or {})))
stack.enter_context(time_support(**(time_support_kwargs or {})))
yield

Check warning on line 44 in astropy/visualization/astropy_support.py

View check run for this annotation

Codecov / codecov/patch

astropy/visualization/astropy_support.py#L41-L44 

Added lines #L41 - L44 were not covered by tests
29 changes: 29 additions & 0 deletions astropy/visualization/wcsaxes/tests/test_images.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@
)
from astropy.io import fits
from astropy.tests.figures import figure_test
from astropy.time import Time, TimeDelta
from astropy.utils import isiterable
from astropy.utils.data import get_pkg_data_filename
from astropy.utils.exceptions import AstropyUserWarning
from astropy.visualization.astropy_support import astropy_support
from astropy.visualization.wcsaxes import WCSAxes, add_beam, add_scalebar
from astropy.visualization.wcsaxes.frame import EllipticalFrame
from astropy.visualization.wcsaxes.patches import Quadrangle, SphericalCircle
Expand Down Expand Up @@ -1233,6 +1235,33 @@ def test_allsky_labels_wrap():
return fig


@figure_test(tolerance=1)
def test_astropy_support():
x_meters = np.linspace(1, 10, 50) * u.m # Distances in meters
x_kilometers = np.linspace(0.002, 0.011, 50) * u.km # Distances in kilometers

y_seconds = Time("2000-01-01T00:10:00", scale="utc") + TimeDelta(
np.linspace(0, 3600, 50), format="sec"
)

start_time = Time("2000-01-01T00:00:00", scale="utc")
end_time = start_time + TimeDelta(2 / 24, format="jd")

with astropy_support():
fig, ax = plt.subplots()

ax.plot(x_meters, y_seconds, label="Meters vs. Seconds")
ax.plot(x_kilometers, y_seconds, label="Kilometers vs. Seconds")

ax.set_ylim(start_time, Time((end_time), format="jd"))

ax.set_xlabel("Distance (m)")
ax.set_ylabel("Time")
ax.legend()

return fig


@figure_test
def test_tickable_gridlines():
wcs = WCS(
Expand Down
2 changes: 2 additions & 0 deletions docs/changes/visualization/17575.feature.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Added a new ``astropy_support`` context manager in ``astropy.visualization``.
This enables ``time_support`` and ``quantity_support`` for plotting ``astropy.units.Quantity`` and ``astropy.time.Time`` instances in matplotlib.