Skip to content

Commit 795ee58

Browse files
committed
doc
1 parent bb5ae2d commit 795ee58

File tree

2 files changed

+6
-11
lines changed

2 files changed

+6
-11
lines changed

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,13 @@ MatMap3D is setup as a
1515
which means `import matmap3d` statements allow scoped use of this code.
1616

1717
```matlab
18-
import matmap3d.*
19-
% or add matmap3d. to start of function name
2018
21-
[x,y,z] = geodetic2ecef([],lat,lon,alt)
19+
[x,y,z] = matmap3d.geodetic2ecef([],lat,lon,alt)
2220
23-
[az,el,range] = geodetic2aer(lat, lon, alt, observer_lat, observer_lon, observer_alt)
21+
[az,el,range] = matmap3d.geodetic2aer(lat, lon, alt, observer_lat, observer_lon, observer_alt)
2422
```
2523

26-
Optionally, verify functionality:
24+
Optionally, run self-tests:
2725

2826
```matlab
2927
buildtool
@@ -55,16 +53,14 @@ These functions present a similar API of a subset of functions in the Mathworks
5553

5654
## Notes
5755

58-
The full set of Python conversions are accessed from Matlab ≥ R2014b by commands like:
56+
Python PyMap3d has more conversions.
57+
PyMap3d can be accessed from Matlab by commands like:
5958

6059
```matlab
6160
lla = py.pymap3d.geodetic2ecef(x,y,z)
6261
```
6362

64-
If using `conda` environment to install `pymap3d`, you will need to follow these instructions to make it load:
65-
https://www.mathworks.com/matlabcentral/answers/443558-matlab-crashes-when-using-conda-environment-other-than-base#answer_486374
66-
67-
In particular, since PyMap3D uses Astropy for ECI transformations the accuracy will generally be better for eci2* or *2eci functions.
63+
In particular, since PyMap3D uses Astropy for ECI transformations the accuracy will generally be better for `eci2*` or `*2eci` functions.
6864
All other functions should have equivalent accuracy with Matlab vs. Python.
6965

7066
### GNU Octave

codemeta.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
"downloadUrl": "https://github.com/geospace-code/matmap3d/releases",
99
"issueTracker": "https://github.com/geospace-code/matmap3d/issues",
1010
"name": "matmap3d",
11-
"version": "2.0.0",
1211
"identifier": "10.5281/zenodo.3966173",
1312
"description": "Matlab / GNU Octave coordinate conversions for geospace ecef enu eci. Similar to Python PyMap3D.",
1413
"applicationCategory": "compuation",

0 commit comments

Comments
 (0)