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

direl_ts_tool_kit/__init__.py

@@ -1,2 +1,3 @@
 from .plot.plot_style import *
 from .plot.plot_ts import *
+from .utilities.data_prep import *

direl_ts_tool_kit/plot/plot_ts.py

@@ -41,6 +41,16 @@ def plot_time_series(
     -----
     Major grid lines are displayed with a dashed line ('--'), and minor grid
     lines are displayed with a dotted line (':') for detailed temporal analysis.
+
+        Available Colors
+    ----------------
+    The 'color' parameter accepts any key from the 'paper_colors' dictionary.
+
+    Lines: 'BLUE_LINES', 'ORANGE_LINES', 'GREEN_LINES', 'RED_LINES',
+           'GRAY_LINES', 'PURPLE_LINES', 'MAROON_LINES', 'GOLD_LINES'.
+
+    Bars:  'BLUE_BARS', 'ORANGE_BARS', 'GREEN_BARS', 'RED_BARS',
+           'GRAY_BARS', 'PURPLE_BARS', 'MAROON_BARS', 'GOLD_BARS'.
     """
 
     fig, ax = plt.subplots()
@@ -97,3 +107,43 @@ def plot_time_series(
     ax.grid(which="major", alpha=0.8, linestyle="--")
 
     return fig
+
+
+def save_figure(
+    fig,
+    file_name,
+    variable_name="",
+    path="./",
+):
+    """
+    Saves a Matplotlib figure in three common high-quality formats (PNG, PDF, SVG).
+
+    The function creates a consistent file name structure:
+    {path}/{file_name}_{variable_name}.{extension}.
+
+    Parameters
+    ----------
+    fig : matplotlib.figure.Figure
+        The Matplotlib figure object to be saved.
+    file_name : str
+        The primary name for the file (e.g., 'timeseries_report').
+    variable_name : str, optional
+        An optional secondary name, often the name of the plotted variable,
+        to be appended to the file name. Defaults to "".
+    path : str, optional
+        The directory path where the figure files will be saved.
+        Defaults to the current directory ('./').
+
+    Returns
+    -------
+    None
+    """
+
+    if variable_name:
+        base_name = f"{path}/{file_name}_{variable_name}"
+    else:
+        base_name = f"{path}/{file_name}"
+
+    fig.savefig(f"{base_name}.png")
+    fig.savefig(f"{base_name}.pdf")
+    fig.savefig(f"{base_name}.svg")

direl_ts_tool_kit/utilities/__init__.py

@@ -0,0 +1 @@
+from .data_prep import *

direl_ts_tool_kit/utilities/data_prep.py

@@ -0,0 +1,35 @@
+import pandas as pd
+
+
+def parse_datetime_index(df_raw, date_column="date"):
+    """
+    Parses a specified column into datetime objects and sets it as the DataFrame index.
+
+    This function is crucial for preparing raw data (df_raw) for time series analysis
+    by ensuring the DataFrame is indexed by the correct datetime type.
+
+    Parameters
+    ----------
+    df_raw : pd.DataFrame
+        The raw DataFrame containing the data, including the column with date strings.
+    date_column : str, optional
+        The name of the column in 'df_raw' that contains the date/time information.
+        Defaults to "date".
+
+    Returns
+    -------
+    df_ts : pd.DataFrame
+        A copy of the original DataFrame with the specified date column removed
+        and set as the DatetimeIndex. Ready for time series plotting.
+    original_dates : pd.Series
+        The original Series containing the date strings/objects, which was used
+        to create the new index.
+    """
+
+    date_parsed = pd.to_datetime(df_raw[date_column])
+    df_ts = df_raw.copy()
+    original_dates = df_raw[date_column]
+    df_ts.drop(columns=[date_column], inplace=True)
+    df_ts.set_index(date_parsed, inplace=True)
+
+    return df_ts, original_dates

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

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: direl-ts-tool-kit
-Version: 0.2.0
+Version: 0.2.2
 Summary: A toolbox for time series analysis and visualization.
 Home-page: https://gitlab.com/direl/direl_tool_kit
-Author: Tu Nombre Aquí
+Author: Diego Restrepo-Leal
 Author-email: diegorestrepoleal@gmail.com
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
@@ -17,6 +17,7 @@ License-File: LICENCE
 Requires-Dist: pandas>=1.0.0
 Requires-Dist: numpy>=1.18.0
 Requires-Dist: matplotlib>=3.0.0
+Requires-Dist: openpyxl
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

direl_ts_tool_kit-0.2.2.dist-info/RECORD

@@ -0,0 +1,11 @@
+direl_ts_tool_kit/__init__.py,sha256=W99Wd3BeEFKOxT51TApURElbDJvqIjD8u_-qDoCYSJ0,94
+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=uYkPWz-8aWIjZGW22n5uH19CYHv-bLGrZaHPW9f3-3I,4814
+direl_ts_tool_kit/utilities/__init__.py,sha256=jMtxYZUtwlhgI99sxe_8MMzsDnxtbTP7Ivh9tUOeIwQ,25
+direl_ts_tool_kit/utilities/data_prep.py,sha256=KqVICzfjvsQqbekYiL21MLdno6spjwzF2PXCv6D-kNc,1225
+direl_ts_tool_kit-0.2.2.dist-info/licenses/LICENCE,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+direl_ts_tool_kit-0.2.2.dist-info/METADATA,sha256=SwDvWNWSkGCfMnU6UlieG9lurQsvUZoeTxmFZjia-VA,950
+direl_ts_tool_kit-0.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+direl_ts_tool_kit-0.2.2.dist-info/top_level.txt,sha256=vMCRudnGnsdRg_6fUftnG8PF2Y1m0bjBDMf3pCAp6bc,18
+direl_ts_tool_kit-0.2.2.dist-info/RECORD,,

direl_ts_tool_kit-0.2.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-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,,