quant-met 0.0.26__py3-none-any.whl → 0.1.0__py3-none-any.whl

quant_met/plotting/plotting.py

@@ -1,214 +0,0 @@
-# SPDX-FileCopyrightText: 2024 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.26.dist-info/RECORD

@@ -1,37 +0,0 @@
-quant_met/__init__.py,sha256=ZO1UFz1awUYTI7B9ZkBwucvDz7GMGXnLLUGnEwLBhkc,155
-quant_met/utils.py,sha256=J3kCbKg0tPEoGJExX04QwifHn4ch482J8IcmRQxIfP4,2067
-quant_met/cli/__init__.py,sha256=nGFXhK8zWyEKQtsQTyJWfEOLFOHTCjZnfEcrVb2dARc,254
-quant_met/cli/_utils.py,sha256=MKHvkxudWH-px07lDz0_V1AWiCCvj_IsBYbocfL-r7Y,2036
-quant_met/cli/crit_temp.py,sha256=t9sPZKORl6dpa1UNAOMH2gDmeQxf80iFH7p_L3FI5q8,2027
-quant_met/cli/dmft.py,sha256=ct6e1Wd8o7V3VP7DB7pqPxyF5pbrR2mb-J8pUkP9UPE,3101
-quant_met/cli/main.py,sha256=1D1-KhGkzibts9b7Cv3JsR5Q-PnkowBWKE1Owc8tdD8,2010
-quant_met/cli/scf.py,sha256=3_rwtQHwypFjAwjrsO2r2sqjJKpNiDLAj6svU52CCcU,2613
-quant_met/dmft/__init__.py,sha256=2H0bN40Tvn-VnZgix6MugN0Q6iNwD_9AQxUC_LVLh70,99
-quant_met/dmft/dmft_loop.py,sha256=fH8v39I5yIY2iY5RaID43El1V0nxLewAfohNsq987_A,5272
-quant_met/dmft/utils.py,sha256=JO66kuTXruYCwNoVL0aFS55D3tV7Ii3v7hC9OpuWfF8,6636
-quant_met/geometry/__init__.py,sha256=2N8l0-2-PhEOQxaUO7e8Dqy5oaxt2y9343XENDTCGPE,592
-quant_met/geometry/base_lattice.py,sha256=OJNDMyzJB-0hK1BLgF-SV4jUYfOSUksIv1XG1bH-zyY,2649
-quant_met/geometry/bz_path.py,sha256=vwN5RxyrgFkHTSqm_6cWuOigICgxa-FX5NZ7SkgKScw,2503
-quant_met/geometry/graphene.py,sha256=ZLE55wV1E-jRCkGxW66pca2y5VWaNtMmXiXi-HB6bgs,1627
-quant_met/geometry/square.py,sha256=17XZH79lK9TeeDtXiBBa8rd2d9kv5yt2S9F6te0YZPU,1565
-quant_met/mean_field/__init__.py,sha256=Unweog9Tst1NxUMQ4X1OYiUQtyxI2ho-OQoCaekoMFk,597
-quant_met/mean_field/_utils.py,sha256=7hr0DDSdIqjft5Jjluvbw_HGoNLWgYJTxyuPJJvhBnc,356
-quant_met/mean_field/search_crit_temp.py,sha256=-A1ZegUOQXxh_SwmQeqMZCptnSLWuxDJsjdZK9XK-zE,8917
-quant_met/mean_field/self_consistency.py,sha256=YY_zhCurxOK3RLkK-Hglfkx33uhsvqpoAKOP4FuPdfo,3371
-quant_met/mean_field/hamiltonians/__init__.py,sha256=r-8TaLqRnRbAro-TMIyxzCCZHwVqyKrausODpQJb2tw,681
-quant_met/mean_field/hamiltonians/base_hamiltonian.py,sha256=0qRfSpiE5jybv4GmBGmuNKFl1fkE4fzXG15II1IyIu8,29374
-quant_met/mean_field/hamiltonians/dressed_graphene.py,sha256=Q5LiA3rgK88ZZV1V7JflgjlkEpve7uNZFzFCIoQND-w,4048
-quant_met/mean_field/hamiltonians/graphene.py,sha256=sa3H8jVq9Fkc_qcz5gJTCMgN8YD3N18JWLRBImhLyxo,3276
-quant_met/mean_field/hamiltonians/one_band_tight_binding.py,sha256=DZXaD95yWv1VZSMqgxkqEZv3PGihNGy7PuqupnN75ew,2512
-quant_met/mean_field/hamiltonians/three_band_tight_binding.py,sha256=g8XNImzCn_6CRYKDYI6sy3q6_TBYUDxDmQZ-AqenXTE,3295
-quant_met/mean_field/hamiltonians/two_band_tight_binding.py,sha256=DMySc94YQ1M2nPIKZjfc-Ax5Ysf7inwSuVKyd6dfqr0,2865
-quant_met/parameters/__init__.py,sha256=9yu7i0J-O3QxSicnLEh2ci7FSMwB8bPW0pbl8KWHJUs,1007
-quant_met/parameters/hamiltonians.py,sha256=PiWVV-miCdT4Z9GWloDVvIU_1QpRHHV-zVOga7DWwCw,6046
-quant_met/parameters/main.py,sha256=QP7Z24-QePMcy6txujqxbx5ztQTdC67m6elNsJtGtXQ,2325
-quant_met/plotting/__init__.py,sha256=IDgV6juJ0VfcJHppD-vnPH6w8wVuAC35eSeLxKzqyBc,523
-quant_met/plotting/plotting.py,sha256=4ZYclWJH3hlE8S7b7bL_JJlP3CKaCGcVzdIsqolCAaM,6592
-quant_met-0.0.26.dist-info/METADATA,sha256=rYIEO8Po6rucwi13B3pfOyZJgP4mso81gOfjYJYuosk,1978
-quant_met-0.0.26.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-quant_met-0.0.26.dist-info/entry_points.txt,sha256=1Al3Kt-cMeQxwMp84ZSNL0qFwlbOVBu1o8A19MH8lEU,48
-quant_met-0.0.26.dist-info/licenses/LICENSE.txt,sha256=QO_duPQihSJlaxSLxPAXo52X3esROP5wBkhxqBd1Z4E,1104
-quant_met-0.0.26.dist-info/RECORD,,