direl-ts-tool-kit 0.4.4__tar.gz → 0.4.7__tar.gz

direl_ts_tool_kit-0.4.7/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: direl-ts-tool-kit
+Version: 0.4.7
+Summary: A toolbox for time series analysis and visualization.
+Home-page: https://gitlab.com/direl/direl_tool_kit
+Author: Diego Restrepo-Leal
+Author-email: diegorestrepoleal@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+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
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# direl-ts-tool-kit
+> A Toolbox for Time Series Analysis and Visualization
+
+A lightweight Python library developed to streamline common tasks in time series processing, including data preparation,
+visualization with a consistent aesthetic style, and handling irregular indices.
+
+## Key features and functions
+
+The library provides the following key functionalities, primarily centered around data preparation and plotting.
+
+### Data preparation and index management
+#### parse_datetime_index
+`parse_datetime_index(df_raw, date_column="date", format=None)`
+
+Parses a specified column into datetime objects and sets it as the DataFrame index.
+
+This function prepares raw data for time series analysis by ensuring the
+DataFrame is indexed by the correct datetime type.
+
+#### generate_dates
+`generate_dates(df_ts, freq="MS")`
+
+Generates a continuous DatetimeIndex covering the time span of the input DataFrame.
+
+The function determines the start and end dates from the existing DataFrame index
+and creates a new, regular date sequence based on the specified frequency.
+
+#### reindex_and_aggregate
+`reindex_and_aggregate(df_ts, column_name, freq="MS")`
+
+Re-indexes a time series DataFrame to a regular frequency, aggregates values,
+and introduces NaN for missing time steps.
+
+This function first identifies the time range from the original (potentially irregular)
+index, aggregates data if necessary (e.g., if multiple entries exist per time step),
+and then merges the data onto a complete date range, effectively filling gaps
+with NaN values.
+
+#### remove_outliers_by_threshold
+`remove_outliers_by_threshold(df_ts, column_name, lower_bound, upper_bound)`
+
+Replaces values in a specified column with NaN if they fall outside a defined range (outlier removal).
+
+This function identifies data points that are either below the lower
+bound or above the upper bound and treats them as missing data.
+
+
+### Visualization and styling
+
+#### plot_time_series
+`plot_time_series(df_ts, variable, units="", color="BLUE_LINES", time_unit="Year", rot=90, auto_format_label=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.
+
+#### save_figure
+`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}.

direl_ts_tool_kit-0.4.7/README.md

@@ -0,0 +1,65 @@
+# direl-ts-tool-kit
+> A Toolbox for Time Series Analysis and Visualization
+
+A lightweight Python library developed to streamline common tasks in time series processing, including data preparation,
+visualization with a consistent aesthetic style, and handling irregular indices.
+
+## Key features and functions
+
+The library provides the following key functionalities, primarily centered around data preparation and plotting.
+
+### Data preparation and index management
+#### parse_datetime_index
+`parse_datetime_index(df_raw, date_column="date", format=None)`
+
+Parses a specified column into datetime objects and sets it as the DataFrame index.
+
+This function prepares raw data for time series analysis by ensuring the
+DataFrame is indexed by the correct datetime type.
+
+#### generate_dates
+`generate_dates(df_ts, freq="MS")`
+
+Generates a continuous DatetimeIndex covering the time span of the input DataFrame.
+
+The function determines the start and end dates from the existing DataFrame index
+and creates a new, regular date sequence based on the specified frequency.
+
+#### reindex_and_aggregate
+`reindex_and_aggregate(df_ts, column_name, freq="MS")`
+
+Re-indexes a time series DataFrame to a regular frequency, aggregates values,
+and introduces NaN for missing time steps.
+
+This function first identifies the time range from the original (potentially irregular)
+index, aggregates data if necessary (e.g., if multiple entries exist per time step),
+and then merges the data onto a complete date range, effectively filling gaps
+with NaN values.
+
+#### remove_outliers_by_threshold
+`remove_outliers_by_threshold(df_ts, column_name, lower_bound, upper_bound)`
+
+Replaces values in a specified column with NaN if they fall outside a defined range (outlier removal).
+
+This function identifies data points that are either below the lower
+bound or above the upper bound and treats them as missing data.
+
+
+### Visualization and styling
+
+#### plot_time_series
+`plot_time_series(df_ts, variable, units="", color="BLUE_LINES", time_unit="Year", rot=90, auto_format_label=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.
+
+#### save_figure
+`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}.

{direl_ts_tool_kit-0.4.4 → direl_ts_tool_kit-0.4.7}/direl_ts_tool_kit/plot/plot_ts.py

@@ -26,7 +26,7 @@ def plot_time_series(
         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".
+        Options include 'Year', 'Month', 'Weekday', 'Day' or 'Hour'. Defaults to "Year".
     rot : int, optional
         Rotation angle (in degrees) for the x-axis tick labels. Defaults to 90.
     auto_format_label : bool, optional

{direl_ts_tool_kit-0.4.4 → direl_ts_tool_kit-0.4.7}/direl_ts_tool_kit/utilities/data_prep.py

@@ -114,13 +114,15 @@ def reindex_and_aggregate(df_ts, column_name, freq="MS"):
        implicitly after the `groupby`).
     """
 
-    date_aux = generate_dates(df_ts, freq="MS")
+    date_aux = generate_dates(df_ts, freq=freq)
     df_date = pd.DataFrame({"date_aux": date_aux})
     df_ts = df_ts.groupby(["date"]).sum().reset_index()
 
     result = pd.merge(df_ts, df_date, left_on="date", right_on="date_aux", how="outer")
     df_ts_new = result[["date_aux", column_name]]
-    df_ts_new.set_index(df_ts_new["date_aux"], inplace=True)
+    df_ts_new = df_ts_new.rename(columns={"date_aux": "date"})
+    df_ts_new.set_index(df_ts_new["date"], inplace=True)
+    df_ts_new.drop(columns=[df_ts_new.index.name], inplace=True)
     df_ts_new.notnull().apply(pd.Series.value_counts)
 
     return df_ts_new

direl_ts_tool_kit-0.4.7/direl_ts_tool_kit.egg-info/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: direl-ts-tool-kit
+Version: 0.4.7
+Summary: A toolbox for time series analysis and visualization.
+Home-page: https://gitlab.com/direl/direl_tool_kit
+Author: Diego Restrepo-Leal
+Author-email: diegorestrepoleal@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+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
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# direl-ts-tool-kit
+> A Toolbox for Time Series Analysis and Visualization
+
+A lightweight Python library developed to streamline common tasks in time series processing, including data preparation,
+visualization with a consistent aesthetic style, and handling irregular indices.
+
+## Key features and functions
+
+The library provides the following key functionalities, primarily centered around data preparation and plotting.
+
+### Data preparation and index management
+#### parse_datetime_index
+`parse_datetime_index(df_raw, date_column="date", format=None)`
+
+Parses a specified column into datetime objects and sets it as the DataFrame index.
+
+This function prepares raw data for time series analysis by ensuring the
+DataFrame is indexed by the correct datetime type.
+
+#### generate_dates
+`generate_dates(df_ts, freq="MS")`
+
+Generates a continuous DatetimeIndex covering the time span of the input DataFrame.
+
+The function determines the start and end dates from the existing DataFrame index
+and creates a new, regular date sequence based on the specified frequency.
+
+#### reindex_and_aggregate
+`reindex_and_aggregate(df_ts, column_name, freq="MS")`
+
+Re-indexes a time series DataFrame to a regular frequency, aggregates values,
+and introduces NaN for missing time steps.
+
+This function first identifies the time range from the original (potentially irregular)
+index, aggregates data if necessary (e.g., if multiple entries exist per time step),
+and then merges the data onto a complete date range, effectively filling gaps
+with NaN values.
+
+#### remove_outliers_by_threshold
+`remove_outliers_by_threshold(df_ts, column_name, lower_bound, upper_bound)`
+
+Replaces values in a specified column with NaN if they fall outside a defined range (outlier removal).
+
+This function identifies data points that are either below the lower
+bound or above the upper bound and treats them as missing data.
+
+
+### Visualization and styling
+
+#### plot_time_series
+`plot_time_series(df_ts, variable, units="", color="BLUE_LINES", time_unit="Year", rot=90, auto_format_label=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.
+
+#### save_figure
+`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}.

{direl_ts_tool_kit-0.4.4 → direl_ts_tool_kit-0.4.7}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="direl-ts-tool-kit",
-    version="0.4.4",
+    version="0.4.7",
     description="A toolbox for time series analysis and visualization.",
     long_description=open("README.md", encoding="utf-8").read(),
     long_description_content_type="text/markdown",

direl_ts_tool_kit-0.4.4/PKG-INFO

@@ -1,53 +0,0 @@
-Metadata-Version: 2.4
-Name: direl-ts-tool-kit
-Version: 0.4.4
-Summary: A toolbox for time series analysis and visualization.
-Home-page: https://gitlab.com/direl/direl_tool_kit
-Author: Diego Restrepo-Leal
-Author-email: diegorestrepoleal@gmail.com
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Intended Audience :: Science/Research
-Classifier: Topic :: Scientific/Engineering :: Visualization
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-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
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# direl-ts-tool-kit: A Toolbox for Time Series Analysis and Visualization
-A lightweight Python library developed to streamline common tasks in time series processing, including data preparation,
-visualization with a consistent aesthetic style, and handling irregular indices.
-
-## Key features and functions
-
-The library provides the following key functionalities, primarily centered around data preparation and plotting.
-
-### Data preparation and index management
-
-| Function                                          | Description                                                                                                                                                                                                       |
-|---------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| parse_datetime_index(df_raw, date_column, format) | Converts a specified column (defaults to "date") from a raw DataFrame into a proper DatetimeIndex. It handles specific format strings to ensure correct date parsing, and returns the cleaned, indexed DataFrame. |
-| generate_dates(df_ts, freq)                       | Creates a complete and regular pd.DatetimeIndex spanning from the first to the last date found in the input DataFrame's index. This is primarily used to define a target index for reindexing operations.         |
-| reindex_and_aggregate(df_ts, column_name)         | Aligns an irregularly indexed time series DataFrame to a regular frequency. It aggregates data within each time step (e.g., calculates the mean) and fills any resulting time gaps with NaN values.               |
-
-### Visualization and styling
-
-| Function                               | Description                                                                                                                                                                                                                                   |
-|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| plot_time_series(df_ts, variable, ...) | Generates a customizable time series plot using Matplotlib. It automatically handles x-axis localization based on time_unit (Year, Month, etc.), applies a consistent aesthetic style, and supports automatic formatting of the Y-axis label. |
-| paper_colors (Dictionary)              | A global dictionary containing a predefined palette of high-contrast, professional color codes (hex values). These color keys (e.g., "BLUE_LINES", "ORANGE_BARS") are used to ensure visual consistency across all generated plots.           |

direl_ts_tool_kit-0.4.4/README.md

@@ -1,22 +0,0 @@
-# direl-ts-tool-kit: A Toolbox for Time Series Analysis and Visualization
-A lightweight Python library developed to streamline common tasks in time series processing, including data preparation,
-visualization with a consistent aesthetic style, and handling irregular indices.
-
-## Key features and functions
-
-The library provides the following key functionalities, primarily centered around data preparation and plotting.
-
-### Data preparation and index management
-
-| Function                                          | Description                                                                                                                                                                                                       |
-|---------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| parse_datetime_index(df_raw, date_column, format) | Converts a specified column (defaults to "date") from a raw DataFrame into a proper DatetimeIndex. It handles specific format strings to ensure correct date parsing, and returns the cleaned, indexed DataFrame. |
-| generate_dates(df_ts, freq)                       | Creates a complete and regular pd.DatetimeIndex spanning from the first to the last date found in the input DataFrame's index. This is primarily used to define a target index for reindexing operations.         |
-| reindex_and_aggregate(df_ts, column_name)         | Aligns an irregularly indexed time series DataFrame to a regular frequency. It aggregates data within each time step (e.g., calculates the mean) and fills any resulting time gaps with NaN values.               |
-
-### Visualization and styling
-
-| Function                               | Description                                                                                                                                                                                                                                   |
-|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| plot_time_series(df_ts, variable, ...) | Generates a customizable time series plot using Matplotlib. It automatically handles x-axis localization based on time_unit (Year, Month, etc.), applies a consistent aesthetic style, and supports automatic formatting of the Y-axis label. |
-| paper_colors (Dictionary)              | A global dictionary containing a predefined palette of high-contrast, professional color codes (hex values). These color keys (e.g., "BLUE_LINES", "ORANGE_BARS") are used to ensure visual consistency across all generated plots.           |

direl_ts_tool_kit-0.4.4/direl_ts_tool_kit.egg-info/PKG-INFO

@@ -1,53 +0,0 @@
-Metadata-Version: 2.4
-Name: direl-ts-tool-kit
-Version: 0.4.4
-Summary: A toolbox for time series analysis and visualization.
-Home-page: https://gitlab.com/direl/direl_tool_kit
-Author: Diego Restrepo-Leal
-Author-email: diegorestrepoleal@gmail.com
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Intended Audience :: Science/Research
-Classifier: Topic :: Scientific/Engineering :: Visualization
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-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
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# direl-ts-tool-kit: A Toolbox for Time Series Analysis and Visualization
-A lightweight Python library developed to streamline common tasks in time series processing, including data preparation,
-visualization with a consistent aesthetic style, and handling irregular indices.
-
-## Key features and functions
-
-The library provides the following key functionalities, primarily centered around data preparation and plotting.
-
-### Data preparation and index management
-
-| Function                                          | Description                                                                                                                                                                                                       |
-|---------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| parse_datetime_index(df_raw, date_column, format) | Converts a specified column (defaults to "date") from a raw DataFrame into a proper DatetimeIndex. It handles specific format strings to ensure correct date parsing, and returns the cleaned, indexed DataFrame. |
-| generate_dates(df_ts, freq)                       | Creates a complete and regular pd.DatetimeIndex spanning from the first to the last date found in the input DataFrame's index. This is primarily used to define a target index for reindexing operations.         |
-| reindex_and_aggregate(df_ts, column_name)         | Aligns an irregularly indexed time series DataFrame to a regular frequency. It aggregates data within each time step (e.g., calculates the mean) and fills any resulting time gaps with NaN values.               |
-
-### Visualization and styling
-
-| Function                               | Description                                                                                                                                                                                                                                   |
-|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| plot_time_series(df_ts, variable, ...) | Generates a customizable time series plot using Matplotlib. It automatically handles x-axis localization based on time_unit (Year, Month, etc.), applies a consistent aesthetic style, and supports automatic formatting of the Y-axis label. |
-| paper_colors (Dictionary)              | A global dictionary containing a predefined palette of high-contrast, professional color codes (hex values). These color keys (e.g., "BLUE_LINES", "ORANGE_BARS") are used to ensure visual consistency across all generated plots.           |