Skip to content

Commit a65e225

Browse files
committed
Merge branch 'master' of https://github.com/scivision/pymap3d
2 parents 8d18ca8 + 6b11a8e commit a65e225

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
# Python 3-D coordinate conversions
1414

15-
Pure Python (no prerequistes beyond Python itself) 3-D geographic coordinate conversions.
15+
Pure Python (no prerequistes beyond Python itself) 3-D geographic coordinate conversions and geodesy.
1616
API similar to popular $1000 Matlab Mapping Toolbox routines for:
1717

1818
* Python
@@ -49,7 +49,7 @@ pip install -e pymap3d
4949

5050
One can verify Python functionality after installation by:
5151
```sh
52-
pytest -r a -v
52+
pytest pymap3d -r a -v
5353
```
5454

5555
## Usage
@@ -97,12 +97,15 @@ converted to the desired coordinate system:
9797
azel2radec radec2azel
9898
vreckon vdist
9999
lookAtSpheroid
100-
track2
100+
track2 departure meanm
101+
rcurve rsphere
101102

102103

103104
Additional functions:
104105

105-
`loxodrome_inverse`: rhumb line distance and azimuth between ellipsoid points (lat,lon) akin to Matlab `distance('rh', ...)` and `azimuth('rh', ...)`
106+
* loxodrome_inverse: rhumb line distance and azimuth between ellipsoid points (lat,lon) akin to Matlab `distance('rh', ...)` and `azimuth('rh', ...)`
107+
* loxodrome_direct
108+
* geodetic latitude transforms to/from: parametric, authalic, isometric, and more in pymap3d.latitude
106109

107110

108111
Abbreviations:
@@ -114,6 +117,18 @@ Abbreviations:
114117
* [NED: North East Down](https://en.wikipedia.org/wiki/North_east_down)
115118
* [radec: right ascension, declination](https://en.wikipedia.org/wiki/Right_ascension)
116119

120+
### array vs scalar
121+
122+
Use of pymap3d on embedded systems or other streaming data applications often deal with scalar position data.
123+
These data are handled efficiently with the Python math stdlib module.
124+
Vector data can be handled via list comprehension.
125+
126+
Those needing multidimensional data with SIMD and other Numpy and/or PyPy accelerated performance can do so automatically by installing Numpy.
127+
pymap3d seamlessly falls back to Python's math module if Numpy isn't present.
128+
To keep the code clean, only scalar data can be used without Numpy.
129+
As noted above, use list comprehension if you need vector data without Numpy.
130+
131+
117132
### Caveats
118133

119134
* Atmospheric effects neglected in all functions not invoking AstroPy.

0 commit comments

Comments
 (0)