duvals-triangle-plotter 1.0__py3-none-any.whl

duvals_triangle_plotter/__init__.py

@@ -0,0 +1 @@
+from .duvals_triangle_plotter import get_duval_points_traces, get_duvals_triangle_plot

duvals_triangle_plotter/__main__.py

@@ -0,0 +1,12 @@
+from .duvals_triangle_plotter import get_duval_points_traces, get_duvals_triangle_plot
+
+def main():
+    # Example usage
+    duval_points = [
+        get_duval_points_traces([0.09], [0.0], [0.91], "2000-08-16")
+    ]
+
+    get_duvals_triangle_plot(duval_points, show_plot=True)
+
+if __name__ == "__main__":
+    main()

duvals_triangle_plotter/constants.py

@@ -0,0 +1,115 @@
+"""
+Constants for Duval's Triangle Plot Configuration
+"""
+
+pd_region = {
+                # Get configuration for the PD (Partial Discharges) region in Duval's Triangle plot.
+                
+                "uid": "pd_region", 
+                "a": [98, 1, 98], # methane
+                "b": [0, 0, 2],   # acetylene
+                "c": [2, 0, 0],   # ethylene
+                "fill": "toself", 
+                "line": {"color": "#444"}, 
+                "mode": "lines", 
+                "text": "PD", 
+                "type": "scatterternary", 
+                "fillcolor": "#b3de69",
+                "name": "PD - Corona Partial Discharges"
+            }
+
+d1_region = {
+            # Get configuration for the D1 (Electrical Discharges of Low Energy) region in Duval's Triangle plot.
+
+            "uid": "d1_region", 
+            "a": [0, 0, 64, 87],  # methane
+            "b": [1, 77, 13, 13], # acetylene
+            "c": [0, 23, 23, 0],  # ethylene
+            "fill": "toself", 
+            "line": {"color": "#444"}, 
+            "mode": "lines", 
+            "text": "D1", 
+            "type": "scatterternary", 
+            "fillcolor": "#ffffb3",
+            "name": "D1 - Electrical Discharges of Low Energy"
+        }
+
+d2_region = {
+            # Get configuration for the D2 (Electrical Discharges of High Energy) region in Duval's Triangle plot.
+            "uid": "d2_region", 
+            "a": [0, 0, 31, 47, 64],    # methane
+            "b": [77, 29, 29, 13, 13],  # acetylene
+            "c": [23, 71, 40, 40, 23],  # ethylene
+            "fill": "toself", 
+            "line": {"color": "#444"}, 
+            "mode": "lines", 
+            "text": "D2", 
+            "type": "scatterternary", 
+            "fillcolor": "#bebada",
+            "name": "D2 - Electrical Discharges of High Energy"
+        }
+
+dt_region = {
+            # Get configuration for the DT (Electrical and Thermal Fault) region in Duval's Triangle plot.
+
+            "uid": "dt_region", 
+            "a": [0, 0, 35, 46, 96, 87, 47, 31],    # methane
+            "b": [29, 15, 15, 4, 4, 13, 13, 29],    # acetylene
+            "c": [71, 85, 50, 50, 0, 0, 40, 40],    # ethylene
+            "fill": "toself", 
+            "line": {"color": "#444"}, 
+            "mode": "lines", 
+            "text": "DT",
+            "hoverlabel": {"font": {"color": "black"}},
+            "type": "scatterternary", 
+            "fillcolor": "#fb8072",
+            "name": "DT - Electrical and Thermal Fault"
+        }
+
+t1_region = {
+            # Get configuration for the T1 (Thermal Faults, T<300 C) region in Duval's Triangle plot.
+   
+            "uid": "t1_region", 
+            "a": [76, 80, 98, 98, 96],  # methane
+            "b": [4, 0, 0, 2, 4],       # acetylene
+            "c": [20, 20, 2, 0, 0],     # ethylene
+            "fill": "toself", 
+            "line": {"color": "#444"}, 
+            "mode": "lines", 
+            "text": "T1", 
+            "type": "scatterternary", 
+            "fillcolor": "#80b1d3",
+            "name": "T1 - Thermal Faults, T<300C"
+        }
+
+t2_region = {
+            # Get configuration for the T2 (Thermal Faults, 300 C<T<700 C) region in Duval's Triangle plot.
+            "uid": "t2_region", 
+            "a": [46, 50, 80, 76],      # methane
+            "b": [4, 0, 0, 4],          # acetylene
+            "c": [50, 50, 20, 20],      # ethylene
+            "fill": "toself", 
+            "line": {"color": "#444"}, 
+            "mode": "lines", 
+            "text": "T2", 
+            "type": "scatterternary", 
+            "fillcolor": "#fdb462",
+            "name": "T2 - Thermal Faults, 300C<T<700C"
+        }
+
+t3_region = {
+            # Get configuration for the T3 (Thermal Faults, T>700 C) region in Duval's Triangle plot.
+            
+            "uid": "t3_region", 
+            "a": [0, 0, 50, 35],    # methane
+            "b": [15, 0, 0, 15],    # acetylene
+            "c": [85, 1, 50, 50],   # ethylene
+            "fill": "toself", 
+            "line": {"color": "#444"}, 
+            "mode": "lines", 
+            "text": "T3", 
+            "type": "scatterternary",
+            "fillcolor": "#8dd3c7",
+            "name": "T3",
+            "name": "T3 - Thermal Faults, T>700C"
+        }

duvals_triangle_plotter/duvals_triangle_plotter.py

@@ -0,0 +1,108 @@
+import plotly.graph_objects as go
+from duvals_triangle_plotter.constants import pd_region, d1_region, d2_region, dt_region, t1_region, t2_region, t3_region
+
+def get_layout(equipment_name: str):
+
+    """
+    Generate layout configuration for Duval's Triangle plot.
+
+    Parameters:
+    - equipment_name (str): The name of the equipment for which the Duval's Triangle is plotted.
+
+    Returns:
+    dict: A dictionary containing layout configuration for the Duval's Triangle plot.
+    """
+
+    layout = {
+                "title": "<b>Duval's Triangle (Dissolved Gas Analysis) for : {0}</b>".format(equipment_name), 
+                "width": 1044*1.8,  # adjust respectively
+                "height": 545*1.8,  # adjust respectively
+                "ternary": {
+                                "sum": 100, 
+                                "aaxis": {
+                                            "min": 0.01, 
+                                            "ticks": "outside", 
+                                            "title": "<b> CH4 (Methane) </b>", 
+                                            "linewidth": 8, 
+                                            "ticksuffix": "%",
+                                        }, 
+                                "baxis": {
+                                            "min": 0.01, 
+                                            "ticks": "outside", 
+                                            "title": "<b> C2H2 (Acetylene) </b>", 
+                                            "linewidth": 8, 
+                                            "ticksuffix": "%"
+                                        }, 
+                                "caxis": {
+                                            "min": 0.01, 
+                                            "ticks": "outside", 
+                                            "title": "<b> C2H4 (Ethylene) </b>", 
+                                            "linewidth": 8, 
+                                            "ticksuffix": "%"
+                                        }
+                }, 
+                "autosize": True, 
+                "showlegend": True,
+                "margin": {"pad":100},
+            }
+    return layout
+
+def get_duval_points_traces(methane_points_list: list, acetylene_points_list: list, ethylene_points_list: list, date: str):
+    
+    """
+    Get traces for Duval's Triangle points.
+
+    Parameters:
+    - methane_points_list (list): List of methane points where each element is concentration level of methane in ppm.
+    - acetylene_points_list (list): List of acetylene points where each element is concentration level of acetylene in ppm.
+    - ethylene_points_list (list): List of ethylene points where each element is concentration level of ethylene in ppm.
+    - date (str): Date associated with the samples.
+
+    Returns:
+    dict: A dictionary containing traces for Duval's Triangle points.
+    """
+
+    duval_points =  {
+                    "a": methane_points_list,       # methane
+                    "b": acetylene_points_list,     # acetylene
+                    "c": ethylene_points_list,      # ethylene
+                    "mode": "markers", 
+                    "type": "scatterternary", 
+                    "marker":   {
+                                    "size": 18,     # adjust respectively
+                                    "color": "black", 
+                                    "symbol": 217,  # a different symbol number would give a different marker style
+                                },
+                    "cliponaxis": True,
+                    "hovertemplate":  "Sample Date: {0}<br>".format(date) + "Methane (CH4): %{a:.2f}%<br>" + "Acetylene (C2H2): %{b:.2f}%<br>" + "Ethylene (C2H4): %{c:.2f}%<br>",
+                    "name": "Sample Date: {0}<br>".format(date)
+                }
+    
+    return duval_points
+
+def get_duvals_triangle_plot(duval_points_list: list, show_plot:bool = False, equipment_name:str = "General Site"):
+    
+    """
+    Generate Duval's Triangle plot.
+
+    Parameters:
+    - duval_points_list (list): List of Duval's Triangle points.
+    - show_plot (bool): Flag to determine whether to display the plot.
+    - equipment_name (str): Name of the equipment for which the plot is generated.
+
+    Returns:
+    go.Figure: A Plotly Figure containing Duval's Triangle plot.
+    """
+    
+    # print("The data of recieved duval_points_list: ", duval_points_list)
+
+    data = [pd_region, d1_region, d2_region, dt_region, t1_region, t2_region, t3_region]
+    data.extend(duval_points_list)
+    
+    fig = go.Figure(data=data, layout = get_layout(equipment_name))
+    fig.update_layout(get_layout(equipment_name))
+    
+    if show_plot:
+        fig.show()
+    
+    return fig

duvals_triangle_plotter-1.0.dist-info/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2023] [Subramanian Narayanan]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

duvals_triangle_plotter-1.0.dist-info/METADATA

@@ -0,0 +1,49 @@
+Metadata-Version: 2.1
+Name: duvals-triangle-plotter
+Version: 1.0
+Summary: Duval's Triangle Plotter - Python library for generating Duval's Triangle plots
+Home-page: https://github.com/yourusername/duvals_triangle_plotter
+Author: Subramanian Narayanan
+Author-email: your.email@example.com
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: plotly
+
+# Duval's Triangle Plotter
+
+Duval's Triangle Plotter is a Python library for generating Duval's Triangle plots, which are commonly used in Dissolved Gas Analysis (DGA) for monitoring power transformers.
+
+## Introduction
+
+Duval's Triangle is a graphical representation used in DGA to analyze the concentration levels of different gases, such as methane, acetylene, and ethylene, dissolved in transformer oil. This project provides a Python library that allows users to easily create Duval's Triangle plots for their DGA data.
+
+## Features
+
+- Generate Duval's Triangle plots with customizable configurations.
+- Plot various regions on Duval's Triangle, such as PD (Partial Discharges), D1, D2, DT, T1, T2, and T3.
+- Customize layout, colors, and symbols for better visualization.
+
+## Getting Started
+
+### Installation
+```bash
+pip install duvals-triangle-plotter
+```
+
+### Usage
+```python
+import duvals_triangle_plotter as dtp
+
+duval_points = [
+    dtp.get_duval_points_traces([0.09], [0.0], [0.91], "2000-08-16")
+]
+
+dtp.get_duvals_triangle_plot(duval_points, show_plot=True)
+```

duvals_triangle_plotter-1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+duvals_triangle_plotter/__init__.py,sha256=w3NtmtwdimbCsBQIjBMRdDUXDD9CHekGNn-l67nxyiY,86
+duvals_triangle_plotter/__main__.py,sha256=PIiQ3d9on5WkY4sqwiYe1mV6sgOB-HykP8mR072GLF4,325
+duvals_triangle_plotter/constants.py,sha256=Zl6O6yW6VvVrFiOnhGXoZhSv-Hv_cQuYu1P4pdXch9E,4351
+duvals_triangle_plotter/duvals_triangle_plotter.py,sha256=0W65FKtwqtkdm9jPWOzpoOL49VRqpq6eeR6DeSP1sgM,4842
+duvals_triangle_plotter-1.0.dist-info/LICENSE.txt,sha256=TDDGmMjhDJb7QywlzDHIGUpc5r6tTPcxVcW7hlWXl2U,1101
+duvals_triangle_plotter-1.0.dist-info/METADATA,sha256=0lWwZ99x2gKab53FRQfxOpWn-fJdb-T9C0EEl7q0k1w,1814
+duvals_triangle_plotter-1.0.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+duvals_triangle_plotter-1.0.dist-info/entry_points.txt,sha256=n6XLTHFDS-Oc4MZTS5Uf3WjUz_5Gp3_ChFXxfbsaJdg,82
+duvals_triangle_plotter-1.0.dist-info/top_level.txt,sha256=EYAYK9LA_S41GcGjJJyZkqn8Pa_9N6LH01X8_t3KhLI,24
+duvals_triangle_plotter-1.0.dist-info/RECORD,,

duvals_triangle_plotter-1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.41.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

duvals_triangle_plotter-1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+duvals_triangle_plotter = duvals_triangle_plotter.__main__:main

duvals_triangle_plotter-1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+duvals_triangle_plotter