Skip to content

Commit cb9aaa0

Browse files
author
Paul Kienzle
committed
include special.fibonacci in the docs
1 parent 8ef3afc commit cb9aaa0

2 files changed

Lines changed: 7 additions & 0 deletions

File tree

doc/genapi.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ def genfiles(package, package_name, modules, dir='api'):
9191
('sasview_model', 'Sasview interface'),
9292
('sesans', 'SESANS calculation routines'),
9393
('special', 'Special functions library'),
94+
('special.fibonacci', 'Fibonacci spiral spherical integration'),
9495
('weights', 'Distribution functions'),
9596
]
9697
package = 'sasmodels'

sasmodels/special/fibonacci.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,16 @@ def fibonacci_sphere(npoints_fibonacci: int):
1818
"""
1919
Generates npoints quasi-uniformly distributed on the unit sphere
2020
in Cartesian coordinates (x,y,z) and their associated weights.
21+
2122
Parameters
2223
----------
24+
2325
npoints : int
2426
Number of points to generate.
27+
2528
Returns
2629
-------
30+
2731
points : ndarray, shape (npoints, 3)
2832
Cartesian coordinates of the points on the unit sphere.
2933
weights : ndarray, shape (npoints,)
@@ -45,8 +49,10 @@ def fibonacci_sphere(npoints_fibonacci: int):
4549
def plot_fibonacci_sphere(npoints_fibonacci=500, figsize=(7, 7)):
4650
"""
4751
3D representation of Fibonacci points on the unit sphere.
52+
4853
Parameters
4954
----------
55+
5056
npoints : int
5157
Number of points to generate and display.
5258
figsize : tuple

0 commit comments

Comments
 (0)