Commit f1a3ba54 authored by Maximilian Schanner's avatar Maximilian Schanner
Browse files

Correct documentation of equi_sph. Fix #21.

parent 1b8f1456
Changelog
=========
2021-10-20 v1.1.1
-----------------
* Correct documentation of equi_sph
2021-08-25 v1.1.0
-----------------
* Add geodetic->geocentric conversion for coordinates
......
......@@ -29,14 +29,14 @@ used in the geomagnetism community to evaluate global field models. It can be
applied to all cubic-spline based geomagnetic field models stored in the same
file format as gufm1 or the CALSxk model series.
The package exposes several methods that can be applied to models or splines
representing a model. To acces the models, use the `Model` class or its
attribute `Model.splines`. With the `models` dictionary, several built-in
models can be accessed, see also the `list of included models
The package exposes several methods that can be applied to models or splines representing
a model. To acces the models, use the `Model` class or its attribute
`Model.splines`. With the `models` dictionary, several built-in models can be
accessed, see also the `list of included models
<overview.html#included-models>`__.
'''
# expose only utilities and core members
# expose only utilities and core modules
__all__ = ['local_curve', 'dipole_series', 'file2splines', 'field',
'built_in_models', 'coefficients', 'utils', 'secular_variation',
'power_spectrum', 'Model']
......@@ -46,4 +46,4 @@ from pymagglobal.core import local_curve, dipole_series, file2splines, \
Model
from pymagglobal import utils
__version__ = '1.1.0'
__version__ = '1.1.1'
......@@ -293,9 +293,9 @@ def equi_sph(n, twopi=True):
Returns
-------
array of shape (2, n')
azimutal and longitudinal angles in radians of n' points, that are
equally spaced on the sphere. n' is approximately n.
array of shape (2, m)
polar and azimutal angles in radians of m points, that are
equally spaced on the sphere. m is approximately n.
References
----------
......@@ -373,7 +373,7 @@ class WGS84(object):
def _geodetic2geocentric(lat, alt, ellipsoid=WGS84()):
''' From geodetic latitude and altitude calculate the geocentric latitude
and radius.
and radius. The algorithm can be found in ISO 16695.
Parameters
----------
......
Markdown is supported
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