Skip to content

Commit

Permalink
update documentation for napoleon
Browse files Browse the repository at this point in the history
  • Loading branch information
cmeeren committed Nov 25, 2015
1 parent e773f8f commit c6e20fa
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions src/apexpy/apex.py
Original file line number Diff line number Diff line change
Expand Up @@ -640,7 +640,7 @@ def map_V_to_height(self, alat, alon, height, newheight, V):
def basevectors_qd(self, lat, lon, height, coords='geo', precision=1e-10):
'''Returns quasi-dipole base vectors f1 and f2 at the specified coordinates.
The vectors are described by Richmond [1995] [1]_ and Emmert et al. [2010] [2]_.
The vectors are described by Richmond [1995] [2]_ and Emmert et al. [2010] [3]_.
Parameters
==========
Expand Down Expand Up @@ -669,11 +669,11 @@ def basevectors_qd(self, lat, lon, height, coords='geo', precision=1e-10):
References
==========
.. [1] Richmond, A. D. (1995), Ionospheric Electrodynamics Using
.. [2] Richmond, A. D. (1995), Ionospheric Electrodynamics Using
Magnetic Apex Coordinates, Journal of geomagnetism and
geoelectricity, 47(2), 191–212, doi:10.5636/jgg.47.191.
.. [2] Emmert, J. T., A. D. Richmond, and D. P. Drob (2010),
.. [3] Emmert, J. T., A. D. Richmond, and D. P. Drob (2010),
A computationally compact representation of Magnetic-Apex
and Quasi-Dipole coordinates with smooth base vectors,
J. Geophys. Res., 115(A8), A08322, doi:10.1029/2010JA015326.
Expand All @@ -695,7 +695,7 @@ def basevectors_qd(self, lat, lon, height, coords='geo', precision=1e-10):
def basevectors_apex(self, lat, lon, height, coords='geo', precision=1e-10):
'''Returns base vectors in quasi-dipole and apex coordinates.
The vectors are described by Richmond [1995] [1]_ and Emmert et al. [2010] [2]_.
The vectors are described by Richmond [1995] [4]_ and Emmert et al. [2010] [5]_.
Parameters
==========
Expand Down Expand Up @@ -730,9 +730,9 @@ def basevectors_apex(self, lat, lon, height, coords='geo', precision=1e-10):
Note
====
`f3`, `g1`, `g2`, and `g3` are not part of the Fortran code
by Emmert et al. [2010] [2]_. They are calculated by this
by Emmert et al. [2010] [5]_. They are calculated by this
Python library according to the following equations in
Richmond [1995] [1]_:
Richmond [1995] [4]_:
* `g1`: Eqn. 6.3
* `g2`: Eqn. 6.4
Expand All @@ -742,11 +742,11 @@ def basevectors_apex(self, lat, lon, height, coords='geo', precision=1e-10):
References
==========
.. [1] Richmond, A. D. (1995), Ionospheric Electrodynamics Using
.. [4] Richmond, A. D. (1995), Ionospheric Electrodynamics Using
Magnetic Apex Coordinates, Journal of geomagnetism and
geoelectricity, 47(2), 191–212, doi:10.5636/jgg.47.191.
.. [2] Emmert, J. T., A. D. Richmond, and D. P. Drob (2010),
.. [5] Emmert, J. T., A. D. Richmond, and D. P. Drob (2010),
A computationally compact representation of Magnetic-Apex
and Quasi-Dipole coordinates with smooth base vectors,
J. Geophys. Res., 115(A8), A08322, doi:10.1029/2010JA015326.
Expand Down

0 comments on commit c6e20fa

Please sign in to comment.