fairyfly-core 0.2.6__py3-none-any.whl → 0.2.8__py3-none-any.whl

fairyfly/model.py

@@ -4,6 +4,7 @@ from __future__ import division
 import os
 import io
 import json
+import math
 try:  # check if we are in IronPython
     import cPickle as pickle
 except ImportError:  # wea are in cPython
@@ -12,7 +13,8 @@ except ImportError:  # wea are in cPython
 from ladybug_geometry.geometry3d import Vector3D, Point3D, LineSegment3D, Plane, Face3D
 
 from ._base import _Base
-from .units import conversion_factor_to_meters, UNITS, UNITS_TOLERANCES
+from .units import conversion_factor_to_meters, parse_distance_string, \
+    UNITS, UNITS_TOLERANCES
 from .checkdup import check_duplicate_identifiers, check_duplicate_identifiers_parent
 from .properties import ModelProperties
 from .shape import Shape
@@ -899,6 +901,52 @@ class Model(_Base):
             pickle.dump(hb_dict, fp)
         return hb_file
 
+    @staticmethod
+    def check_reasonable_tolerance(units, tolerance):
+        """Get a message with a recommended tolerance if it is not reasonable.
+
+        This method is particularly useful to ensure that users have set a
+        tolerance that works for representing construction details and it is
+        not only for full-building simulation.
+
+        When the input tolerance and units are reasonable, the output of this
+        method will simply be None:
+
+        Args:
+            units: Text for the units system in which the model geometry
+                exists. Choose from the following:
+
+                * Millimeters
+                * Inches
+                * Centimeters
+                * Meters
+                * Feet
+
+            tolerance: The maximum difference between x, y, and z values at which
+                vertices are considered equivalent.
+        """
+        max_tol = parse_distance_string('1mm', units)
+        if tolerance > max_tol:
+            return 'The model tolerance is currently set to {} {}.\n' \
+                'This is too coarse to correctly represent construction details.\n' \
+                'It is recommended that the tolerance be dropped to below {} {}\n' \
+                'for an accurate representation of the geometry.'.format(
+                    tolerance, units, Model._round_to_sig_figs(max_tol, 1), units
+                )
+
+    @staticmethod
+    def _round_to_sig_figs(x, sigfigs):
+        """Round a number to a specified number of significant figures."""
+        if x == 0:
+            return 0.0  # Handle zero as a special case
+        # calculate the number of decimal places needed
+        # by finding the magnitude and adjusting for the desired significant figures
+        digits = sigfigs - int(math.floor(math.log10(abs(x)))) - 1
+        if digits == 0:
+            return math.floor(x)
+        multiplier = 10**digits
+        return math.floor(x * multiplier) / multiplier
+
     @staticmethod
     def validate(model, check_function='check_all', check_args=None, json_output=False):
         """Get a string of a validation report given a specific check_function.

fairyfly/shape.py

@@ -283,7 +283,7 @@ class Shape(_Base):
                 break
         if insert_i is not None:
             new_bound = list(self.geometry.boundary)
-            new_bound.insert(insert_i, point)
+            new_bound.insert(insert_i + 1, point)
             self._geometry = Face3D(new_bound, self._geometry.plane, self._geometry.holes)
             return None
         # evaluate the holes if they exist
@@ -292,7 +292,7 @@ class Shape(_Base):
                 for i, seg in enumerate(h_segs):
                     if seg.distance_to_point(point) <= tolerance:
                         new_holes = list(self.geometry.holes)
-                        new_holes[hi].insert(i, point)
+                        new_holes[hi].insert(i + 1, point)
                         self._geometry = Face3D(self._geometry.boundary,
                                                 self._geometry.plane, new_holes)
                         return None

{fairyfly_core-0.2.6.dist-info → fairyfly_core-0.2.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fairyfly-core
-Version: 0.2.6
+Version: 0.2.8
 Summary: A library to represent construction detail geometry for environmental simulation.
 Home-page: https://github.com/ladybug-tools/fairyfly-core
 Author: Ladybug Tools

{fairyfly_core-0.2.6.dist-info → fairyfly_core-0.2.8.dist-info}/RECORD

@@ -10,10 +10,10 @@ fairyfly/config.py,sha256=VfQ-vRX-q1CLja4xFMGVte-FpdFStdMXj98WKpmMOFA,10633
 fairyfly/dictutil.py,sha256=nVwoWG4FsoV9nYjQxI3jBxVeZcdy2TQd1FKhEquVLR8,1469
 fairyfly/extensionutil.py,sha256=5MQV0gZBc6_vfbVr4j8l_8JslMsj4bBbsZ4yqZ2VPG4,2716
 fairyfly/logutil.py,sha256=Urxl0U14-qffIt6NiGLT6pV-796oAGUvnnf2ypj1j9Q,2564
-fairyfly/model.py,sha256=2S7yGWZCNa7To1CyAhZ44IgIgBcMveu1t6hTfSo4czk,44282
+fairyfly/model.py,sha256=R3BXbVgICTM-5K0O1HAnyODqDYrOXXQjZpkT73PGMos,46274
 fairyfly/properties.py,sha256=uGBA8YY0Sr_dp3NUCAx-XvXhctoBBwDlqsCiyNU_TTo,21402
 fairyfly/search.py,sha256=-DapYpzfX3nwZx1eF2elcmYG7vxitsvAiv_e3TGlTJ0,4806
-fairyfly/shape.py,sha256=1cQCxJMEuBOJ3AEYIEWScFI8ZxX4pUJ7LQX-exxYJXI,22306
+fairyfly/shape.py,sha256=UaG-CWt2w_h513MpY3sIdr6XNCyQUk6VaI2lTHrQ_94,22314
 fairyfly/typing.py,sha256=1djGuUI0Ui-96EjBKPKw6rrMF7dPUq97q24Pg6NNfTM,7219
 fairyfly/units.py,sha256=wM3TEAF_ir8VWHFJYSbAKYrLU7VHzBGTtRTw6Tbh4Aw,3216
 fairyfly/cli/__init__.py,sha256=1qvLWWmJtYVDdTTQHVtoCNTMKyeAq_VWZ4tp-ap-Ajk,3187
@@ -22,9 +22,9 @@ fairyfly/writer/__init__.py,sha256=D4FdE2LUVCMvfud3qL2UquH1uCz3EGlKOEMgstMjtXc,2
 fairyfly/writer/boundary.py,sha256=skpfcFyxWLvjTSStbCh5f4wehSHeI-eKMgoeSCzvO7Q,190
 fairyfly/writer/model.py,sha256=6Y15NVGCjmYcBdimxyQWnE8AAhQAJi6A7QfMi4P49M4,181
 fairyfly/writer/shape.py,sha256=pMlLbk3WkrNPbNvowDQ_JFgNkhHNOlqL52TMZKB7zKo,181
-fairyfly_core-0.2.6.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-fairyfly_core-0.2.6.dist-info/METADATA,sha256=Sho9baISD_xgjf2fmYKUIvWaZDh2h7RfANTRoMnVWTU,3291
-fairyfly_core-0.2.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-fairyfly_core-0.2.6.dist-info/entry_points.txt,sha256=KM3hAPV0ivux3CUx1-pDT0BL1WSUFt2jmT4i_MFbdzc,47
-fairyfly_core-0.2.6.dist-info/top_level.txt,sha256=8ZUsvZOSB3g5enmv1R0vxJilNeW8Uft5KrTL0rUNj7k,9
-fairyfly_core-0.2.6.dist-info/RECORD,,
+fairyfly_core-0.2.8.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+fairyfly_core-0.2.8.dist-info/METADATA,sha256=m4J4gL2Hb3I_WIUrjmkAhVvN8aUWbsG9PWe_eQ8C6hI,3291
+fairyfly_core-0.2.8.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+fairyfly_core-0.2.8.dist-info/entry_points.txt,sha256=KM3hAPV0ivux3CUx1-pDT0BL1WSUFt2jmT4i_MFbdzc,47
+fairyfly_core-0.2.8.dist-info/top_level.txt,sha256=8ZUsvZOSB3g5enmv1R0vxJilNeW8Uft5KrTL0rUNj7k,9
+fairyfly_core-0.2.8.dist-info/RECORD,,

{fairyfly_core-0.2.6.dist-info → fairyfly_core-0.2.8.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any