pyretailscience 0.1.2__tar.gz → 0.2.0__tar.gz

{pyretailscience-0.1.2 → pyretailscience-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyretailscience
-Version: 0.1.2
+Version: 0.2.0
 Summary: Retail Data Science Tools
 License: Elastic-2.0
 Author: Murray Vanwyk

{pyretailscience-0.1.2 → pyretailscience-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyretailscience"
-version = "0.1.2"
+version = "0.2.0"
 description = "Retail Data Science Tools"
 authors = ["Murray Vanwyk <2493311+mvanwyk@users.noreply.github.com>"]
 readme = "README.md"

pyretailscience-0.2.0/pyretailscience/customer.py

@@ -0,0 +1,351 @@
+import matplotlib.pyplot as plt
+import matplotlib.ticker as mtick
+import pandas as pd
+from matplotlib.axes import Axes, SubplotBase
+
+from pyretailscience.data.contracts import TransactionItemLevelContract
+from pyretailscience.style.graph_utils import human_format, standard_graph_styles
+from pyretailscience.style.tailwind import COLORS
+import operator
+
+
+class PurchasesPerCustomer:
+    """A class to plot the distribution of the number of purchases per customer.
+
+    Attributes:
+        cust_purchases_s (pd.Series): The number of purchases per customer.
+
+    Args:
+        df (pd.DataFrame): A dataframe with the transaction data. The dataframe must comply with the
+            TransactionItemLevelContract.
+    """
+
+    def __init__(self, df: pd.DataFrame) -> None:
+        if TransactionItemLevelContract(df).validate() is False:
+            raise ValueError("The dataframe does not comply with the TransactionItemLevelContract")
+
+        self.cust_purchases_s = df.groupby("customer_id").size()
+
+    def plot(
+        self,
+        bins: int = 10,
+        cumlative: bool = False,
+        ax: Axes | None = None,
+        draw_percentile_line: bool = False,
+        percentile_line: float = 0.5,
+        source_text: str = None,
+        **kwargs: dict[str, any],
+    ) -> SubplotBase:
+        """Plot the distribution of the number of purchases per customer.
+
+        Args:
+            bins (int, optional): The number of bins to plot. Defaults to 10.
+            cumlative (bool, optional): Whether to plot the cumulative distribution. Defaults to False.
+            ax (Axes, optional): The Matplotlib axes to plot the graph on. Defaults to None.
+            draw_percentile_line (bool, optional): Whether to draw a line at the percentile specified with
+                the `percentile_line` paramter. Defaults to False.
+            percentile_line (float, optional): The percentile to draw a line at. Defaults to 0.8.
+
+        Returns:
+            SubplotBase: The Matplotlib axes of the plot
+        """
+
+        density = False
+        if cumlative:
+            density = True
+
+        ax = self.cust_purchases_s.hist(
+            bins=bins,
+            cumulative=cumlative,
+            ax=ax,
+            density=density,
+            color=COLORS["green"][500],
+            **kwargs,
+        )
+        ax.set_xlabel("Number of purchases")
+        ax.xaxis.set_major_formatter(lambda x, pos: human_format(x, pos, decimals=0))
+
+        ax = standard_graph_styles(ax)
+
+        if cumlative:
+            plt.title("Number of Purchases Cumulative Distribution")
+            plt.ylabel("Percentage of customers")
+            ax.yaxis.set_major_formatter(mtick.PercentFormatter(xmax=1, decimals=0))
+
+        else:
+            plt.title("Number of Purchases Distribution")
+            plt.ylabel("Number of customers")
+            ax.yaxis.set_major_formatter(lambda x, pos: human_format(x, pos, decimals=0))
+
+        if draw_percentile_line:
+            if percentile_line > 1 or percentile_line < 0:
+                raise ValueError("Percentile line must be between 0 and 1")
+            ax.axvline(
+                x=self.purchases_percentile(percentile_line),
+                color=COLORS["red"][500],
+                linestyle="--",
+                lw=2,
+                label=f"{percentile_line:.1%} of customers",
+            )
+            ax.legend(frameon=False)
+
+        if source_text:
+            ax.annotate(
+                source_text,
+                xy=(-0.1, -0.2),
+                xycoords="axes fraction",
+                ha="left",
+                va="center",
+                fontsize=10,
+            )
+
+        return ax
+
+    def purchases_percentile(self, percentile: float = 0.5) -> float:
+        """Get the number of purchases at a given percentile.
+
+        Args:
+            percentile (float): The percentile to get the number of purchases at.
+
+        Returns:
+            float: The number of purchases at the given percentile.
+        """
+        return self.cust_purchases_s.quantile(percentile)
+
+    def find_purchase_percentile(self, number_of_purchases: int, comparison: str = "less_than_equal_to") -> float:
+        """Find the percentile of the number of purchases.
+
+        Args:
+            number_of_purchases (int): The number of purchases to find the percentile of.
+
+        Returns:
+            float: The percentile of the number of purchases.
+        """
+        ops = {
+            "less_than": operator.lt,
+            "less_than_equal_to": operator.le,
+            "equal_to": operator.eq,
+            "not_equal_to": operator.ne,
+            "greater_than": operator.gt,
+            "greater_than_equal_to": operator.ge,
+        }
+
+        if comparison not in ops:
+            raise ValueError(
+                "Comparison must be one of 'less_than', 'less_than_equal_to', 'equal_to', 'not_equal_to', "
+                "'greater_than', 'greater_than_equal_to'"
+            )
+
+        return len(self.cust_purchases_s[ops[comparison](self.cust_purchases_s, number_of_purchases)]) / len(
+            self.cust_purchases_s
+        )
+
+
+class DaysBetweenPurchases:
+    """A class to plot the distribution of the average number of days between purchases per customer.
+
+    Attributes:
+        purchase_dist_s (pd.Series): The average number of days between purchases per customer.
+
+    Args:
+        df (pd.DataFrame): A dataframe with the transaction data. The dataframe must comply with the
+            TransactionItemLevelContract.
+
+    Raises:
+        ValueError: If the dataframe does not comply with the TransactionItemLevelContract
+    """
+
+    def __init__(self, df: pd.DataFrame) -> None:
+        if TransactionItemLevelContract(df).validate() is False:
+            raise ValueError("The dataframe does not comply with the TransactionItemLevelContract")
+
+        purchase_dist_df = df[["customer_id", "transaction_datetime"]].copy()
+        purchase_dist_df["transaction_datetime"] = df["transaction_datetime"].dt.floor("D")
+        purchase_dist_df = purchase_dist_df.drop_duplicates().sort_values(["customer_id", "transaction_datetime"])
+        purchase_dist_df["diff"] = purchase_dist_df.groupby("customer_id")["transaction_datetime"].transform(
+            lambda x: x.diff()
+        )
+        purchase_dist_df = purchase_dist_df[~purchase_dist_df["diff"].isnull()]
+        purchase_dist_df["diff"] = purchase_dist_df["diff"].dt.days
+        self.purchase_dist_s = purchase_dist_df.groupby("customer_id")["diff"].mean()
+
+    def plot(
+        self,
+        bins: int = 10,
+        cumlative: bool = False,
+        ax: Axes | None = None,
+        draw_percentile_line: bool = False,
+        percentile_line: float = 0.5,
+        source_text: str = None,
+        **kwargs: dict[str, any],
+    ) -> SubplotBase:
+        """Plot the distribution of the average number of days between purchases per customer.
+
+        Args:
+            bins (int, optional): The number of bins to plot. Defaults to 10.
+            cumlative (bool, optional): Whether to plot the cumulative distribution. Defaults to False.
+            ax (Axes, optional): The Matplotlib axes to plot the graph on. Defaults to None.
+            draw_percentile_line (bool, optional): Whether to draw a line at the percentile specified with
+                the `percentile_line` paramter. Defaults to False.
+            percentile_line (float, optional): The percentile to draw a line at. Defaults to 0.8.
+
+        Returns:
+            SubplotBase: The Matplotlib axes of the plot
+        """
+        density = False
+        if cumlative:
+            density = True
+
+        ax = self.purchase_dist_s.hist(
+            bins=bins,
+            cumulative=cumlative,
+            ax=ax,
+            density=density,
+            color=COLORS["green"][500],
+            **kwargs,
+        )
+        plt.xlabel("Average Number of Days Between Purchases")
+        ax.xaxis.set_major_formatter(lambda x, pos: human_format(x, pos, decimals=0))
+
+        ax = standard_graph_styles(ax)
+
+        if cumlative:
+            plt.title("Average Days Between Purchases Cumulative Distribution")
+            plt.ylabel("Percentage of Customers")
+            ax.yaxis.set_major_formatter(mtick.PercentFormatter(xmax=1, decimals=0))
+
+        else:
+            plt.title("Average Days Between Purchases Distribution")
+            plt.ylabel("Number of Customers")
+            ax.yaxis.set_major_formatter(lambda x, pos: human_format(x, pos, decimals=0))
+
+        if draw_percentile_line:
+            if percentile_line > 1 or percentile_line < 0:
+                raise ValueError("Percentile line must be between 0 and 1")
+            ax.axvline(
+                x=self.purchases_percentile(percentile_line),
+                color=COLORS["red"][500],
+                linestyle="--",
+                lw=2,
+                label=f"{percentile_line:.1%} of customers",
+                ymax=0.96,
+            )
+            ax.legend(frameon=False)
+
+        if source_text:
+            ax.annotate(
+                source_text,
+                xy=(-0.1, -0.2),
+                xycoords="axes fraction",
+                ha="left",
+                va="center",
+                fontsize=10,
+            )
+
+        return ax
+
+    def purchases_percentile(self, percentile: float = 0.5) -> float:
+        """Get the average number of days between purchases at a given percentile.
+
+        Args:
+            percentile (float): The percentile to get the average number of days between purchases at.
+
+        Returns:
+            float: The average number of days between purchases at the given percentile.
+        """
+        return self.purchase_dist_s.quantile(percentile)
+
+
+class TransactionChurn:
+    """A class to plot the churn rate by number of purchases.
+
+    Attributes:
+        purchase_dist_df (pd.DataFrame): The churn rate by number of purchases.
+        n_unique_customers (int): The number of unique customers in the dataframe.
+
+    Args:
+        df (pd.DataFrame): A dataframe with the transaction data. The dataframe must comply with the
+            TransactionItemLevelContract.
+        churn_period (float): The number of days to consider a customer churned.
+    """
+
+    def __init__(self, df: pd.DataFrame, churn_period: float) -> None:
+        if TransactionItemLevelContract(df).validate() is False:
+            raise ValueError("The dataframe does not comply with the TransactionItemLevelContract")
+
+        purchase_dist_df = df[["customer_id", "transaction_datetime"]].copy()
+        # Truncate the transaction_datetime to the day
+        purchase_dist_df["transaction_datetime"] = df["transaction_datetime"].dt.floor("D")
+        purchase_dist_df = purchase_dist_df.drop_duplicates()
+        purchase_dist_df = purchase_dist_df.sort_values(["customer_id", "transaction_datetime"])
+        purchase_dist_df["transaction_number"] = purchase_dist_df.groupby("customer_id").cumcount() + 1
+
+        purchase_dist_df["last_transaction"] = (
+            purchase_dist_df.groupby("customer_id")["transaction_datetime"].shift(-1).isna()
+        )
+        purchase_dist_df["transaction_before_churn_window"] = purchase_dist_df["transaction_datetime"] < (
+            purchase_dist_df["transaction_datetime"].max() - pd.Timedelta(days=churn_period)
+        )
+        purchase_dist_df["churned"] = (
+            purchase_dist_df["last_transaction"] & purchase_dist_df["transaction_before_churn_window"]
+        )
+
+        purchase_dist_df = (
+            purchase_dist_df[purchase_dist_df["transaction_before_churn_window"]]
+            .groupby(["transaction_number"])["churned"]
+            .value_counts()
+            .unstack()
+        )
+        purchase_dist_df.columns = ["retained", "churned"]
+        purchase_dist_df["churned_pct"] = purchase_dist_df["churned"].div(purchase_dist_df.sum(axis=1))
+        self.purchase_dist_df = purchase_dist_df
+
+        self.n_unique_customers = df["customer_id"].nunique()
+
+    def plot(
+        self,
+        cumlative: bool = False,
+        ax: Axes | None = None,
+        source_text: str = None,
+        **kwargs: dict[str, any],
+    ) -> SubplotBase:
+        """Plot the churn rate by number of purchases.
+
+        Args:
+            cumlative (bool, optional): Whether to plot the cumulative distribution. Defaults to False.
+            ax (Axes, optional): The Matplotlib axes to plot the graph on. Defaults to None.
+
+        Returns:
+            SubplotBase: The Matplotlib axes of the plot
+        """
+        if cumlative:
+            cumulative_churn_rate_s = self.purchase_dist_df["churned"].cumsum().div(self.n_unique_customers)
+            ax = cumulative_churn_rate_s.plot.area(color=COLORS["green"][500])
+            ax.set_xlim(self.purchase_dist_df.index.min(), self.purchase_dist_df.index.max())
+        else:
+            ax = self.purchase_dist_df["churned_pct"].plot.bar(
+                rot=0,
+                color=COLORS["green"][500],
+                width=0.8,
+                **kwargs,
+            )
+
+        standard_graph_styles(ax)
+
+        # Format y axis as a percent
+        ax.yaxis.set_major_formatter(mtick.PercentFormatter(xmax=1.0))
+        ax.set_xlabel("Number of Purchases")
+        ax.set_ylabel("% Churned")
+        ax.set_title("Churn Rate by Number of Purchases")
+
+        if source_text:
+            ax.annotate(
+                source_text,
+                xy=(-0.1, -0.2),
+                xycoords="axes fraction",
+                ha="left",
+                va="center",
+                fontsize=10,
+            )
+
+        return ax

{pyretailscience-0.1.2 → pyretailscience-0.2.0}/pyretailscience/data/simulation.py

@@ -1,8 +1,9 @@
+from __future__ import annotations
+
 import logging
 import uuid
 from dataclasses import dataclass
 from datetime import date, datetime, time, timedelta
-from typing import Self
 
 import numpy as np
 import pandas as pd
@@ -318,7 +319,7 @@ class Simulation:
         self.transactions = []
 
     @classmethod
-    def from_config_file(cls, seed: int, config_file: str) -> Self:
+    def from_config_file(cls, seed: int, config_file: str) -> Simulation:
         """Create a Simulation from a config file.
 
         Args:

pyretailscience-0.2.0/pyretailscience/style/graph_utils.py

@@ -0,0 +1,37 @@
+from matplotlib.axes import Axes
+
+
+def human_format(num, pos=None, decimals=0, prefix="") -> str:
+    """Format a number in a human readable format for Matplotlib.
+
+    Args:
+        num (float): The number to format.
+        pos (int, optional): The position. Defaults to None. Only used for Matplotlib compatibility.
+        decimals (int, optional): The number of decimals. Defaults to 0.
+        prefix (str, optional): The prefix of the returned string, eg '$'. Defaults to "".
+
+    Returns:
+        str: The formatted number.
+    """
+    magnitude = 0
+    while abs(num) >= 1000:
+        magnitude += 1
+        num /= 1000.0
+
+    # Add more suffixes if you need them
+    return f"{prefix}%.{decimals}f%s" % (num, ["", "K", "M", "G", "T", "P"][magnitude])
+
+
+def standard_graph_styles(ax: Axes) -> Axes:
+    """Apply standard styles to a Matplotlib graph.
+
+    Args:
+        ax (Axes): The graph to apply the styles to.
+
+    Returns:
+        Axes: The graph with the styles applied.
+    """
+    ax.spines[["top", "right"]].set_visible(False)
+    ax.grid(which="major", axis="x", color="#DAD8D7", alpha=0.5, zorder=1)
+    ax.grid(which="major", axis="y", color="#DAD8D7", alpha=0.5, zorder=1)
+    return ax

pyretailscience-0.2.0/pyretailscience/style/tailwind.py

@@ -0,0 +1,386 @@
+from matplotlib.colors import ListedColormap
+from matplotlib.colors import LinearSegmentedColormap
+
+# Colors from Tailwind CSS
+# https://raw.githubusercontent.com/tailwindlabs/tailwindcss/a1e74f055b13a7ef5775bdd72a77a4d397565016/src/public/colors.js
+COLORS = {
+    "slate": {
+        50: "#f8fafc",
+        100: "#f1f5f9",
+        200: "#e2e8f0",
+        300: "#cbd5e1",
+        400: "#94a3b8",
+        500: "#64748b",
+        600: "#475569",
+        700: "#334155",
+        800: "#1e293b",
+        900: "#0f172a",
+        950: "#020617",
+    },
+    "gray": {
+        50: "#f9fafb",
+        100: "#f3f4f6",
+        200: "#e5e7eb",
+        300: "#d1d5db",
+        400: "#9ca3af",
+        500: "#6b7280",
+        600: "#4b5563",
+        700: "#374151",
+        800: "#1f2937",
+        900: "#111827",
+        950: "#030712",
+    },
+    "zinc": {
+        50: "#fafafa",
+        100: "#f4f4f5",
+        200: "#e4e4e7",
+        300: "#d4d4d8",
+        400: "#a1a1aa",
+        500: "#71717a",
+        600: "#52525b",
+        700: "#3f3f46",
+        800: "#27272a",
+        900: "#18181b",
+        950: "#09090b",
+    },
+    "neutral": {
+        50: "#fafafa",
+        100: "#f5f5f5",
+        200: "#e5e5e5",
+        300: "#d4d4d4",
+        400: "#a3a3a3",
+        500: "#737373",
+        600: "#525252",
+        700: "#404040",
+        800: "#262626",
+        900: "#171717",
+        950: "#0a0a0a",
+    },
+    "stone": {
+        50: "#fafaf9",
+        100: "#f5f5f4",
+        200: "#e7e5e4",
+        300: "#d6d3d1",
+        400: "#a8a29e",
+        500: "#78716c",
+        600: "#57534e",
+        700: "#44403c",
+        800: "#292524",
+        900: "#1c1917",
+        950: "#0c0a09",
+    },
+    "red": {
+        50: "#fef2f2",
+        100: "#fee2e2",
+        200: "#fecaca",
+        300: "#fca5a5",
+        400: "#f87171",
+        500: "#ef4444",
+        600: "#dc2626",
+        700: "#b91c1c",
+        800: "#991b1b",
+        900: "#7f1d1d",
+        950: "#450a0a",
+    },
+    "orange": {
+        50: "#fff7ed",
+        100: "#ffedd5",
+        200: "#fed7aa",
+        300: "#fdba74",
+        400: "#fb923c",
+        500: "#f97316",
+        600: "#ea580c",
+        700: "#c2410c",
+        800: "#9a3412",
+        900: "#7c2d12",
+        950: "#431407",
+    },
+    "amber": {
+        50: "#fffbeb",
+        100: "#fef3c7",
+        200: "#fde68a",
+        300: "#fcd34d",
+        400: "#fbbf24",
+        500: "#f59e0b",
+        600: "#d97706",
+        700: "#b45309",
+        800: "#92400e",
+        900: "#78350f",
+        950: "#451a03",
+    },
+    "yellow": {
+        50: "#fefce8",
+        100: "#fef9c3",
+        200: "#fef08a",
+        300: "#fde047",
+        400: "#facc15",
+        500: "#eab308",
+        600: "#ca8a04",
+        700: "#a16207",
+        800: "#854d0e",
+        900: "#713f12",
+        950: "#422006",
+    },
+    "lime": {
+        50: "#f7fee7",
+        100: "#ecfccb",
+        200: "#d9f99d",
+        300: "#bef264",
+        400: "#a3e635",
+        500: "#84cc16",
+        600: "#65a30d",
+        700: "#4d7c0f",
+        800: "#3f6212",
+        900: "#365314",
+        950: "#1a2e05",
+    },
+    "green": {
+        50: "#f0fdf4",
+        100: "#dcfce7",
+        200: "#bbf7d0",
+        300: "#86efac",
+        400: "#4ade80",
+        500: "#22c55e",
+        600: "#16a34a",
+        700: "#15803d",
+        800: "#166534",
+        900: "#14532d",
+        950: "#052e16",
+    },
+    "emerald": {
+        50: "#ecfdf5",
+        100: "#d1fae5",
+        200: "#a7f3d0",
+        300: "#6ee7b7",
+        400: "#34d399",
+        500: "#10b981",
+        600: "#059669",
+        700: "#047857",
+        800: "#065f46",
+        900: "#064e3b",
+        950: "#022c22",
+    },
+    "teal": {
+        50: "#f0fdfa",
+        100: "#ccfbf1",
+        200: "#99f6e4",
+        300: "#5eead4",
+        400: "#2dd4bf",
+        500: "#14b8a6",
+        600: "#0d9488",
+        700: "#0f766e",
+        800: "#115e59",
+        900: "#134e4a",
+        950: "#042f2e",
+    },
+    "cyan": {
+        50: "#ecfeff",
+        100: "#cffafe",
+        200: "#a5f3fc",
+        300: "#67e8f9",
+        400: "#22d3ee",
+        500: "#06b6d4",
+        600: "#0891b2",
+        700: "#0e7490",
+        800: "#155e75",
+        900: "#164e63",
+        950: "#083344",
+    },
+    "sky": {
+        50: "#f0f9ff",
+        100: "#e0f2fe",
+        200: "#bae6fd",
+        300: "#7dd3fc",
+        400: "#38bdf8",
+        500: "#0ea5e9",
+        600: "#0284c7",
+        700: "#0369a1",
+        800: "#075985",
+        900: "#0c4a6e",
+        950: "#082f49",
+    },
+    "blue": {
+        50: "#eff6ff",
+        100: "#dbeafe",
+        200: "#bfdbfe",
+        300: "#93c5fd",
+        400: "#60a5fa",
+        500: "#3b82f6",
+        600: "#2563eb",
+        700: "#1d4ed8",
+        800: "#1e40af",
+        900: "#1e3a8a",
+        950: "#172554",
+    },
+    "indigo": {
+        50: "#eef2ff",
+        100: "#e0e7ff",
+        200: "#c7d2fe",
+        300: "#a5b4fc",
+        400: "#818cf8",
+        500: "#6366f1",
+        600: "#4f46e5",
+        700: "#4338ca",
+        800: "#3730a3",
+        900: "#312e81",
+        950: "#1e1b4b",
+    },
+    "violet": {
+        50: "#f5f3ff",
+        100: "#ede9fe",
+        200: "#ddd6fe",
+        300: "#c4b5fd",
+        400: "#a78bfa",
+        500: "#8b5cf6",
+        600: "#7c3aed",
+        700: "#6d28d9",
+        800: "#5b21b6",
+        900: "#4c1d95",
+        950: "#2e1065",
+    },
+    "purple": {
+        50: "#faf5ff",
+        100: "#f3e8ff",
+        200: "#e9d5ff",
+        300: "#d8b4fe",
+        400: "#c084fc",
+        500: "#a855f7",
+        600: "#9333ea",
+        700: "#7e22ce",
+        800: "#6b21a8",
+        900: "#581c87",
+        950: "#3b0764",
+    },
+    "fuchsia": {
+        50: "#fdf4ff",
+        100: "#fae8ff",
+        200: "#f5d0fe",
+        300: "#f0abfc",
+        400: "#e879f9",
+        500: "#d946ef",
+        600: "#c026d3",
+        700: "#a21caf",
+        800: "#86198f",
+        900: "#701a75",
+        950: "#4a044e",
+    },
+    "pink": {
+        50: "#fdf2f8",
+        100: "#fce7f3",
+        200: "#fbcfe8",
+        300: "#f9a8d4",
+        400: "#f472b6",
+        500: "#ec4899",
+        600: "#db2777",
+        700: "#be185d",
+        800: "#9d174d",
+        900: "#831843",
+        950: "#500724",
+    },
+    "rose": {
+        50: "#fff1f2",
+        100: "#ffe4e6",
+        200: "#fecdd3",
+        300: "#fda4af",
+        400: "#fb7185",
+        500: "#f43f5e",
+        600: "#e11d48",
+        700: "#be123c",
+        800: "#9f1239",
+        900: "#881337",
+        950: "#4c0519",
+    },
+}
+
+
+def get_color_list(name):
+    if name not in COLORS:
+        raise ValueError(f"Color name {name} not found. Valid colors are: {', '.join(COLORS.keys())}")
+    return [COLORS[name][key] for key in COLORS[name].keys()]
+
+
+def get_listed_cmap(name):
+    return ListedColormap(get_color_list(name))
+
+
+def get_linear_cmap(name):
+    return LinearSegmentedColormap.from_list(f"{name}_linear_colormap", get_color_list(name))
+
+
+def get_base_cmap() -> ListedColormap:
+    color_order = [
+        "red",
+        "orange",
+        "yellow",
+        "green",
+        "teal",
+        "sky",
+        "indigo",
+        "purple",
+        "pink",
+        "slate",
+        "amber",
+        "lime",
+        "emerald",
+        "cyan",
+        "blue",
+        "violet",
+        "fuchsia",
+        "rose",
+    ]
+    color_numbers = [500, 300, 700]
+    colors = []
+    for color_number in color_numbers:
+        for color in color_order:
+            colors.append(COLORS[color][color_number])
+
+    return ListedColormap(colors)
+
+
+slate_cmap = get_listed_cmap("slate")
+gray_cmap = get_listed_cmap("gray")
+zinc_cmap = get_listed_cmap("zinc")
+neutral_cmap = get_listed_cmap("neutral")
+stone_cmap = get_listed_cmap("stone")
+red_cmap = get_listed_cmap("red")
+orange_cmap = get_listed_cmap("orange")
+amber_cmap = get_listed_cmap("amber")
+yellow_cmap = get_listed_cmap("yellow")
+lime_cmap = get_listed_cmap("lime")
+green_cmap = get_listed_cmap("green")
+emerald_cmap = get_listed_cmap("emerald")
+teal_cmap = get_listed_cmap("teal")
+cyan_cmap = get_listed_cmap("cyan")
+sky_cmap = get_listed_cmap("sky")
+blue_cmap = get_listed_cmap("blue")
+indigo_cmap = get_listed_cmap("indigo")
+violet_cmap = get_listed_cmap("violet")
+purple_cmap = get_listed_cmap("purple")
+fuchsia_cmap = get_listed_cmap("fuchsia")
+pink_cmap = get_listed_cmap("pink")
+
+
+slate_linear_cmap = get_linear_cmap("slate")
+gray_linear_cmap = get_linear_cmap("gray")
+zinc_linear_cmap = get_linear_cmap("zinc")
+neutral_linear_cmap = get_linear_cmap("neutral")
+stone_linear_cmap = get_linear_cmap("stone")
+red_linear_cmap = get_linear_cmap("red")
+orange_linear_cmap = get_linear_cmap("orange")
+amber_linear_cmap = get_linear_cmap("amber")
+yellow_linear_cmap = get_linear_cmap("yellow")
+lime_linear_cmap = get_linear_cmap("lime")
+green_linear_cmap = get_linear_cmap("green")
+emerald_linear_cmap = get_linear_cmap("emerald")
+teal_linear_cmap = get_linear_cmap("teal")
+cyan_linear_cmap = get_linear_cmap("cyan")
+sky_linear_cmap = get_linear_cmap("sky")
+blue_linear_cmap = get_linear_cmap("blue")
+indigo_linear_cmap = get_linear_cmap("indigo")
+violet_linear_cmap = get_linear_cmap("violet")
+purple_linear_cmap = get_linear_cmap("purple")
+fuchsia_linear_cmap = get_linear_cmap("fuchsia")
+pink_linear_cmap = get_linear_cmap("pink")
+
+
+base_cmap = get_base_cmap()