Skip to content

Commit 7c1fd93

Browse files
committed
Updated header + examples.
1 parent 1873a4f commit 7c1fd93

File tree

3 files changed

+20
-13
lines changed

3 files changed

+20
-13
lines changed

EXAMPLES.mlx

394 Bytes
Binary file not shown.

background.m

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,28 @@
55
% background(spec)
66
%
77
% Copyright (c) 2021 Tamas Kis
8-
% Last Update: 2021-05-31
8+
% Last Update: 2021-06-01
99
%
1010
%--------------------------------------------------------------------------
1111
%
1212
% MATLAB Central File Exchange: https://www.mathworks.com/matlabcentral/fileexchange/86483-3d-earth-and-celestial-bodies-planet3d
1313
% GitHub: https://github.com/tamaskis/planet3D-MATLAB
1414
%
1515
% See "DOCUMENTATION.pdf" for additional documentation and examples.
16-
% Examples can also be found in EXAMPLES.m. Both of these files are
16+
% Examples can also be found in EXAMPLES.mlx. Both of these files are
1717
% included with the download.
1818
%
1919
%--------------------------------------------------------------------------
2020
%
21+
% -------
2122
% INPUTS:
23+
% -------
2224
% spec 'Black', 'Stars', or 'Milky Way'
2325
%
24-
% NOTE: The function call on "background" MUST occur before the function
26+
% -----
27+
% NOTE:
28+
% -----
29+
% --> The function call on "background" MUST occur before the function
2530
% call on "planet3D".
2631
%
2732
%==========================================================================

planet3D.m

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,36 +9,38 @@
99
% GitHub: https://github.com/tamaskis/planet3D-MATLAB
1010
%
1111
% See "DOCUMENTATION.pdf" for additional documentation and examples.
12-
% Examples can also be found in EXAMPLES.m. Both of these files are
12+
% Examples can also be found in EXAMPLES.mlx. Both of these files are
1313
% included with the download.
1414
%
1515
% Copyright (c) 2021 Tamas Kis
16-
% Last Update: 2021-05-31
16+
% Last Update: 2021-06-01
1717
%
1818
%--------------------------------------------------------------------------
1919
%
20+
% -------
2021
% INPUTS:
22+
% -------
2123
% planet 'Sun', 'Moon', 'Mercury', 'Venus', 'Earth',
2224
% 'Earth Cloudy', 'Earth Night', 'Earth Night Cloudy',
2325
% 'Mars', 'Jupiter', 'Saturn', 'Uranus', 'Neptune', or
2426
% or 'Pluto'
25-
% position (OPTIONAL) position of planet's geometric center (3x1
26-
% double)
27-
% gmst (OPTIONAL) Greenwich mean sidereal time (1x1 double)
28-
% [deg]
27+
% position (OPTIONAL) (3x1) position of planet's geometric center
28+
% gmst (OPTIONAL) (1x1) [deg] Greenwich mean sidereal time
2929
% reference_plane (OPTIONAL) 'equatorial' or 'ecliptic'
3030
% units (OPTIONAL) 'km', 'AU', 'm', 'ft', 'mi', or 'nmi'
31-
% transparency (OPTIONAL) 0 for 100% transparent, 1 for 100% solid
31+
% transparency (OPTIONAL) 0 for 100% transparency, 1 for 100% opacity
3232
%
33-
% NOTE: All parameters except for "planet" are optional. If you "skip over"
33+
% -----
34+
% NOTE:
35+
% -----
36+
% --> All parameters except for "planet" are optional. If you "skip over"
3437
% parameters, you need to use empty bracket (i.e. "[]") as
3538
% placeholders, otherwise you can emit parameters altogether. For
3639
% example, if you don't want to specify "position", but do want to
3740
% specify "units", then you would use the syntax "planet3D(planet,...
3841
% [],[],[],units)". Alternatively, if we wanted to specify just the
3942
% "position", we could use the syntax "planet3D(planet,position)".
40-
%
41-
% NOTE: Use the "background" function included with download to set the
43+
% --> Use the "background" function included with download to set the
4244
% plot background. When using "background" to set the plot
4345
% background, the function call on "background" must occur BEFORE the
4446
% function call on "planet3D", otherwise the background will be

0 commit comments

Comments
 (0)