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

DOC: cleanup calls to private methods _setup_plots in doctests #4181

Merged
merged 1 commit into from
Nov 6, 2022
Merged

DOC: cleanup calls to private methods _setup_plots in doctests #4181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions yt/visualization/plot_window.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -524,7 +524,7 @@ def set_mpl_projection(self, mpl_proj):
Assumes that the underlying data has a PlateCarree transform type.

To annotate the plot with coastlines or other annotations,
`_setup_plots()` will need to be called after this function
`render()` will need to be called after this function
to make the axes available for annotation.

Parameters
Expand Down Expand Up @@ -554,7 +554,7 @@ def set_mpl_projection(self, mpl_proj):
>>> ds = yt.load("")
>>> p = yt.SlicePlot(ds, "altitude", "AIRDENS")
>>> p.set_mpl_projection("AIRDENS", "Mollweide")
>>> p._setup_plots()
>>> p.render()
>>> p.plots["AIRDENS"].axes.coastlines()
>>> p.show()

Expand All @@ -567,7 +567,7 @@ def set_mpl_projection(self, mpl_proj):
>>> p.set_mpl_projection(
... "AIRDENS", ("PlateCarree", (), {"central_longitude": 90, "globe": None})
... )
>>> p._setup_plots()
>>> p.render()
>>> p.plots["AIRDENS"].axes.set_global()
>>> p.plots["AIRDENS"].axes.coastlines()
>>> p.show()
Expand All @@ -582,7 +582,7 @@ def set_mpl_projection(self, mpl_proj):
>>> ds = yt.load("")
>>> p = yt.SlicePlot(ds, "altitude", "AIRDENS")
>>> p.set_mpl_projection("RotatedPole", (177.5, 37.5))
>>> p._setup_plots()
>>> p.render()
>>> p.plots["AIRDENS"].axes.set_global()
>>> p.plots["AIRDENS"].axes.coastlines()
>>> p.show()
Expand All @@ -597,7 +597,7 @@ def set_mpl_projection(self, mpl_proj):
>>> p.set_mpl_projection(
... ("RotatedPole", (), {"pole_latitude": 37.5, "pole_longitude": 177.5})
... )
>>> p._setup_plots()
>>> p.render()
>>> p.plots["AIRDENS"].axes.set_global()
>>> p.plots["AIRDENS"].axes.coastlines()
>>> p.show()
Expand Down
27 changes: 12 additions & 15 deletions yt/visualization/tests/test_set_zlim.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,28 @@


def test_float_vmin_then_set_unit():
# this test doesn't represent how users should interact with plot containers
# in particular it uses the `_setup_plots()` private method, as a quick way to
# create a plot without having to make it an answer test
field = ("gas", "density")
ds = fake_amr_ds(fields=[field], units=["g/cm**3"])

p = SlicePlot(ds, "x", field)
p.set_buff_size(16)

p._setup_plots()
p.render()
cb = p.plots[field].image.colorbar
raw_lims = np.array((cb.vmin, cb.vmax))
desired_lims = raw_lims.copy()
desired_lims[0] = 1e-2

p.set_zlim(field, zmin=desired_lims[0])

p._setup_plots()
p.render()
cb = p.plots[field].image.colorbar
new_lims = np.array((cb.vmin, cb.vmax))
npt.assert_almost_equal(new_lims, desired_lims)

# 1 g/cm**3 == 1000 kg/m**3
p.set_unit(field, "kg/m**3")
p._setup_plots()
p.render()

cb = p.plots[field].image.colorbar
new_lims = np.array((cb.vmin, cb.vmax))
Expand All @@ -48,7 +45,7 @@ def test_set_unit_then_float_vmin():

p.set_unit(field, "kg/m**3")
p.set_zlim(field, zmin=1)
p._setup_plots()
p.render()
cb = p.plots[field].image.colorbar
assert cb.vmin == 1.0

Expand All @@ -60,7 +57,7 @@ def test_reset_zlim():
p = SlicePlot(ds, "x", field)
p.set_buff_size(16)

p._setup_plots()
p.render()
cb = p.plots[field].image.colorbar
raw_lims = np.array((cb.vmin, cb.vmax))

Expand All @@ -70,7 +67,7 @@ def test_reset_zlim():

# passing "min" should restore default limit
p.set_zlim(field, zmin="min")
p._setup_plots()
p.render()

cb = p.plots[field].image.colorbar
new_lims = np.array((cb.vmin, cb.vmax))
Expand All @@ -87,7 +84,7 @@ def test_set_dynamic_range_with_vmin():
zmin = 1e-2
p.set_zlim(field, zmin=zmin, dynamic_range=2)

p._setup_plots()
p.render()
cb = p.plots[field].image.colorbar
new_lims = np.array((cb.vmin, cb.vmax))
npt.assert_almost_equal(new_lims, (zmin, 2 * zmin))
Expand All @@ -103,7 +100,7 @@ def test_set_dynamic_range_with_vmax():
zmax = 1
p.set_zlim(field, zmax=zmax, dynamic_range=2)

p._setup_plots()
p.render()
cb = p.plots[field].image.colorbar
new_lims = np.array((cb.vmin, cb.vmax))
npt.assert_almost_equal(new_lims, (zmax / 2, zmax))
Expand All @@ -116,13 +113,13 @@ def test_set_dynamic_range_with_min():
p = SlicePlot(ds, "x", field)
p.set_buff_size(16)

p._setup_plots()
p.render()
cb = p.plots[field].image.colorbar
vmin = cb.vmin

p.set_zlim(field, zmin="min", dynamic_range=2)

p._setup_plots()
p.render()
cb = p.plots[field].image.colorbar
new_lims = np.array((cb.vmin, cb.vmax))
npt.assert_almost_equal(new_lims, (vmin, 2 * vmin))
Expand All @@ -135,7 +132,7 @@ def test_set_dynamic_range_with_None():
p = SlicePlot(ds, "x", field)
p.set_buff_size(16)

p._setup_plots()
p.render()
cb = p.plots[field].image.colorbar
vmin = cb.vmin

Expand All @@ -144,7 +141,7 @@ def test_set_dynamic_range_with_None():
):
p.set_zlim(field, zmin=None, dynamic_range=2)

p._setup_plots()
p.render()
cb = p.plots[field].image.colorbar
new_lims = np.array((cb.vmin, cb.vmax))
npt.assert_almost_equal(new_lims, (vmin, 2 * vmin))