Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
scivision committed Mar 5, 2019
1 parent 607203d commit aea8e81
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 25 deletions.
12 changes: 6 additions & 6 deletions pymap3d/aer.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ def ecef2aer(x: float, y: float, z: float,
lat0: float, lon0: float, h0: float,
ell=None, deg: bool = True) -> Tuple[float, float, float]:
"""
`ecef2aer` gives azimuth, elevation and slant range from an Observer to a Point with ECEF coordinates.
gives azimuth, elevation and slant range from an Observer to a Point with ECEF coordinates.
ECEF input location is with units of meters
Expand Down Expand Up @@ -50,7 +50,7 @@ def geodetic2aer(lat: float, lon: float, h: float,
lat0: float, lon0: float, h0: float,
ell=None, deg: bool = True) -> Tuple[float, float, float]:
"""
`geodetic2aer` gives azimuth, elevation and slant range from an Observer to a Point with geodetic coordinates.
gives azimuth, elevation and slant range from an Observer to a Point with geodetic coordinates.
Parameters
Expand Down Expand Up @@ -92,7 +92,7 @@ def aer2geodetic(az: float, el: float, srange: float,
ell=None,
deg: bool = True) -> Tuple[float, float, float]:
"""
`aer2geodetic` gives geodetic coordinates of a point with az, el, range
gives geodetic coordinates of a point with az, el, range
from an observer at lat0, lon0, h0
Expand Down Expand Up @@ -137,7 +137,7 @@ def eci2aer(eci: Tuple[float, float, float],
t: datetime,
useastropy: bool = True) -> Tuple[float, float, float]:
"""
`eci2aer` takes ECI coordinates of point and gives az, el, slant range from Observer
takes ECI coordinates of point and gives az, el, slant range from Observer
## Inputs
Expand Down Expand Up @@ -172,7 +172,7 @@ def aer2eci(az: float, el: float, srange: float,
ell=None, deg: bool = True,
useastropy: bool = True) -> np.ndarray:
"""
`aer2eci` gives ECI of a point from an observer at az, el, slant range
gives ECI of a point from an observer at az, el, slant range
Parameters
----------
Expand Down Expand Up @@ -213,7 +213,7 @@ def aer2ecef(az: float, el: float, srange: float,
lat0: float, lon0: float, alt0: float,
ell=None, deg: bool = True) -> Tuple[float, float, float]:
"""
`aer2ecef` converts target azimuth, elevation, range from observer at lat0,lon0,alt0 to ECEF coordinates.
converts target azimuth, elevation, range from observer at lat0,lon0,alt0 to ECEF coordinates.
Parameters
----------
Expand Down
58 changes: 40 additions & 18 deletions pymap3d/azelradec.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,27 @@ def azel2radec(az_deg: float, el_deg: float,
"""
viewing angle (az, el) to sky coordinates (ra, dec)
inputs
------
azimuth: degrees clockwize from North
elevation: degrees above horizon (neglecting aberration)
observer latitude [-90, 90], longitude [-180, 180] (degrees)
time: datetime of observation
Outputs
Parameters
----------
az_deg : float
azimuth [degrees clockwize from North]
el_deg : float
elevation [degrees above horizon (neglecting aberration)]
lat_deg : float
observer latitude [-90, 90]
lon_deg : float
observer longitude [-180, 180] (degrees)
time : datetime.datetime
time of observation
usevallado : bool, optional
default use astropy. If true, use Vallado algorithm
Returns
-------
ecliptic right ascension, declination (degrees)
ra_deg : float
ecliptic right ascension (degress)
dec_deg : float
ecliptic declination (degrees)
"""

if usevallado or Time is None: # non-AstroPy method, less accurate
Expand All @@ -51,16 +62,27 @@ def radec2azel(ra_deg: float, dec_deg: float,
"""
sky coordinates (ra, dec) to viewing angle (az, el)
inputs
------
ecliptic right ascension, declination (degrees)
observer latitude [-90, 90], longitude [-180, 180] (degrees)
time: datetime of observation
Outputs
Parameters
----------
ra_deg : float
ecliptic right ascension (degress)
dec_deg : float
ecliptic declination (degrees)
lat_deg : float
observer latitude [-90, 90]
lon_deg : float
observer longitude [-180, 180] (degrees)
time : datetime.datetime
time of observation
usevallado : bool, optional
default use astropy. If true, use Vallado algorithm
Returns
-------
azimuth: degrees clockwize from North
elevation: degrees above horizon (neglecting aberration)
az_deg : float
azimuth [degrees clockwize from North]
el_deg : float
elevation [degrees above horizon (neglecting aberration)]
"""

if usevallado or Time is None:
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = pymap3d
version = 1.7.13
version = 1.7.14
author = Michael Hirsch, Ph.D.
author_email = [email protected]
description = pure Python coordinate conversions, following convention of several popular Matlab routines.
Expand Down

0 comments on commit aea8e81

Please sign in to comment.