topologicpy 0.8.46__py3-none-any.whl → 0.8.48__py3-none-any.whl

topologicpy/Grid.py

@@ -25,21 +25,21 @@ class Grid():
         Parameters
         ----------
         face : topologic_core.Face , optional
-            The input face. If set to None, the grid will be created on the XY plane. The default is None.
+            The input face. If set to None, the grid will be created on the XY plane. Default is None.
         uOrigin : topologic_core.Vertex , optional
-            The origin of the *u* grid lines. If set to None: if the face is set, the uOrigin will be set to vertex at the face's 0,0 paratmer. If the face is set to None, the uOrigin will be set to the origin. The default is None.
+            The origin of the *u* grid lines. If set to None: if the face is set, the uOrigin will be set to vertex at the face's 0,0 paratmer. If the face is set to None, the uOrigin will be set to the origin. Default is None.
         vOrigin : topologic_core.Vertex , optional
-            The origin of the *v* grid lines. If set to None: if the face is set, the vOrigin will be set to vertex at the face's 0,0 paratmer. If the face is set to None, the vOrigin will be set to the origin. The default is None.
+            The origin of the *v* grid lines. If set to None: if the face is set, the vOrigin will be set to vertex at the face's 0,0 paratmer. If the face is set to None, the vOrigin will be set to the origin. Default is None.
         uRange : list , optional
-            A list of distances for the *u* grid lines from the uOrigin. The default is [-0.5,-0.25,0, 0.25,0.5].
+            A list of distances for the *u* grid lines from the uOrigin. Default is [-0.5,-0.25,0, 0.25,0.5].
         vRange : list , optional
-            A list of distances for the *v* grid lines from the vOrigin. The default is [-0.5,-0.25,0, 0.25,0.5].
+            A list of distances for the *v* grid lines from the vOrigin. Default is [-0.5,-0.25,0, 0.25,0.5].
         clip : bool , optional
-            If True the grid will be clipped by the shape of the input face. The default is False.
+            If True the grid will be clipped by the shape of the input face. Default is False.
         mantissa : int , optional
-            The desired length of the mantissa. The default is 6.
+            The number of decimal places to round the result to. Default is 6.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------
@@ -139,13 +139,13 @@ class Grid():
         face : topologic_core.Face
             The input face.
         uRange : list , optional
-            A list of *u* parameters for the *u* grid lines. The default is [0,0.25,0.5, 0.75, 1.0].
+            A list of *u* parameters for the *u* grid lines. Default is [0,0.25,0.5, 0.75, 1.0].
         vRange : list , optional
-            A list of *v* parameters for the *v* grid lines. The default is [0,0.25,0.5, 0.75, 1.0].
+            A list of *v* parameters for the *v* grid lines. Default is [0,0.25,0.5, 0.75, 1.0].
         clip : bool , optional
-            If True the grid will be clipped by the shape of the input face. The default is False.
+            If True the grid will be clipped by the shape of the input face. Default is False.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
         
         Returns
         -------
@@ -226,19 +226,19 @@ class Grid():
         Parameters
         ----------
         face : topologic_core.Face , optional
-            The input face. If set to None, the grid will be created on the XY plane. The default is None.
+            The input face. If set to None, the grid will be created on the XY plane. Default is None.
         origin : topologic_core.Vertex , optional
-            The origin of the grid vertices. If set to None: if the face is set, the origin will be set to vertex at the face's 0,0 paratmer. If the face is set to None, the origin will be set to (0, 0, 0). The default is None.
+            The origin of the grid vertices. If set to None: if the face is set, the origin will be set to vertex at the face's 0,0 paratmer. If the face is set to None, the origin will be set to (0, 0, 0). Default is None.
         uRange : list , optional
-            A list of distances for the *u* grid lines from the uOrigin. The default is [-0.5,-0.25,0, 0.25,0.5].
+            A list of distances for the *u* grid lines from the uOrigin. Default is [-0.5,-0.25,0, 0.25,0.5].
         vRange : list , optional
-            A list of distances for the *v* grid lines from the vOrigin. The default is [-0.5,-0.25,0, 0.25,0.5].
+            A list of distances for the *v* grid lines from the vOrigin. Default is [-0.5,-0.25,0, 0.25,0.5].
         clip : bool , optional
-            If True the grid will be clipped by the shape of the input face. The default is False.
+            If True the grid will be clipped by the shape of the input face. Default is False.
         mantissa : int , optional
-            The desired length of the mantissa. The default is 6.
+            The number of decimal places to round the result to. Default is 6.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------
@@ -304,15 +304,15 @@ class Grid():
         Parameters
         ----------
         face : topologic_core.Face , optional
-            The input face. If set to None, the grid will be created on the XY plane. The default is None.
+            The input face. If set to None, the grid will be created on the XY plane. Default is None.
         uRange : list , optional
-            A list of *u* parameters for the *u* grid lines from the uOrigin. The default is [0.0,0.25,0.5,0.75,1.0].
+            A list of *u* parameters for the *u* grid lines from the uOrigin. Default is [0.0,0.25,0.5,0.75,1.0].
         vRange : list , optional
-            A list of *v* parameters for the *v* grid lines from the vOrigin. The default is [0.0,0.25,0.5,0.75,1.0].
+            A list of *v* parameters for the *v* grid lines from the vOrigin. Default is [0.0,0.25,0.5,0.75,1.0].
         clip : bool , optional
-            If True the grid will be clipped by the shape of the input face. The default is False.
+            If True the grid will be clipped by the shape of the input face. Default is False.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------

topologicpy/Helper.py

@@ -46,11 +46,11 @@ class Helper:
         listA : list
             The input list.
         mantissa : int , optional
-            The desired length of the mantissa. The default is 6
+            The desired length of the mantissa. Default is 6
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
         
         Returns
         -------
@@ -164,7 +164,7 @@ class Helper:
         keys : str or list or comma-separated str input parameters
             The key or keys in the topology's dictionary to use for clustering.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
 
 
         Returns
@@ -427,7 +427,7 @@ class Helper:
         listA : list
             The input nested list.
         threshold : float , optional
-            The desired merge threshold value. The default is 0.0001.
+            The desired merge threshold value. Default is 0.0001.
 
         Returns
         -------
@@ -464,7 +464,7 @@ class Helper:
         listA : list
             The input list.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
 
         Returns
         -------
@@ -500,7 +500,7 @@ class Helper:
         listA : list
             The input list.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
 
         Returns
         -------
@@ -535,7 +535,7 @@ class Helper:
         listA : list
             The input nested list.
         mantissa : int , optional
-            The desired length of the mantissa. The default is 6.
+            The number of decimal places to round the result to. Default is 6.
 
         Returns
         -------

topologicpy/Honeybee.py

@@ -159,7 +159,7 @@ class Honeybee:
         path : str
             The location of the output file.
         overwrite : bool , optional
-            If set to True this method overwrites any existing file. Otherwise, it won't. The default is False.
+            If set to True this method overwrites any existing file. Otherwise, it won't. Default is False.
 
         Returns
         -------
@@ -215,29 +215,29 @@ class Honeybee:
         tpBuilding : topologic_core.CellComplex or topologic_core.Cell
             The input building topology.
         tpShadingFaceCluster : topologic_core.Cluster , optional
-            The input cluster for shading faces. The default is None.
+            The input cluster for shading faces. Default is None.
         buildingName : str , optional
-            The desired name of the building. The default is "Generic_Building".
+            The desired name of the building. Default is "Generic_Building".
         defaultProgramIdentifier: str , optional
-            The desired default program identifier. The default is "Generic Office Program".
+            The desired default program identifier. Default is "Generic Office Program".
         defaultConstructionSetIdentifier: str , optional
-            The desired default construction set identifier. The default is "Default Generic Construction Set".
+            The desired default construction set identifier. Default is "Default Generic Construction Set".
         coolingSetpoint : float , optional
-            The desired HVAC cooling set point in degrees Celsius. The default is 25.
+            The desired HVAC cooling set point in degrees Celsius. Default is 25.
         heatingSetpoint : float , optional
-            The desired HVAC heating set point in degrees Celsius. The default is 20.
+            The desired HVAC heating set point in degrees Celsius. Default is 20.
         humidifyingSetpoint : float , optional
-            The desired HVAC humidifying set point in percentage. The default is 55.
+            The desired HVAC humidifying set point in percentage. Default is 55.
         roomNameKey : str , optional
-            The dictionary key under which the room name is stored. The default is "TOPOLOGIC_name".
+            The dictionary key under which the room name is stored. Default is "TOPOLOGIC_name".
         roomTypeKey : str , optional
-            The dictionary key under which the room type is stored. The default is "TOPOLOGIC_type".
+            The dictionary key under which the room type is stored. Default is "TOPOLOGIC_type".
         apertureTypeKey : str , optional
-            The dictionary key under which the aperture type is stored. The default is "TOPOLOGIC_type".
+            The dictionary key under which the aperture type is stored. Default is "TOPOLOGIC_type".
         addSensorGrid : bool , optional
-            If set to True a sensor grid is add to horizontal surfaces. The default is False.
+            If set to True a sensor grid is add to horizontal surfaces. Default is False.
         mantissa : int , optional
-            The desired length of the mantissa. The default is 6.
+            The number of decimal places to round the result to. Default is 6.
         
         Returns
         -------

topologicpy/Matrix.py

@@ -66,9 +66,9 @@ class Matrix:
         target : list
             The 4X3 matrix representing target coordinate system. The rows are in the order: Origin, X-Axis, Y-Axis, Z-Axis.
         mantissa : int , optional
-                The desired length of the mantissa. The default is 6.
+                The number of decimal places to round the result to. Default is 6.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
 
         Returns
         -------
@@ -176,11 +176,11 @@ class Matrix:
         Parameters
         ----------
         scaleX : float , optional
-            The desired scaling factor along the X axis. The default is 1.
+            The desired scaling factor along the X axis. Default is 1.
         scaleY : float , optional
-            The desired scaling factor along the X axis. The default is 1.
+            The desired scaling factor along the X axis. Default is 1.
         scaleZ : float , optional
-            The desired scaling factor along the X axis. The default is 1.
+            The desired scaling factor along the X axis. Default is 1.
         
         Returns
         -------
@@ -201,11 +201,11 @@ class Matrix:
         Parameters
         ----------
         translateX : float , optional
-            The desired translation distance along the X axis. The default is 0.
+            The desired translation distance along the X axis. Default is 0.
         translateY : float , optional
-            The desired translation distance along the X axis. The default is 0.
+            The desired translation distance along the X axis. Default is 0.
         translateZ : float , optional
-            The desired translation distance along the X axis. The default is 0.
+            The desired translation distance along the X axis. Default is 0.
         
         Returns
         -------
@@ -415,9 +415,9 @@ class Matrix:
         matrix : list
             The input matrix. Assumed to be a laplacian matrix.
         mantissa : int , optional
-            The desired length of the mantissa. The default is 6.
+            The number of decimal places to round the result to. Default is 6.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
 
         Returns
         -------
@@ -496,7 +496,7 @@ class Matrix:
         matA : list of list of float
             The input matrix.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
 
         Returns
         -------

topologicpy/Neo4j.py

@@ -47,21 +47,21 @@ class Neo4j:
         cypher : str, optional
             If set to a non-empty string, a Cypher query will be run on the neo4j graph database to return a sub-graph. Default is None.
         xMin : float, optional
-            The desired minimum value to assign for a vertex's X coordinate. The default is -0.5.
+            The desired minimum value to assign for a vertex's X coordinate. Default is -0.5.
         yMin : float, optional
-            The desired minimum value to assign for a vertex's Y coordinate. The default is -0.5.
+            The desired minimum value to assign for a vertex's Y coordinate. Default is -0.5.
         zMin : float, optional
-            The desired minimum value to assign for a vertex's Z coordinate. The default is -0.5.
+            The desired minimum value to assign for a vertex's Z coordinate. Default is -0.5.
         xMax : float, optional
-            The desired maximum value to assign for a vertex's X coordinate. The default is 0.5.
+            The desired maximum value to assign for a vertex's X coordinate. Default is 0.5.
         yMax : float, optional
-            The desired maximum value to assign for a vertex's Y coordinate. The default is 0.5.
+            The desired maximum value to assign for a vertex's Y coordinate. Default is 0.5.
         zMax : float, optional
-            The desired maximum value to assign for a vertex's Z coordinate. The default is 0.5.
+            The desired maximum value to assign for a vertex's Z coordinate. Default is 0.5.
         silent : bool, optional
-            If set to True, no warnings or error messages are displayed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
         tolerance : float, optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------
@@ -227,30 +227,30 @@ class Neo4j:
             The input neo4j driver.
         vertexLabelKey : str , optional
             The returned vertices are labelled according to the dictionary values stored under this key.
-            If the vertexLabelKey does not exist, it will be created and the vertices are labelled numerically using the format defaultVertexLabel_XXX. The default is "label".
+            If the vertexLabelKey does not exist, it will be created and the vertices are labelled numerically using the format defaultVertexLabel_XXX. Default is "label".
         defaultVertexLabel : str , optional
-            The default vertex label to use if no value is found under the vertexLabelKey. The default is "NODE".
+            The default vertex label to use if no value is found under the vertexLabelKey. Default is "NODE".
         vertexCategoryKey : str , optional
             The returned vertices are categorized according to the dictionary values stored under this key. The dfefault is "category".
         defaultVertexCategory : str , optional
-            The default vertex category to use if no value is found under the vertexCategoryKey. The default is None.
+            The default vertex category to use if no value is found under the vertexCategoryKey. Default is None.
         edgeLabelKey : str , optional
             The returned edges are labelled according to the dictionary values stored under this key.
-            If the edgeLabelKey does not exist, it will be created and the edges are labelled numerically using the format defaultEdgeLabel_XXX. The default is "label".
+            If the edgeLabelKey does not exist, it will be created and the edges are labelled numerically using the format defaultEdgeLabel_XXX. Default is "label".
         defaultEdgeLabel : str , optional
-            The default edge label to use if no value is found under the edgeLabelKey. The default is "CONNECTED_TO".
+            The default edge label to use if no value is found under the edgeLabelKey. Default is "CONNECTED_TO".
         edgeCategoryKey : str , optional
             The returned edges are categorized according to the dictionary values stored under this key. The dfefault is "category".
         defaultEdgeCategory : str , optional
-            The default edge category to use if no value is found under the edgeCategoryKey. The default is None.
+            The default edge category to use if no value is found under the edgeCategoryKey. Default is None.
         bidirectional : bool , optional
             If set to True, the output Neo4j graph is forced to be bidirectional. The defaul is True.
         mantissa : int , optional
-            The desired length of the mantissa. The default is 6.
+            The number of decimal places to round the result to. Default is 6.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
         
         Returns
         -------
@@ -394,17 +394,17 @@ class Neo4j:
         graph : topologic_core.Graph
             The input topologic graph.
         labelKey : str , optional
-            The dictionary key under which to find the vertex's label value. The default is None which means the vertex gets the name 'TopologicGraphVertex'.
+            The dictionary key under which to find the vertex's label value. Default is None which means the vertex gets the name 'TopologicGraphVertex'.
         relationshipKey : str , optional
-            The dictionary key under which to find the edge's relationship value. The default is None which means the edge gets the relationship type 'Connected To'.
+            The dictionary key under which to find the edge's relationship value. Default is None which means the edge gets the relationship type 'Connected To'.
         bidirectional : bool , optional
             If set to True, the edges in the neo4j graph are set to be bi-drectional.
         deleteAll : bool , optional
             If set to True, all previous entities are deleted before adding the new entities.
         mantissa : int , optional
-            The desired length of the mantissa. The default is 6.
+            The number of decimal places to round the result to. Default is 6.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------