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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
topologicpy/Sun.py CHANGED
@@ -42,7 +42,7 @@ class Sun():
42
42
  latitude : float
43
43
  The input latitude.
44
44
  year : integer , optional
45
- The input year. The default is the current year.
45
+ The input year. Default is the current year.
46
46
 
47
47
  Returns
48
48
  -------
@@ -85,7 +85,7 @@ class Sun():
85
85
  latitude : float
86
86
  The input latitude.
87
87
  year : integer , optional
88
- The input year. The default is the current year.
88
+ The input year. Default is the current year.
89
89
 
90
90
  Returns
91
91
  -------
@@ -126,7 +126,7 @@ class Sun():
126
126
  latitude : float
127
127
  The input latitude.
128
128
  year : integer , optional
129
- The input year. The default is the current year.
129
+ The input year. Default is the current year.
130
130
 
131
131
  Returns
132
132
  -------
@@ -166,7 +166,7 @@ class Sun():
166
166
  latitude : float
167
167
  The input latitude. See https://en.wikipedia.org/wiki/Latitude.
168
168
  year : integer , optional
169
- The input year. The default is the current year.
169
+ The input year. Default is the current year.
170
170
 
171
171
  Returns
172
172
  -------
@@ -393,7 +393,7 @@ class Sun():
393
393
  date : datetime
394
394
  The input datetime.
395
395
  north : float, optional
396
- The desired compass angle of the north direction. The default is 0 which points in the positive Y-axis direction.
396
+ The desired compass angle of the north direction. Default is 0 which points in the positive Y-axis direction.
397
397
 
398
398
  Returns
399
399
  -------
@@ -420,13 +420,13 @@ class Sun():
420
420
  date : datetime
421
421
  The input datetime.
422
422
  origin : topologic.Vertex , optional
423
- The desired origin of the world. If set to None, the origin will be set to (0,0,0). The default is None.
423
+ The desired origin of the world. If set to None, the origin will be set to (0,0,0). Default is None.
424
424
  radius : float , optional
425
- The desired radius of the sun orbit. The default is 0.5.
425
+ The desired radius of the sun orbit. Default is 0.5.
426
426
  north : float, optional
427
- The desired compass angle of the north direction. The default is 0 which points in the positive Y-axis direction.
427
+ The desired compass angle of the north direction. Default is 0 which points in the positive Y-axis direction.
428
428
  mantissa : int , optional
429
- The desired length of the mantissa. The default is 6.
429
+ The number of decimal places to round the result to. Default is 6.
430
430
 
431
431
 
432
432
  Returns
@@ -452,11 +452,11 @@ class Sun():
452
452
  date : datetime
453
453
  The input datetime.
454
454
  origin : topologic.Vertex , optional
455
- The desired origin of the world. If set to None, the origin will be set to (0,0,0). The default is None.
455
+ The desired origin of the world. If set to None, the origin will be set to (0,0,0). Default is None.
456
456
  radius : float , optional
457
- The desired radius of the sun orbit. The default is 0.5.
457
+ The desired radius of the sun orbit. Default is 0.5.
458
458
  north : float, optional
459
- The desired compass angle of the north direction. The default is 0 which points in the positive Y-axis direction.
459
+ The desired compass angle of the north direction. Default is 0 which points in the positive Y-axis direction.
460
460
 
461
461
  Returns
462
462
  -------
@@ -487,11 +487,11 @@ class Sun():
487
487
  date : datetime
488
488
  The input datetime.
489
489
  origin : topologic.Vertex , optional
490
- The desired origin of the world. If set to None, the origin will be set to (0,0,0). The default is None.
490
+ The desired origin of the world. If set to None, the origin will be set to (0,0,0). Default is None.
491
491
  radius : float , optional
492
- The desired radius of the sun orbit. The default is 0.5.
492
+ The desired radius of the sun orbit. Default is 0.5.
493
493
  north : float, optional
494
- The desired compass angle of the north direction. The default is 0 which points in the positive Y-axis direction.
494
+ The desired compass angle of the north direction. Default is 0 which points in the positive Y-axis direction.
495
495
 
496
496
  Returns
497
497
  -------
@@ -524,17 +524,17 @@ class Sun():
524
524
  date : datetime
525
525
  The input datetime.
526
526
  startTime : datetime , optional
527
- The desired start time to compute the sun location. If set to None, Sun.Sunrise is used. The default is None.
527
+ The desired start time to compute the sun location. If set to None, Sun.Sunrise is used. Default is None.
528
528
  endTime : datetime , optional
529
- The desired end time to compute the sun location. If set to None, Sun.Sunset is used. The default is None.
529
+ The desired end time to compute the sun location. If set to None, Sun.Sunset is used. Default is None.
530
530
  interval : int , optional
531
- The interval in minutes to compute the sun location. The default is 60.
531
+ The interval in minutes to compute the sun location. Default is 60.
532
532
  origin : topologic.Vertex , optional
533
- The desired origin of the world. If set to None, the origin will be set to (0,0,0). The default is None.
533
+ The desired origin of the world. If set to None, the origin will be set to (0,0,0). Default is None.
534
534
  radius : float , optional
535
- The desired radius of the sun orbit. The default is 0.5.
535
+ The desired radius of the sun orbit. Default is 0.5.
536
536
  north : float, optional
537
- The desired compass angle of the north direction. The default is 0 which points in the positive Y-axis direction.
537
+ The desired compass angle of the north direction. Default is 0 which points in the positive Y-axis direction.
538
538
 
539
539
  Returns
540
540
  -------
@@ -568,20 +568,20 @@ class Sun():
568
568
  date : datetime
569
569
  The input datetime.
570
570
  startTime : datetime , optional
571
- The desired start time to compute the sun location. If set to None, Sun.Sunrise is used. The default is None.
571
+ The desired start time to compute the sun location. If set to None, Sun.Sunrise is used. Default is None.
572
572
  endTime : datetime , optional
573
- The desired end time to compute the sun location. If set to None, Sun.Sunset is used. The default is None.
573
+ The desired end time to compute the sun location. If set to None, Sun.Sunset is used. Default is None.
574
574
  interval : int , optional
575
- The interval in minutes to compute the sun location. The default is 60.
575
+ The interval in minutes to compute the sun location. Default is 60.
576
576
  origin : topologic.Vertex , optional
577
- The desired origin of the world. If set to None, the origin will be set to (0,0,0). The default is None.
577
+ The desired origin of the world. If set to None, the origin will be set to (0,0,0). Default is None.
578
578
  radius : float , optional
579
- The desired radius of the sun orbit. The default is 0.5.
579
+ The desired radius of the sun orbit. Default is 0.5.
580
580
  sides : int , optional
581
581
  If set to None, the path is divided based on the interval. Otherwise, it is equally divided into the number of sides.
582
582
  The default is None.
583
583
  north : float, optional
584
- The desired compass angle of the north direction. The default is 0 which points in the positive Y-axis direction.
584
+ The desired compass angle of the north direction. Default is 0 which points in the positive Y-axis direction.
585
585
 
586
586
  Returns
587
587
  -------
@@ -630,17 +630,17 @@ class Sun():
630
630
  hour : datetime
631
631
  The input hour.
632
632
  startDay : integer , optional
633
- The desired start day to compute the sun location. The default is 1.
633
+ The desired start day to compute the sun location. Default is 1.
634
634
  endDay : integer , optional
635
- The desired end day to compute the sun location. The default is 365.
635
+ The desired end day to compute the sun location. Default is 365.
636
636
  interval : int , optional
637
- The interval in days to compute the sun location. The default is 5.
637
+ The interval in days to compute the sun location. Default is 5.
638
638
  origin : topologic.Vertex , optional
639
- The desired origin of the world. If set to None, the origin will be set to (0,0,0). The default is None.
639
+ The desired origin of the world. If set to None, the origin will be set to (0,0,0). Default is None.
640
640
  radius : float , optional
641
- The desired radius of the sun orbit. The default is 0.5.
641
+ The desired radius of the sun orbit. Default is 0.5.
642
642
  north : float, optional
643
- The desired compass angle of the north direction. The default is 0 which points in the positive Y-axis direction.
643
+ The desired compass angle of the north direction. Default is 0 which points in the positive Y-axis direction.
644
644
 
645
645
  Returns
646
646
  -------
@@ -681,20 +681,20 @@ class Sun():
681
681
  hour : datetime
682
682
  The input hour.
683
683
  startDay : integer , optional
684
- The desired start day of the year to compute the sun location. The default is 1.
684
+ The desired start day of the year to compute the sun location. Default is 1.
685
685
  endDay : integer , optional
686
- The desired end day of the year to compute the sun location. The default is 365.
686
+ The desired end day of the year to compute the sun location. Default is 365.
687
687
  interval : int , optional
688
- The interval in days to compute the sun location. The default is 5.
688
+ The interval in days to compute the sun location. Default is 5.
689
689
  origin : topologic.Vertex , optional
690
- The desired origin of the world. If set to None, the origin will be set to (0,0,0). The default is None.
690
+ The desired origin of the world. If set to None, the origin will be set to (0,0,0). Default is None.
691
691
  radius : float , optional
692
- The desired radius of the sun orbit. The default is 0.5.
692
+ The desired radius of the sun orbit. Default is 0.5.
693
693
  sides : int , optional
694
694
  If set to None, the path is divided based on the interval. Otherwise, it is equally divided into the number of sides.
695
695
  The default is None.
696
696
  north : float, optional
697
- The desired compass angle of the north direction. The default is 0 which points in the positive Y-axis direction.
697
+ The desired compass angle of the north direction. Default is 0 which points in the positive Y-axis direction.
698
698
 
699
699
  Returns
700
700
  -------
@@ -738,19 +738,19 @@ class Sun():
738
738
  longitude : float
739
739
  The input longitude. See https://en.wikipedia.org/wiki/Longitude.
740
740
  minuteInterval : int , optional
741
- The interval in minutes to compute the sun location for the date path. The default is 30.
741
+ The interval in minutes to compute the sun location for the date path. Default is 30.
742
742
  dayInterval : int , optional
743
- The interval in days for the hourly path to compute the sun location. The default is 15.
743
+ The interval in days for the hourly path to compute the sun location. Default is 15.
744
744
  origin : topologic.Vertex , optional
745
- The desired origin of the world. If set to None, the origin will be set to (0,0,0). The default is None.
745
+ The desired origin of the world. If set to None, the origin will be set to (0,0,0). Default is None.
746
746
  radius : float , optional
747
- The desired radius of the sun orbit. The default is 0.5.
747
+ The desired radius of the sun orbit. Default is 0.5.
748
748
  uSides : int , optional
749
- The number of sides to divide the diagram horizontally (along the azimuth). The default is 180.
749
+ The number of sides to divide the diagram horizontally (along the azimuth). Default is 180.
750
750
  vSides : int , optional
751
- The number of sides to divide the diagram paths vertically (along the altitude). The default is 180.
751
+ The number of sides to divide the diagram paths vertically (along the altitude). Default is 180.
752
752
  north : float, optional
753
- The desired compass angle of the north direction. The default is 0 which points in the positive Y-axis direction.
753
+ The desired compass angle of the north direction. Default is 0 which points in the positive Y-axis direction.
754
754
  compass : bool , optional
755
755
  If set to True, a compass (shell) is included. Othwerwise, it is is not.
756
756
  shell : bool , optional