Skip to content

Commit f723406

Browse files
Updated documentation
1 parent bc0cb08 commit f723406

File tree

2 files changed

+191
-0
lines changed

2 files changed

+191
-0
lines changed

docs/src/api/api.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
2+
# [Public Documentation](@id iers_api)
3+
4+
## [IERS Models](@id iers_models)
5+
6+
This is a list of the supported IERS models and their approximations that can be used to
7+
selected the algorithm associated to a specific IERS convention.
8+
9+
### 2010 Conventions
10+
11+
```@docs
12+
iers2010a
13+
iers2010b
14+
15+
CPNc
16+
CPNd
17+
```
18+
19+
### 2003 Conventions
20+
21+
```@docs
22+
iers2003a
23+
iers2003b
24+
```
25+
26+
### 1996 Conventions
27+
28+
```@docs
29+
iers1996
30+
```
31+
32+
## Rotations
33+
34+
### CIO-based rotations
35+
```@docs
36+
iers_rot3_gcrf_to_cirf
37+
iers_rot3_gcrf_to_itrf
38+
iers_rot3_gcrf_to_tirf
39+
iers_rot3_itrf_to_cirf
40+
iers_rot3_itrf_to_tirf
41+
```
42+
43+
### Equinox-based rotations
44+
```@docs
45+
iers_rot3_gcrf_to_gtod
46+
iers_rot3_gcrf_to_mod
47+
iers_rot3_gcrf_to_pef
48+
iers_rot3_gcrf_to_tod
49+
iers_rot3_itrf_to_mod
50+
iers_rot3_itrf_to_tod
51+
iers_rot3_itrf_to_gtod
52+
iers_rot3_itrf_to_pef
53+
```
54+
55+
## Bias, Precession and Nutation
56+
57+
```@docs
58+
iers_bias
59+
iers_nutation
60+
iers_nutation_comp
61+
iers_obliquity
62+
iers_precession
63+
iers_pb
64+
iers_npb
65+
```
66+
67+
## Celestial Intermediate Pole
68+
69+
```@docs
70+
iers_cip_motion
71+
cip_xy
72+
cip_xys
73+
cip_vector
74+
```
75+
76+
## Earth Rotation and Sidereal Time
77+
78+
```@docs
79+
iers_era
80+
iers_era_rotm
81+
82+
iers_gmst
83+
iers_gast
84+
```
85+
86+
## Polar Motion
87+
88+
```@docs
89+
iers_polar_motion
90+
```
91+
92+
## [EOP Data](@id eop_data)
93+
94+
```@docs
95+
eop_filename
96+
eop_load_data!
97+
eop_parse_csv
98+
```

docs/src/api/lapi.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
2+
## Fundamental Arguments
3+
4+
### Delaunay's Arguments
5+
6+
```@docs
7+
IERSConventions.DelaunayArgs
8+
IERSConventions.delaunay_anomaly_moon
9+
IERSConventions.delaunay_anomaly_sun
10+
IERSConventions.delaunay_longitude_diff
11+
IERSConventions.delaunay_elongation_moon
12+
IERSConventions.delaunay_longitude_node
13+
```
14+
15+
### Planetary Arguments
16+
17+
```@docs
18+
IERSConventions.PlanetaryArgs
19+
IERSConventions.pa_mercury
20+
IERSConventions.pa_venus
21+
IERSConventions.pa_earth
22+
IERSConventions.pa_mars
23+
IERSConventions.pa_jupiter
24+
IERSConventions.pa_saturn
25+
IERSConventions.pa_uranus
26+
IERSConventions.pa_neptune
27+
IERSConventions.pa_precession
28+
```
29+
30+
## Fukushima-Williams
31+
```@docs
32+
IERSConventions.fw2xy
33+
IERSConventions.fw_angles
34+
IERSConventions.fw_matrix
35+
```
36+
37+
## Earth Orientation Parameters
38+
39+
### Constants
40+
```@docs
41+
IERSConventions.NutationCorrections
42+
IERSConventions.set_nutation_corr!
43+
IERSConventions.NutCorrectionsInterpolator
44+
IERSConventions.EOPData
45+
IERSConventions.EOPInterpolator
46+
IERSConventions.IERS_EOP
47+
IERSConventions.IERS_EOP_DATA
48+
```
49+
50+
### Loading
51+
```@docs
52+
IERSConventions.eop_read_data
53+
IERSConventions.eop_set_data!
54+
```
55+
56+
### Parsing
57+
```@docs
58+
IERSConventions.eop_write_data
59+
IERSConventions.δnut_to_δcip
60+
IERSConventions.δcip_to_δnut
61+
```
62+
63+
### Interpolation Functions
64+
```@docs
65+
IERSConventions.eop_δΔψ
66+
IERSConventions.eop_δΔϵ
67+
IERSConventions.eop_δX
68+
IERSConventions.eop_δY
69+
IERSConventions.eop_xp
70+
IERSConventions.eop_yp
71+
IERSConventions.offset_tt2ut1
72+
```
73+
74+
## Poisson Series
75+
```@docs
76+
IERSConventions.PoissonSeries
77+
IERSConventions.NutationDataParser
78+
IERSConventions.CIODataParser
79+
IERSConventions.parse_iers_constants
80+
IERSConventions.generate_iers_file
81+
```
82+
83+
## Miscellaneous
84+
```@docs
85+
IERSConventions.cio_locator
86+
IERSConventions.equation_equinoxes
87+
IERSConventions.eeq_complementary
88+
IERSConventions.npb2xy
89+
IERSConventions.precession_angles_rot3
90+
IERSConventions.precession_angles_rot4
91+
IERSConventions.tio_locator
92+
IERSConventions.xys2m
93+
```

0 commit comments

Comments
 (0)