Commit d67241e3 authored by Stefan Mauerberger's avatar Stefan Mauerberger
Browse files

Minor doc-string fixes

parent 66f95bbd
......@@ -169,13 +169,14 @@ def field(z_at, splines):
Parameters
----------
z_at : array-like of shape (4, n) in fortran order
z_at : array-like of shape (4, n) in Fortran order
the locations at which to evaluate the splines. should be as expected
by pyfield, i.e.
z_at[0] contains co-latitudes in degrees
z_at[1] contains longitudes in degrees
z_at[2] contains radii in km
z_at[3] contains dates in years
* z_at[0] contains co-latitudes in degrees
* z_at[1] contains longitudes in degrees
* z_at[2] contains radii in km
* z_at[3] contains dates in years
splines : scipy.interpolate.BSpline
the splines specifying the model
......
......@@ -57,13 +57,16 @@ def nez2dif(n, e, z):
def equi_sph(n, twopi=True):
''' Regularly place points on the surface of the unit sphere. the number of
output points may differ from n
''' Regularly place points on the surface of the unit sphere [1]_. the number of
output points may differ from n ...
.. todo:: Return a ndarray rather than using generators.
Import equi_sph from pyfield
References
----------
[1] M. Deserno, "How to generate equidistributed points on the surface of a
sphere", Max-Planck-Institut für Polymerforschung, 2004.
.. [1] M. Deserno, "How to generate equidistributed points on the surface
of a sphere", Max-Planck-Institut für Polymerforschung, 2004.
'''
a = 4*np.pi/n
d = np.sqrt(a)
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment