ultraplot 0.99.3__py3-none-any.whl

ultraplot/tests/test_projections.py

@@ -0,0 +1,138 @@
+#!/usr/bin/env python3
+"""
+Test projection features.
+"""
+import cartopy.crs as ccrs
+import matplotlib.pyplot as plt
+import numpy as np
+import ultraplot as pplt
+import pytest
+
+state = np.random.RandomState(51423)
+
+
+@pytest.mark.mpl_image_compare
+def test_aspect_ratios():
+    """
+    Test aspect ratio adjustments.
+    """
+    fig, axs = pplt.subplots(ncols=2)
+    axs[0].format(aspect=1.5)
+    fig, axs = pplt.subplots(ncols=2, proj=("cart", "cyl"), aspect=2)
+    axs[0].set_aspect(1)
+    return fig
+
+
+if pplt.internals._version_mpl <= "3.2":
+
+    @pytest.mark.mpl_image_compare
+    def test_basemap_labels():
+        """
+        Add basemap labels.
+        """
+        fig, axs = pplt.subplots(ncols=2, proj="robin", refwidth=3, basemap=True)
+        axs.format(coast=True, labels="rt")
+        return fig
+
+
+@pytest.mark.mpl_image_compare
+def test_cartopy_labels():
+    """
+    Add cartopy labels.
+    """
+    fig, axs = pplt.subplots(ncols=2, proj="robin", refwidth=3)
+    axs.format(coast=True, labels=True)
+    axs[0].format(inlinelabels=True)
+    axs[1].format(rotatelabels=True)
+    return fig
+
+
+@pytest.mark.mpl_image_compare
+def test_cartopy_contours():
+    """
+    Test bug with cartopy contours. Sometimes results in global coverage
+    with single color sometimes not.
+    """
+    N = 10
+    fig = plt.figure(figsize=(5, 2.5))
+    ax = fig.add_subplot(projection=ccrs.Mollweide())
+    ax.coastlines()
+    x = np.linspace(-180, 180, N)
+    y = np.linspace(-90, 90, N)
+    z = state.rand(N, N) * 10 - 5
+    m = ax.contourf(
+        x,
+        y,
+        z,
+        transform=ccrs.PlateCarree(),
+        cmap="RdBu_r",
+        vmin=-5,
+        vmax=5,
+    )
+    fig.colorbar(m, ax=ax)
+    fig = pplt.figure()
+    ax = fig.add_subplot(projection=pplt.Mollweide(), extent="auto")
+    ax.coastlines()
+    N = 10
+    m = ax.contourf(
+        np.linspace(0, 180, N),
+        np.linspace(0, 90, N)[1::2],
+        state.rand(N // 2, N) * 10 + 5,
+        cmap="BuRd",
+        transform=pplt.PlateCarree(),
+        edgefix=False,
+    )
+    fig.colorbar(m, ax=ax)
+    return fig
+
+
+@pytest.mark.mpl_image_compare
+def test_cartopy_manual():
+    """
+    Test alternative workflow without classes.
+    """
+    fig = pplt.figure()
+    proj = pplt.Proj("npstere")
+    # fig.add_axes([0.1, 0.1, 0.9, 0.9], proj='geo', map_projection=proj)
+    fig.add_subplot(111, proj="geo", land=True, map_projection=proj)
+    return fig
+
+
+@pytest.mark.mpl_image_compare
+def test_three_axes():
+    """
+    Test basic 3D axes here.
+    """
+    pplt.rc["tick.minor"] = False
+    fig, ax = pplt.subplots(proj="3d", outerpad=3)
+    return fig
+
+
+@pytest.mark.mpl_image_compare
+def test_projection_dicts():
+    """
+    Test projection dictionaries.
+    """
+    fig = pplt.figure(refnum=1)
+    a = [[1, 0], [1, 4], [2, 4], [2, 4], [3, 4], [3, 0]]
+    fig.subplots(a, proj={1: "cyl", 2: "cart", 3: "cart", 4: "cart"})
+    return fig
+
+
+@pytest.mark.mpl_image_compare
+def test_polar_projections():
+    """
+    Rigorously test polar features here.
+    """
+    fig, ax = pplt.subplots(proj="polar")
+    ax.format(
+        rlabelpos=45,
+        thetadir=-1,
+        thetalines=90,
+        thetalim=(0, 270),
+        theta0="N",
+        r0=0,
+        rlim=(0.5, 1),
+        rlines=0.25,
+    )
+    return fig

ultraplot/tests/test_statistical_plotting.py

@@ -0,0 +1,77 @@
+#!/usr/bin/env python3
+# import ultraplot as pplt
+import numpy as np, pandas as pd, ultraplot as pplt
+import pytest
+
+
+@pytest.mark.mpl_image_compare
+def test_statistical_boxplot():
+    # Sample data
+    N = 500
+    state = np.random.RandomState(51423)
+    data1 = state.normal(size=(N, 5)) + 2 * (state.rand(N, 5) - 0.5) * np.arange(5)
+    data1 = pd.DataFrame(data1, columns=pd.Index(list("abcde"), name="label"))
+    data2 = state.rand(100, 7)
+    data2 = pd.DataFrame(data2, columns=pd.Index(list("abcdefg"), name="label"))
+
+    # Figure
+    fig, axs = pplt.subplots([[1, 1, 2, 2], [0, 3, 3, 0]], span=False)
+    axs.format(abc="A.", titleloc="l", grid=False, suptitle="Boxes and violins demo")
+
+    # Box plots
+    ax = axs[0]
+    obj1 = ax.box(data1, means=True, marker="x", meancolor="r", fillcolor="gray4")
+    ax.format(title="Box plots")
+
+    # Violin plots
+    ax = axs[1]
+    obj2 = ax.violin(data1, fillcolor="gray6", means=True, points=100)
+    ax.format(title="Violin plots")
+
+    # Boxes with different colors
+    ax = axs[2]
+    ax.boxh(data2, cycle="pastel2")
+    ax.format(title="Multiple colors", ymargin=0.15)
+    return fig
+
+
+@pytest.mark.mpl_image_compare
+def test_panel_dist():
+    # Sample data
+    N = 500
+    state = np.random.RandomState(51423)
+    x = state.normal(size=(N,))
+    y = state.normal(size=(N,))
+    bins = pplt.arange(-3, 3, 0.25)
+
+    # Histogram with marginal distributions
+    fig, axs = pplt.subplots(ncols=2, refwidth=2.3)
+    axs.format(
+        abc="A.",
+        abcloc="l",
+        titleabove=True,
+        ylabel="y axis",
+        suptitle="Histograms with marginal distributions",
+    )
+    colors = ("indigo9", "red9")
+    titles = ("Group 1", "Group 2")
+    for ax, which, color, title in zip(axs, "lr", colors, titles):
+        ax.hist2d(
+            x,
+            y,
+            bins,
+            vmin=0,
+            vmax=10,
+            levels=50,
+            cmap=color,
+            colorbar="b",
+            colorbar_kw={"label": "count"},
+        )
+        color = pplt.scale_luminance(color, 1.5)  # histogram colors
+        px = ax.panel(which, space=0)
+        px.histh(y, bins, color=color, fill=True, ec="k")
+        px.format(grid=False, xlocator=[], xreverse=(which == "l"))
+        px = ax.panel("t", space=0)
+        px.hist(x, bins, color=color, fill=True, ec="k")
+        px.format(grid=False, ylocator=[], title=title, titleloc="l")
+    return fig

ultraplot/tests/test_subplots.py

@@ -0,0 +1,174 @@
+#!/usr/bin/env python3
+"""
+Test subplot layout.
+"""
+import numpy as np, ultraplot as pplt, pytest
+
+
+@pytest.mark.mpl_image_compare
+def test_align_labels():
+    """
+    Test spanning and aligned labels.
+    """
+    fig, axs = pplt.subplots(
+        [[2, 1, 4], [2, 3, 5]], refnum=2, refwidth=1.5, align=1, span=0
+    )
+    fig.format(xlabel="xlabel", ylabel="ylabel", abc="A.", abcloc="ul")
+    axs[0].format(ylim=(10000, 20000))
+    axs[-1].panel_axes("bottom", share=False)
+    return fig
+
+
+@pytest.mark.mpl_image_compare
+def test_share_all_basic():
+    """
+    Test sharing level all.
+    """
+    # Simple example
+    N = 10
+    fig, axs = pplt.subplots(nrows=1, ncols=2, refwidth=1.5, share="all")
+    axs[0].plot(np.arange(N) * 1e2, np.arange(N) * 1e4)
+    # Complex example
+    fig, axs = pplt.subplots(nrows=2, ncols=2, refwidth=1.5, share="all")
+    axs[0].panel("b")
+    pax = axs[0].panel("r")
+    pax.format(ylabel="label")
+    axs[0].plot(np.arange(N) * 1e2, np.arange(N) * 1e4)
+    return fig
+
+
+@pytest.mark.mpl_image_compare
+def test_span_labels():
+    """
+    Rigorous tests of spanning and aligned labels feature.
+    """
+    fig, axs = pplt.subplots([[1, 2, 4], [1, 3, 5]], refwidth=1.5, share=0, span=1)
+    fig.format(xlabel="xlabel", ylabel="ylabel", abc="A.", abcloc="ul")
+    axs[1].format()  # xlabel='xlabel')
+    axs[2].format()
+    return fig
+
+
+@pytest.mark.mpl_image_compare
+def test_title_deflection():
+    """
+    Test the deflection of titles above and below panels.
+    """
+    fig, ax = pplt.subplots()
+    # ax.format(abc='A.', title='Title', titleloc='left', titlepad=30)
+    tax = ax.panel_axes("top")
+    ax.format(titleabove=False)  # redirects to bottom
+    ax.format(abc="A.", title="Title", titleloc="left", titlepad=50)
+    ax.format(xlabel="xlabel", ylabel="ylabel", ylabelpad=50)
+    tax.format(title="Fear Me", title_kw={"size": "x-large"})
+    tax.format(ultitle="Inner", titlebbox=True, title_kw={"size": "med-large"})
+    return fig
+
+
+@pytest.mark.mpl_image_compare
+def test_complex_ticks():
+    """
+    Normally title offset with these different tick arrangements is tricky
+    but `_update_title_position` accounts for edge cases.
+    """
+    fig, axs = pplt.subplots(ncols=2)
+    axs[0].format(
+        xtickloc="both",
+        xticklabelloc="top",
+        xlabelloc="top",
+        title="title",
+        xlabel="xlabel",
+        suptitle="Test",
+    )
+    axs[1].format(
+        xtickloc="both",
+        xticklabelloc="top",
+        # xlabelloc='top',
+        xlabel="xlabel",
+        title="title",
+        suptitle="Test",
+    )
+    return fig
+
+
+@pytest.mark.mpl_image_compare
+def test_both_ticklabels():
+    """
+    Test both tick labels.
+    """
+    fig, ax = pplt.subplots()  # when both, have weird bug
+    ax.format(xticklabelloc="both", title="title", suptitle="Test")
+    fig, ax = pplt.subplots()  # when *just top*, bug disappears
+    ax.format(xtickloc="top", xticklabelloc="top", title="title", suptitle="Test")
+    fig, ax = pplt.subplots()  # not sure here
+    ax.format(xtickloc="both", xticklabelloc="neither", suptitle="Test")
+    fig, ax = pplt.subplots()  # doesn't seem to change the title offset though
+    ax.format(xtickloc="top", xticklabelloc="neither", suptitle="Test")
+    return fig
+
+
+def test_gridspec_copies():
+    """
+    Test whether gridspec copies work.
+    """
+    fig1, ax = pplt.subplots(ncols=2)
+    gs = fig1.gridspec.copy(left=5, wspace=0, right=5)
+    return fig1
+    fig2 = pplt.figure()
+    fig2.add_subplots(gs)
+    fig = pplt.figure()
+    with pytest.raises(ValueError):
+        fig.add_subplots(gs)  # should raise error
+
+
+@pytest.mark.mpl_image_compare
+def test_aligned_outer_guides():
+    """
+    Test alignment adjustment.
+    """
+    fig, ax = pplt.subplot()
+    h1 = ax.plot(np.arange(5), label="foo")
+    h2 = ax.plot(np.arange(5) + 1, label="bar")
+    h3 = ax.plot(np.arange(5) + 2, label="baz")
+    ax.legend(h1, loc="bottom", align="left")
+    ax.legend(h2, loc="bottom", align="right")
+    ax.legend(h3, loc="b", align="c")
+    ax.colorbar("magma", loc="right", align="top", shrink=0.4)  # same as length
+    ax.colorbar("magma", loc="right", align="bottom", shrink=0.4)
+    ax.colorbar("magma", loc="left", align="top", length=0.6)  # should offset
+    ax.colorbar("magma", loc="left", align="bottom", length=0.6)
+    ax.legend(h1, loc="top", align="right", pad="4pt", frame=False)
+    ax.format(title="Very long title", titlepad=6, titleloc="left")
+    return fig
+
+
+def test_reference_aspect():
+    """
+    Rigorous test of reference aspect ratio accuracy.
+    """
+    # A simple test
+    refwidth = 1.5
+    fig, axs = pplt.subplots(ncols=2, refwidth=refwidth)
+    fig.auto_layout()
+
+    assert np.isclose(refwidth, axs[fig._refnum - 1]._get_size_inches()[0])
+
+    # A test with funky layout
+    refwidth = 1.5
+    fig, axs = pplt.subplots([[1, 1, 2, 2], [0, 3, 3, 0]], ref=3, refwidth=refwidth)
+    axs[1].panel_axes("left")
+    axs.format(xlocator=0.2, ylocator=0.2)
+    fig.auto_layout()
+    assert np.isclose(refwidth, axs[fig._refnum - 1]._get_size_inches()[0])
+
+    # A test with panels
+    refwidth = 2.0
+    fig, axs = pplt.subplots(
+        [[1, 1, 2], [3, 4, 5], [3, 4, 6]], hratios=(2, 1, 1), refwidth=refwidth
+    )
+    axs[2].panel_axes("right", width=0.5)
+    axs[0].panel_axes("bottom", width=0.5)
+    axs[3].panel_axes("left", width=0.5)
+    fig.auto_layout()
+    assert np.isclose(refwidth, axs[fig._refnum - 1]._get_size_inches()[0])
+    return fig