topologicpy 0.4.36__tar.gz → 0.4.38__tar.gz

{topologicpy-0.4.36/src/topologicpy.egg-info → topologicpy-0.4.38}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: topologicpy
-Version: 0.4.36
+Version: 0.4.38
 Summary: An Advanced Spatial Modelling and Analysis Software Library for Architecture, Engineering, and Construction.
 Author-email: Wassim Jabi <wassim.jabi@gmail.com>
 Project-URL: Homepage, https://github.com/wassimj/TopologicPy

{topologicpy-0.4.36 → topologicpy-0.4.38}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=61"]
 build-backend = "setuptools.build_meta"
 [project]
 name = "topologicpy"
-version = "0.4.36"
+version = "0.4.38"
 authors = [
   { name="Wassim Jabi", email="wassim.jabi@gmail.com" },
 ]

{topologicpy-0.4.36 → topologicpy-0.4.38}/src/topologicpy/Color.py

@@ -157,6 +157,33 @@ class Color:
             rgbList.append(alpha)
         return rgbList
     
+    @staticmethod
+    def HEXToRGB(hex_color):
+        """
+        Converts a hexadecimal color string to RGB color values.
+
+        Parameters
+        ----------
+        hex_color : str
+            A hexadecimal color string in the format '#RRGGBB'.
+
+        Returns
+        -------
+        tuple
+            A tuple containing three integers representing the RGB values.
+
+        """
+        
+        hex_color = hex_color.lstrip('#')
+        if len(hex_color) != 6:
+            raise ValueError("Invalid hexadecimal color format. It should be a 6-digit hex value.")
+        
+        r = int(hex_color[0:2], 16)
+        g = int(hex_color[2:4], 16)
+        b = int(hex_color[4:6], 16)
+        
+        return (r, g, b)
+
     @staticmethod
     def PlotlyColor(color, alpha=1.0, useAlpha=False):
         """
@@ -189,3 +216,23 @@ class Color:
         if useAlpha:
             return "rgba("+str(color[0])+","+str(color[1])+","+str(color[2])+","+str(alpha)+")"
         return "rgb("+str(color[0])+","+str(color[1])+","+str(color[2])+")"
+    
+    @staticmethod
+    def RGBToHex(rgb):
+        """
+        Converts RGB color values to a hexadecimal color string.
+
+        Parameters
+        ----------
+        rgb : tuple
+            A tuple containing three integers representing the RGB values.
+
+        Returns
+        -------
+        str
+            A hexadecimal color string in the format '#RRGGBB'.
+        """
+
+        r, g, b = rgb
+        hex_value = "#{:02x}{:02x}{:02x}".format(r, g, b)
+        return hex_value.upper()

{topologicpy-0.4.36 → topologicpy-0.4.38}/src/topologicpy/Graph.py

@@ -28,6 +28,16 @@ except:
     except:
         print("Graph - Error: Could not import numpy")
 
+try:
+    from pyvis.network import Network
+except:
+    call = [sys.executable, '-m', 'pip', 'install', 'pyvis', '-t', sys.path[0]]
+    subprocess.run(call)
+    try:
+        from pyvis.network import Network
+    except:
+        print("Graph - Error: Could not import pyvis")
+
 class _Tree:
     def __init__(self, node="", *children):
         self.node = node
@@ -4402,6 +4412,177 @@ class Graph:
             return None
         return graph.Path(vertexA, vertexB)
     
+    @staticmethod
+    def PyvisGraph(graph, path, overwrite=True, height=900, backgroundColor="white", fontColor="black", notebook=False,
+                   vertexSize=6, vertexSizeKey=None, vertexColor="black", vertexColorKey=None, vertexLabelKey=None, vertexGroupKey=None, vertexGroups=None, minVertexGroup=None, maxVertexGroup=None, 
+                   edgeWeight=0, edgeWeightKey=None, showNeighbours=True, selectMenu=True, filterMenu=True, colorScale="viridis"):
+        """
+        Displays a pyvis graph. See https://pyvis.readthedocs.io/.
+
+        Parameters
+        ----------
+        graph : topologic.Graph
+            The input graph.
+        path : str
+            The desired file path to the HTML file into which to save the pyvis graph.
+        overwrite : bool , optional
+            If set to True, the HTML file is overwritten.
+        height : int , optional
+            The desired figure height in pixels. The default is 900 pixels.
+        backgroundColor : str, optional
+            The desired background color for the figure. This can be a named color or a hexadecimal value. The default is 'white'.
+        fontColor : str , optional
+            The desired font color for the figure. This can be a named color or a hexadecimal value. The default is 'black'.
+        notebook : bool , optional
+            If set to True, the figure will be targeted at a Jupyter Notebook. Note that this is not working well. Pyvis has bugs. The default is False.
+        vertexSize : int , optional
+            The desired default vertex size. The default is 6.
+        vertexSizeKey : str , optional
+            If not set to None, the vertex size will be derived from the dictionary value set at this key. If set to "degree", the size of the vertex will be determined by its degree (number of neighbors). The default is None.
+        vertexColor : int , optional
+            The desired default vertex color. his can be a named color or a hexadecimal value. The default is 'black'.
+        vertexColorKey : str , optional
+            If not set to None, the vertex color will be derived from the dictionary value set at this key. The default is None.
+        vertexLabelKey : str , optional
+            If not set to None, the vertex label will be derived from the dictionary value set at this key. The default is None.
+        vertexGroupKey : str , optional
+            If not set to None, the vertex color will be determined by the group the vertex belongs to as derived from the value set at this key. The default is None.
+        vertexGroups : list , optional
+            The list of all possible vertex groups. This will help in vertex coloring. The default is None.
+        minVertexGroup : int or float , optional
+            If the vertex groups are numeric, specify the minimum value you wish to consider for vertex coloring. The default is None.
+        maxVertexGroup : int or float , optional
+            If the vertex groups are numeric, specify the maximum value you wish to consider for vertex coloring. The default is None.
+        
+        edgeWeight : int , optional
+            The desired default weight of the edge. This determines its thickness. The default is 0.
+        edgeWeightKey : str, optional
+            If not set to None, the edge weight will be derived from the dictionary value set at this key. If set to "length" or "distance", the weight of the edge will be determined by its geometric length. The default is None.
+        showNeighbors : bool , optional
+            If set to True, a list of neighbors is shown when you hover over a vertex. The default is True.
+        selectMenu : bool , optional
+            If set to True, a selection menu will be displayed. The default is True
+        filterMenu : bool , optional
+            If set to True, a filtering menu will be displayed. The default is True.
+        colorScale : str , optional
+            The desired type of plotly color scales to use (e.g. "viridis", "plasma"). The default is "viridis". For a full list of names, see https://plotly.com/python/builtin-colorscales/.
+
+        Returns
+        -------
+        None
+            The pyvis graph is displayed either inline (notebook mode) or in a new browser window or tab.
+
+        """
+        from topologicpy.Vertex import Vertex
+        from topologicpy.Edge import Edge
+        from topologicpy.Topology import Topology
+        from topologicpy.Dictionary import Dictionary
+        from topologicpy.Color import Color
+        from os.path import exists
+        net = Network(height=str(height)+"px", width="100%", bgcolor=backgroundColor, font_color=fontColor, select_menu=selectMenu, filter_menu=filterMenu, cdn_resources="remote", notebook=notebook)
+        if notebook == True:
+            net.prep_notebook()
+        
+        vertices = Graph.Vertices(graph)
+        edges = Graph.Edges(graph)
+
+        nodes = [i for i in range(len(vertices))]
+        if not vertexLabelKey == None:
+            node_labels = [Dictionary.ValueAtKey(Topology.Dictionary(v), vertexLabelKey) for v in vertices]
+        else:
+            node_labels = list(range(len(vertices)))
+        if not vertexColorKey == None:
+            colors = [Dictionary.ValueAtKey(Topology.Dictionary(v), vertexColorKey) for v in vertices]
+        else:
+            colors = [vertexColor for v in vertices]
+        node_titles = [str(n) for n in node_labels]
+        group = ""
+        if not vertexGroupKey == None:
+            colors = []
+            if vertexGroups:
+                if len(vertexGroups) > 0:
+                    if type(vertexGroups[0]) == int or type(vertexGroups[0]) == float:
+                        if not minVertexGroup:
+                            minVertexGroup = min(vertexGroups)
+                        if not maxVertexGroup:
+                            maxVertexGroup = max(vertexGroups)
+                    else:
+                        minVertexGroup = 0
+                        maxVertexGroup = len(vertexGroups) - 1
+            else:
+                minVertexGroup = 0
+                maxVertexGroup = 1
+            for m, v in enumerate(vertices):
+                group = ""
+                d = Topology.Dictionary(v)
+                if d:
+                    try:
+                        group = Dictionary.ValueAtKey(d, key=vertexGroupKey) or None
+                    except:
+                        group = ""
+                try:
+                    if type(group) == int or type(group) == float:
+                        if group < minVertexGroup:
+                            group = minVertexGroup
+                        if group > maxVertexGroup:
+                            group = maxVertexGroup
+                        color = Color.RGBToHex(Color.ByValueInRange(group, minValue=minVertexGroup, maxValue=maxVertexGroup, colorScale=colorScale))
+                    else:
+                        color = Color.RGBToHex(Color.ByValueInRange(vertexGroups.index(group), minValue=minVertexGroup, maxValue=maxVertexGroup, colorScale=colorScale))
+                    colors.append(color)
+                except:
+                    colors.append(vertexColor)
+        net.add_nodes(nodes, label=node_labels, title=node_titles, color=colors)
+
+        for e in edges:
+            w = edgeWeight
+            if not edgeWeightKey == None:
+                d = Topology.Dictionary(e)
+                if edgeWeightKey.lower() == "length" or edgeWeightKey.lower() == "distance":
+                    w = Edge.Length(e)
+                else:
+                    weightValue = Dictionary.ValueAtKey(d, edgeWeightKey)
+                if weightValue:
+                    w = weightValue
+            sv = Edge.StartVertex(e)
+            ev = Edge.EndVertex(e)
+            svi = Vertex.Index(sv, vertices)
+            evi = Vertex.Index(ev, vertices)
+            net.add_edge(svi, evi, weight=w)
+        net.inherit_edge_colors(False)
+        
+        # add neighbor data to node hover data and compute vertexSize
+        if showNeighbours == True or not vertexSizeKey == None:
+            for i, node in enumerate(net.nodes):
+                if showNeighbours == True:
+                    neighbors = list(net.neighbors(node["id"]))
+                    neighbor_labels = [str(net.nodes[n]["id"])+": "+net.nodes[n]["label"] for n in neighbors]
+                    node["title"] = str(node["id"])+": "+node["title"]+"\n"
+                    node["title"] += "Neighbors:\n" + "\n".join(neighbor_labels)
+                vs = vertexSize
+                if not vertexSizeKey == None:
+                    d = Topology.Dictionary(vertices[i])
+                    if vertexSizeKey.lower() == "neighbours" or vertexSizeKey.lower() == "degree":
+                        temp_vs = Graph.VertexDegree(graph, vertices[i])
+                    else:
+                        temp_vs = Dictionary.ValueAtKey(vertices[i], vertexSizeKey)
+                    if temp_vs:
+                        vs = temp_vs
+                node["value"] = vs
+        
+        # Make sure the file extension is .html
+        ext = path[len(path)-5:len(path)]
+        if ext.lower() != ".html":
+            path = path+".html"
+        if not overwrite and exists(path):
+            print("Graph.PyvisGraph - Error: a file already exists at the specified path and overwrite is set to False. Returning None.")
+            return None
+        if overwrite == True:
+            net.save_graph(path)
+        net.show_buttons()
+        net.show(path, notebook=notebook)
+        return None
+        
     @staticmethod
     def RemoveEdge(graph, edge, tolerance=0.0001):
         """

{topologicpy-0.4.36 → topologicpy-0.4.38}/src/topologicpy/Plotly.py

@@ -388,7 +388,7 @@ class Plotly:
                        faceMinGroup=None, faceMaxGroup=None, 
                        showFaceLegend=False, faceLegendLabel="Topology Faces", faceLegendRank=3,
                        faceLegendGroup=3, 
-                       intensityKey=None, colorScale="Viridis", tolerance=0.0001):
+                       intensityKey=None, colorScale="Viridis", mantissa=4, tolerance=0.0001):
         """
         Creates plotly face, edge, and vertex data.
 
@@ -493,6 +493,8 @@ class Plotly:
             If not None, the dictionary of each vertex is searched for the value associated with the intensity key. This value is then used to color-code the vertex based on the colorScale. The default is None.
         colorScale : str , optional
             The desired type of plotly color scales to use (e.g. "Viridis", "Plasma"). The default is "Viridis". For a full list of names, see https://plotly.com/python/builtin-colorscales/.
+        mantissa : int , optional
+            The desired length of the mantissa. The default is 4.
         tolerance : float , optional
             The desired tolerance. The default is 0.0001.
         
@@ -528,9 +530,9 @@ class Plotly:
                     minGroup = 0
                     maxGroup = 1
                 for m, v in enumerate(vertices):
-                    x.append(v[0])
-                    y.append(v[1])
-                    z.append(v[2])
+                    x.append(round(v[0], mantissa))
+                    y.append(round(v[1], mantissa))
+                    z.append(round(v[2], mantissa))
                     label = ""
                     group = ""
                     if len(dictionaries) > 0:
@@ -560,9 +562,9 @@ class Plotly:
                         labels.append(label)
             else:
                 for v in vertices:
-                    x.append(v[0])
-                    y.append(v[1])
-                    z.append(v[2])
+                    x.append(round(v[0], mantissa))
+                    y.append(round(v[1], mantissa))
+                    z.append(round(v[2], mantissa))
             
             if len(list(set(groupList))) < 2:
                 groupList = color
@@ -607,9 +609,9 @@ class Plotly:
                 for m, e in enumerate(edges):
                     sv = vertices[e[0]]
                     ev = vertices[e[1]]
-                    x+=[sv[0],ev[0], None] # x-coordinates of edge ends
-                    y+=[sv[1],ev[1], None] # y-coordinates of edge ends
-                    z+=[sv[2],ev[2], None] # z-coordinates of edge ends
+                    x+=[round(sv[0],5),round(ev[0],mantissa), None] # x-coordinates of edge ends
+                    y+=[round(sv[1],5),round(ev[1],mantissa), None] # y-coordinates of edge ends
+                    z+=[round(sv[2],5),round(ev[2],mantissa), None] # z-coordinates of edge ends
                     label = ""
                     group = ""
                     if len(dictionaries) > 0:
@@ -641,9 +643,9 @@ class Plotly:
                 for e in edges:
                     sv = vertices[e[0]]
                     ev = vertices[e[1]]
-                    x+=[sv[0],ev[0], None] # x-coordinates of edge ends
-                    y+=[sv[1],ev[1], None] # y-coordinates of edge ends
-                    z+=[sv[2],ev[2], None] # z-coordinates of edge ends
+                    x+=[round(sv[0],mantissa),round(ev[0],mantissa), None] # x-coordinates of edge ends
+                    y+=[round(sv[1],mantissa),round(ev[1],mantissa), None] # y-coordinates of edge ends
+                    z+=[round(sv[2],mantissa),round(ev[2],mantissa), None] # z-coordinates of edge ends
                 
             if len(list(set(groupList))) < 2:
                     groupList = color
@@ -668,9 +670,9 @@ class Plotly:
             y = []
             z = []
             for v in vertices:
-                x.append(v[0])
-                y.append(v[1])
-                z.append(v[2])
+                x.append(round(v[0], mantissa))
+                y.append(round(v[1], mantissa))
+                z.append(round(v[2], mantissa))
             i = []
             j = []
             k = []
@@ -951,7 +953,8 @@ class Plotly:
              marginLeft=0,
              marginRight=0,
              marginTop=40,
-             marginBottom=0):
+             marginBottom=0,
+             mantissa=4):
         """
         Returns a Plotly Figure of the input matrix.
 
@@ -997,6 +1000,8 @@ class Plotly:
             The desired top margin in pixels. The default is 40.
         marginBottom : int , optional
             The desired bottom margin in pixels. The default is 0.
+        mantissa : int , optional
+            The desired number of digits of the mantissa. The default is 4.
 
         """
         #import plotly.figure_factory as ff
@@ -1033,7 +1038,7 @@ class Plotly:
                             "font": {"color": "black"},
                             "bgcolor": "white",
                             "opacity": 0.5,
-                            "text": str(round(value,2)), 
+                            "text": str(round(value, mantissa)), 
                             "xref": "x1",
                             "yref": "y1",
                             "showarrow": False
@@ -1054,7 +1059,7 @@ class Plotly:
                             "font": {"color": "black"},
                             "bgcolor": "white",
                             "opacity": 0.5,
-                            "text": str(round(value,2)),
+                            "text": str(round(value,mantissa)),
                             "xref": "x1",
                             "yref": "y1",
                             "showarrow": False
@@ -1067,9 +1072,9 @@ class Plotly:
             maxRow = sum(row)
             for j in range(len(row)):
                 if maxRow == 0:
-                    new_row.append(round(0, 3))
+                    new_row.append(round(0, mantissa))
                 else:
-                    new_row.append(round(float(row[j])/float(maxRow), 3))
+                    new_row.append(round(float(row[j])/float(maxRow), mantissa))
             new_matrix.append(new_row)
         data = go.Heatmap(z=new_matrix, y=yCategories, x=xCategories, zmin=minValue, zmax=maxValue, showscale=showScale, colorscale=colors)
         
@@ -1544,7 +1549,7 @@ class Plotly:
 
         """
         if not isinstance(topology, topologic.Topology):
-            print("Topology.Show - Error: the input topology is not a valid topology. Returning None.")
+            print("Plotly.FigureByTopology - Error: the input topology is not a valid topology. Returning None.")
             return None
         data = Plotly.DataByTopology(topology=topology,
                        showVertices=showVertices, vertexSize=vertexSize, vertexColor=vertexColor, 
@@ -1817,7 +1822,11 @@ class Plotly:
             return None
         if not camera == None:
             figure = Plotly.SetCamera(figure, camera=camera, target=target, up=up)
-        figure.show(renderer=renderer)
+        if renderer.lower() == "offline":
+            import plotly.offline as ofl
+            ofl.plot(figure)
+        else:
+            figure.show(renderer=renderer)
         return None
 
     @staticmethod
@@ -1838,7 +1847,7 @@ class Plotly:
          'notebook', 'notebook_connected', 'kaggle', 'azure', 'colab',
          'cocalc', 'databricks', 'json', 'png', 'jpeg', 'jpg', 'svg',
          'pdf', 'browser', 'firefox', 'chrome', 'chromium', 'iframe',
-         'iframe_connected', 'sphinx_gallery', 'sphinx_gallery_png']
+         'iframe_connected', 'sphinx_gallery', 'sphinx_gallery_png', 'offline']
 
     @staticmethod
     def ExportToImage(figure, path, format="png", width="1920", height="1080"):