direl-ts-tool-kit 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

direl_ts_tool_kit/plot/__init__.py

@@ -0,0 +1,2 @@
+from .plot_style import *
+from .plot_ts import *

direl_ts_tool_kit/plot/plot_style.py

@@ -0,0 +1,48 @@
+import matplotlib.pyplot as plt
+import matplotlib.dates as mdates
+
+plt.style.use("fast")
+
+plt.rc("figure", autolayout=True, figsize=(12, 5))
+
+plt.rc(
+    "axes",
+    labelweight="bold",
+    labelsize=15,
+    titleweight="bold",
+    titlesize=14,
+    titlepad=10,
+    facecolor="white",
+)
+
+plt.rc("xtick", labelsize=15)
+plt.rc("ytick", labelsize=15)
+plt.rc("legend", fontsize=10)
+
+plot_params = {
+    "color": "0.75",
+    "style": ".-",
+    "markeredgecolor": "0.25",
+    "markerfacecolor": "0.25",
+    "legend": False,
+}
+
+
+paper_colors = {
+    "BLUE_LINES": "#396AB1",
+    "ORANGE_LINES": "#DA7C30",
+    "GREEN_LINES": "#3E9651",
+    "RED_LINES": "#CC2529",
+    "GRAY_LINES": "#535154",
+    "PURPLE_LINES": "#6B4C9A",
+    "MAROON_LINES": "#922428",
+    "GOLD_LINES": "#948B3D",
+    "BLUE_BARS": "#7293CB",
+    "ORANGE_BARS": "#E1974C",
+    "GREEN_BARS": "#84BA5B",
+    "RED_BARS": "#D35E60",
+    "GRAY_BARS": "#808585",
+    "PURPLE_BARS": "#90679D",
+    "MAROON_BARS": "#AB6857",
+    "GOLD_BARS": "#CCC210",
+}

direl_ts_tool_kit/plot/plot_ts.py

@@ -0,0 +1,99 @@
+from .plot_style import *
+
+
+def plot_time_series(
+    df1, variable, units="", color="BLUE_LINES", time_unit="Year", rot=90, method=True
+):
+    """
+    Plots a time series with custom styling and dual-level grid visibility.
+
+    This function automatically sets major and minor time-based locators
+    on the x-axis based on the specified time unit, and formats the y-axis
+    to use scientific notation.
+
+    Parameters
+    ----------
+    df1 : pd.DataFrame
+        The DataFrame containing the time series data. Must have a DatetimeIndex.
+    variable : str
+        The name of the column to plot. The label is automatically formatted
+        (e.g., 'total_sales' becomes 'Total Sales').
+    units : str, optional
+        Units to display next to the variable name on the y-axis (e.g., 'USD').
+        Defaults to "".
+    color : str, optional
+        Key corresponding to the line color in the global 'paper_colors' dictionary.
+        Defaults to "BLUE_LINES".
+    time_unit : str, optional
+        The time granularity of the data to define x-axis tick locators.
+        Options include 'Year', 'Month', 'Weekday', or 'Day'. Defaults to "Year".
+    rot : int, optional
+        Rotation angle (in degrees) for the x-axis tick labels. Defaults to 90.
+    method : bool, optional
+        Used internally for label formatting logic. Defaults to True.
+
+    Returns
+    -------
+    matplotlib.figure.Figure
+        The generated matplotlib figure object.
+
+    Notes
+    -----
+    Major grid lines are displayed with a dashed line ('--'), and minor grid
+    lines are displayed with a dotted line (':') for detailed temporal analysis.
+    """
+
+    fig, ax = plt.subplots()
+    ax.plot(df1.index, df1[variable], linewidth=3, color=paper_colors[color])
+
+    if "-" in variable:
+        variable = "-".join(
+            [
+                j.title() if i == 0 else j.lower()
+                for i, j in enumerate(variable.split("-"))
+            ]
+        )
+    elif "_" in variable:
+        variable = " ".join(
+            [
+                j.title() if i == 0 else j.lower()
+                for i, j in enumerate(variable.split("_"))
+            ]
+        )
+    else:
+        variable = (
+            " ".join(
+                [
+                    j.title() if i == 0 else j.lower()
+                    for i, j in enumerate(variable.split())
+                ]
+            )
+            if method
+            else variable
+        )
+
+    ax.set(xlabel=f"{time_unit}", ylabel=f"{variable} {units}")
+    ax.ticklabel_format(style="sci", axis="y", scilimits=(0, 0))
+
+    if time_unit == "Year":
+        ax.xaxis.set_major_locator(mdates.YearLocator())
+        ax.xaxis.set_minor_locator(mdates.MonthLocator())
+
+    if time_unit == "Month":
+        ax.xaxis.set_major_locator(mdates.MonthLocator())
+        ax.xaxis.set_minor_locator(mdates.WeekdayLocator())
+
+    if time_unit == "Weekday":
+        ax.xaxis.set_major_locator(mdates.WeekdayLocator())
+        ax.xaxis.set_minor_locator(mdates.DayLocator())
+
+    if time_unit == "Day":
+        ax.xaxis.set_major_locator(mdates.DayLocator())
+        ax.xaxis.set_minor_locator(mdates.HourLocator())
+
+    ax.tick_params(axis="x", rotation=rot)
+    ax.grid(which="both")
+    ax.grid(which="minor", alpha=0.6, linestyle=":")
+    ax.grid(which="major", alpha=0.8, linestyle="--")
+
+    return fig

{direl_ts_tool_kit-0.1.0.dist-info → direl_ts_tool_kit-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: direl-ts-tool-kit
-Version: 0.1.0
+Version: 0.2.0
 Summary: A toolbox for time series analysis and visualization.
 Home-page: https://gitlab.com/direl/direl_tool_kit
 Author: Tu Nombre Aquí

direl_ts_tool_kit-0.2.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+direl_ts_tool_kit/__init__.py,sha256=E7sCCqFQm9KG6fdpVX7vdVK1QIMPlygEyS_6hqpN1Bw,59
+direl_ts_tool_kit/plot/__init__.py,sha256=CMwyv-kiE74nwr3MJPL7gWIJmcfZ8UQCRu7mBGGQ4rI,49
+direl_ts_tool_kit/plot/plot_style.py,sha256=vhzcDa3LzgkHuy-GnliofGZ8TDntkm3_1C5kgl2Gx3E,1010
+direl_ts_tool_kit/plot/plot_ts.py,sha256=MopIqV4uBaJ9wCdjOhuKaiW5McmXejoA2Co46DzAiIQ,3334
+direl_ts_tool_kit-0.2.0.dist-info/licenses/LICENCE,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+direl_ts_tool_kit-0.2.0.dist-info/METADATA,sha256=D0pY1HYO1EClxT0wlr9i1urdHWNjYoIpY_KRuJuEu2E,922
+direl_ts_tool_kit-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+direl_ts_tool_kit-0.2.0.dist-info/top_level.txt,sha256=vMCRudnGnsdRg_6fUftnG8PF2Y1m0bjBDMf3pCAp6bc,18
+direl_ts_tool_kit-0.2.0.dist-info/RECORD,,

direl_ts_tool_kit-0.1.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-direl_ts_tool_kit/__init__.py,sha256=E7sCCqFQm9KG6fdpVX7vdVK1QIMPlygEyS_6hqpN1Bw,59
-direl_ts_tool_kit-0.1.0.dist-info/licenses/LICENCE,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-direl_ts_tool_kit-0.1.0.dist-info/METADATA,sha256=T5LKz-k7EKvd1Le2R9-wgRFiq0x67e9F6vKGnF4G0Fw,922
-direl_ts_tool_kit-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-direl_ts_tool_kit-0.1.0.dist-info/top_level.txt,sha256=vMCRudnGnsdRg_6fUftnG8PF2Y1m0bjBDMf3pCAp6bc,18
-direl_ts_tool_kit-0.1.0.dist-info/RECORD,,