quant-met 0.0.27__py3-none-any.whl → 0.1.1__py3-none-any.whl

quant_met/plotting/plotting.py

@@ -1,215 +0,0 @@
-# SPDX-FileCopyrightText: 2024 Tjark Sievers
-# SPDX-FileCopyrightText: 2025 Tjark Sievers
-#
-# SPDX-License-Identifier: MIT
-
-"""Methods for plotting data."""
-
-import matplotlib.axes
-import matplotlib.colors
-import matplotlib.figure
-import matplotlib.pyplot as plt
-import numpy as np
-import numpy.typing as npt
-from matplotlib.collections import Collection, LineCollection
-
-
-def format_plot(
-    ax: matplotlib.axes.Axes,
-) -> matplotlib.axes.Axes:
-    """Format the axis to the predefined style.
-
-    Parameters
-    ----------
-    ax : :class:`matplotlib.axes.Axes`
-
-    Returns
-    -------
-    :class:`matplotlib.axes.Axes`
-
-    """
-    ax.set_box_aspect(1)
-    ax.set_facecolor("lightgray")
-    ax.grid(visible=True)
-    ax.tick_params(axis="both", direction="in", bottom=True, top=True, left=True, right=True)
-
-    return ax
-
-
-def scatter_into_bz(
-    bz_corners: list[npt.NDArray[np.floating]],
-    k_points: npt.NDArray[np.floating],
-    data: npt.NDArray[np.floating] | None = None,
-    data_label: str | None = None,
-    fig_in: matplotlib.figure.Figure | None = None,
-    ax_in: matplotlib.axes.Axes | None = None,
-) -> matplotlib.figure.Figure:
-    """Scatter a list of points into the brillouin zone.
-
-    Parameters
-    ----------
-    bz_corners : list[:class:`numpy.ndarray`]
-        Corner points defining the brillouin zone.
-    k_points : :class:`numpy.ndarray`
-        List of k points.
-    data : :class:`numpy.ndarray`, optional
-        Data to put on the k points.
-    data_label : :class:`str`, optional
-        Label for the data.
-    fig_in : :class:`matplotlib.figure.Figure`, optional
-        Figure that holds the axes. If not provided, a new figure and ax is created.
-    ax_in : :class:`matplotlib.axes.Axes`, optional
-        Ax to plot the data in. If not provided, a new figure and ax is created.
-
-    Returns
-    -------
-    :obj:`matplotlib.figure.Figure`
-        Figure with the data plotted onto the axis.
-
-    """
-    if fig_in is None or ax_in is None:
-        fig, ax = plt.subplots()
-    else:
-        fig, ax = fig_in, ax_in
-
-    if data is not None:
-        x_coords, y_coords = zip(*k_points, strict=True)
-        scatter = ax.scatter(x=x_coords, y=y_coords, c=data, cmap="viridis")
-        fig.colorbar(scatter, ax=ax, fraction=0.046, pad=0.04, label=data_label)
-    else:
-        x_coords, y_coords = zip(*k_points, strict=True)
-        ax.scatter(x=x_coords, y=y_coords)
-
-    bz_corner_x, bz_corners_y = zip(*bz_corners, strict=True)
-    ax.scatter(x=bz_corner_x, y=bz_corners_y, alpha=0.8)
-    ax.set_aspect("equal", adjustable="box")
-    ax.set_xlabel(r"$k_x\ [1/a_0]$")
-    ax.set_ylabel(r"$k_y\ [1/a_0]$")
-
-    return fig
-
-
-def plot_bandstructure(
-    bands: npt.NDArray[np.floating],
-    k_point_list: npt.NDArray[np.floating],
-    ticks: list[float],
-    labels: list[str],
-    overlaps: npt.NDArray[np.floating] | None = None,
-    overlap_labels: list[str] | None = None,
-    fig_in: matplotlib.figure.Figure | None = None,
-    ax_in: matplotlib.axes.Axes | None = None,
-) -> matplotlib.figure.Figure:
-    """Plot bands along a k space path.
-
-    To have a plot that respects the distances in k space and generate everything that is needed for
-    plotting, use the function :func:`~quant_met.plotting.generate_bz_path`.
-
-    Parameters
-    ----------
-    bands : :class:`numpy.ndarray`
-    k_point_list : :class:`numpy.ndarray`
-        List of points to plot against. This is not a list of two-dimensional k-points!
-    ticks : list(float)
-        Position for ticks.
-    labels : list(str)
-        Labels on ticks.
-    overlaps : :class:`numpy.ndarray`, optional
-        Overlaps.
-    overlap_labels : list(str), optional
-        Labels to put on overlaps.
-    fig_in : :class:`matplotlib.figure.Figure`, optional
-        Figure that holds the axes. If not provided, a new figure and ax is created.
-    ax_in : :class:`matplotlib.axes.Axes`, optional
-        Ax to plot the data in. If not provided, a new figure and ax is created.
-
-    Returns
-    -------
-    :obj:`matplotlib.figure.Figure`
-        Figure with the data plotted onto the axis.
-
-    """
-    if fig_in is None or ax_in is None:
-        fig, ax = plt.subplots()
-    else:
-        fig, ax = fig_in, ax_in
-
-    ax.axhline(y=0, alpha=0.7, linestyle="--", color="black")
-
-    if overlaps is None:
-        for band in bands:
-            ax.plot(k_point_list, band)
-    else:
-        line = Collection()
-        for band, wx in zip(bands, overlaps, strict=True):
-            points = np.array([k_point_list, band]).T.reshape(-1, 1, 2)
-            segments = np.concatenate([points[:-1], points[1:]], axis=1)
-
-            norm = matplotlib.colors.Normalize(-1, 1)
-            lc = LineCollection(segments, cmap="seismic", norm=norm)
-            lc.set_array(wx)
-            lc.set_linewidth(2)
-            line = ax.add_collection(lc)
-
-        colorbar = fig.colorbar(line, fraction=0.046, pad=0.04, ax=ax)
-        color_ticks = [-1, 1]
-        colorbar.set_ticks(ticks=color_ticks, labels=overlap_labels)
-
-    ax.set_ylim(
-        top=float(np.max(bands) + 0.1 * np.max(bands)),
-        bottom=float(np.min(bands) - 0.1 * np.abs(np.min(bands))),
-    )
-    ax.set_xticks(ticks, labels)
-
-    ax = format_plot(ax)
-
-    ax.set_ylabel(r"$E\ [t]$")
-
-    return fig
-
-
-def plot_superfluid_weight(
-    x_data: npt.NDArray[np.floating],
-    sf_weight_geom: npt.NDArray[np.floating],
-    sf_weight_conv: npt.NDArray[np.floating],
-    fig_in: matplotlib.figure.Figure | None = None,
-    ax_in: matplotlib.axes.Axes | None = None,
-) -> matplotlib.figure.Figure:
-    """Plot superfluid weight against some parameter.
-
-    Parameters
-    ----------
-    x_data : :class:`numpy.ndarray`
-    sf_weight_geom : :class:`numpy.ndarray`
-    sf_weight_conv : :class:`numpy.ndarray`
-    fig_in : :class:`matplotlib.figure.Figure`, optional
-    ax_in : :class:`matplotlib.axes.Axes`, optional
-
-    Returns
-    -------
-    :obj:`matplotlib.figure.Figure`
-        Figure with the data plotted onto the axis.
-
-    """
-    if fig_in is None or ax_in is None:
-        fig, ax = plt.subplots()
-    else:
-        fig, ax = fig_in, ax_in
-
-    ax.fill_between(
-        x_data, 0, np.abs(sf_weight_geom), color="black", fc="#0271BB", label="geometric", hatch="-"
-    )
-    ax.fill_between(
-        x_data,
-        np.abs(sf_weight_geom),
-        np.abs(sf_weight_geom) + np.abs(sf_weight_conv),
-        color="black",
-        fc="#E2001A",
-        label="conventional",
-        hatch="//",
-    )
-    ax.plot(x_data, np.abs(sf_weight_geom) + np.abs(sf_weight_conv), "x--", color="black")
-
-    ax = format_plot(ax)
-    ax.set_ylabel(r"$D_S\ [t]$")
-
-    return fig

quant_met-0.0.27.dist-info/RECORD

@@ -1,33 +0,0 @@
-quant_met/__init__.py,sha256=gRG4ktbxayIWQc5JjSZcZaUpNhPhQ9CjZ1EbZthocaw,334
-quant_met/utils.py,sha256=evF4BBhfElXK0sj4eUTIfF_vRyyzW6XYK44VZaLexE8,2112
-quant_met/cli/__init__.py,sha256=OHV3Ia-aXPP2kGYoEQsSbqQaLMaOd07K7jdE-u6u2y0,299
-quant_met/cli/_utils.py,sha256=211xxeO1a24AGMg6H-7Ls3gJhjP54Tws7OTmzW2-Q0Q,986
-quant_met/cli/crit_temp.py,sha256=DVdxw_lLZPA7Eu_NvCKxcDLrKBJBOe0W6df4Js2Su9U,2072
-quant_met/cli/main.py,sha256=myDASJvAhFp5olOy0sbilijyCYkztUMUkPfAiblhTo0,1916
-quant_met/cli/scf.py,sha256=eU6h6BPqB19-1r2tGhHOhG_nT5xUxmu57uzlEDkicJs,2658
-quant_met/geometry/__init__.py,sha256=Cxp0-SnqgAwUov0z1xWJ3r2JCL1eiYOX96g73O4X8x4,637
-quant_met/geometry/base_lattice.py,sha256=OF6diQaryrm5RI7z8Eq-fYibzxaAriJSMQZItoi-qAw,2694
-quant_met/geometry/bz_path.py,sha256=HcBENq6LoGxZ8p3H6qMG-gmJ0H3oS5qpMv8T5Rm5aaw,2548
-quant_met/geometry/graphene.py,sha256=XikDAtNCCBHDbTEJXyu3U18I1adGEKek8B_ArridrpA,1672
-quant_met/geometry/square.py,sha256=DWNGRU2K0uXIKkIgDiY9dmXIfz5u3S2sQ950FTQCeWY,1610
-quant_met/mean_field/__init__.py,sha256=jDz2DU8D9WeRKu2fWtJMhxeVUg511LZDLBX9jH3dfrk,603
-quant_met/mean_field/_utils.py,sha256=wMF0dpVGVYsVjx7Brot7eqqyUqZrl03KUfF1nvCSTXA,401
-quant_met/mean_field/search_crit_temp.py,sha256=iEHAJFKuULUuZnoxHyyXIBUKLAVX44rZPLja4Wuavp0,8962
-quant_met/mean_field/self_consistency.py,sha256=1KQEhnCBrNYRzIj4TnC9sQPlp9hXR_jBPDA3VrGprPw,3444
-quant_met/mean_field/hamiltonians/__init__.py,sha256=bjbkP4kC9yuTAsRJnVSSMDdjvi8P0AQp_00Sg0JMIrs,726
-quant_met/mean_field/hamiltonians/base_hamiltonian.py,sha256=uEL4Nk7EdL8Bf73pDtw85JvfHPh2jlJQyq37GceT1iE,29385
-quant_met/mean_field/hamiltonians/dressed_graphene.py,sha256=e6m51P2JQvwUhx-OP7RIQfAZUQoNxeM0S9wpElBttT8,4093
-quant_met/mean_field/hamiltonians/graphene.py,sha256=bOIYGGoUwtqtWr1nqLD1lRKngjgtsmXVyxbig0luPeQ,3321
-quant_met/mean_field/hamiltonians/one_band_tight_binding.py,sha256=P0N6upQCloRCorrB-Tsapkc681hetLR3SgEB-cnS508,2557
-quant_met/mean_field/hamiltonians/three_band_tight_binding.py,sha256=6SWjjExppXURnsuRM8CX7rAKt-sxmgKBuOg2d4dzwdg,3340
-quant_met/mean_field/hamiltonians/two_band_tight_binding.py,sha256=PSX2TsS3J2afKvKcurwhq-2XC2gbIle3iN4hQM_lq9E,2910
-quant_met/parameters/__init__.py,sha256=8bTFW1owqGixUYjrT5K4XT5YTmrVtGlLS5UBHp7gnBA,1052
-quant_met/parameters/hamiltonians.py,sha256=FLfRpNX3uA0MV1e3Obyb_J7VM5xwk9E4z6NKMmFd6Cw,6091
-quant_met/parameters/main.py,sha256=j9-G-UgEuv9YYmDB7MPhlr67kpHhoCC5GtYN5FVkcgc,2370
-quant_met/plotting/__init__.py,sha256=PrGNm8fVY4WafQPiNgE22boaG7HXoeeG_u82jFv8Npg,568
-quant_met/plotting/plotting.py,sha256=vxfzYdrKIIrjC79GHb61AU_Ngu3TFrbOFujqsgitb0A,6637
-quant_met-0.0.27.dist-info/METADATA,sha256=Mohh2BTtINTLuG0S7uF6e_VSvpW7Zi85DL2r0Z1DUGU,2051
-quant_met-0.0.27.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-quant_met-0.0.27.dist-info/entry_points.txt,sha256=1Al3Kt-cMeQxwMp84ZSNL0qFwlbOVBu1o8A19MH8lEU,48
-quant_met-0.0.27.dist-info/licenses/LICENSE.txt,sha256=QO_duPQihSJlaxSLxPAXo52X3esROP5wBkhxqBd1Z4E,1104
-quant_met-0.0.27.dist-info/RECORD,,