Skip to content

Commit 2fd922e

Browse files
committed
Move doc to SuperNOVAS.home repo
1 parent ee271f6 commit 2fd922e

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The primary goals of SuperNOVAS is to improve on the stock NOVAS C library by:
4242
- Fixing [outstanding issues](#fixed-issues)
4343
- Improving the ease of use by using `enum`s instead of integer constants, which also allows for some checking
4444
of use during compilations (such as using the incorrect `enum` type).
45-
- Improving [API documentation](https://smithsonian.github.io/supernovas.github.io/apidoc/html/) with
45+
- Improving [API documentation](https://smithsonian.github.io/SuperNOVAS.home/apidoc/html/) with
4646
[Doxygen](https://www.doxygen.nl/) to provide browsable cross-referenced API docs.
4747
- Streamlining calculations where possible
4848
- Adding `const` modifier to prototype arguments where appropriate
@@ -74,9 +74,9 @@ Outside contributions are very welcome. See how you can contribute
7474

7575
Here are some links to SupeNOVAS related content online:
7676

77-
- [API Documentation](https://smithsonian.github.io/supernovas.github.io/apidoc/html/)
77+
- [API Documentation](https://smithsonian.github.io/SuperNOVAS.home/apidoc/html/)
7878
- [Project site](https://github.com/Smithsonian/SuperNOVAS/) on GitHUB.
79-
- [SuperNOVAS page](https://smithsonian.github.io/supernovas.github.io) page on github.io.
79+
- [SuperNOVAS page](https://smithsonian.github.io/SuperNOVAS.home) page on github.io.
8080
- [How to Contribute](https://github.com/Smithsonian/SuperNOVAS/CONTRIBUTING.md) guide
8181
- The [NOVAS](https://aa.usno.navy.mil/software/novas_info) home page at the US Naval Observatory.
8282
- The [NOVAS C](https://aa.usno.navy.mil/software/novasc_intro) library page.
@@ -135,7 +135,7 @@ practical considerations before that level of accuracy is reached.
135135
small irregular variations in the orientation of the rotational axis and the rotation period, which are referred to
136136
as the polar wobble. The [IERS Bulletins](https://www.iers.org/IERS/EN/Publications/Bulletins/bulletins.html)
137137
provide up-to-date measurements, historical data and and near-term projections for the polar offsets and the
138-
UT1-UTC time difference and leap-seconds. In SuperNOVAS you can use `cel_pole()` and `ut1_to_tt()` functions to
138+
UT1-UTC time difference and leap-seconds. In SuperNOVAS you can use `cel_pole()` and `get_ut1_to_tt()` functions to
139139
apply / use the published values from these to improve the astrometic precision of calls such as `calc_pos()`, or
140140
`topo_star()`. Without setting and using the polar offset parameters, positions for Earth-based observations will
141141
be accurate at the arcsecond level only.

include/novas.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -672,7 +672,7 @@ int radec2vector(double ra, double dec, double dist, double *vector);
672672

673673
int starvectors(const cat_entry *star, double *pos, double *vel);
674674

675-
double ut1_to_tt(int leap_seconds, double dut1);
675+
double get_ut12tt(int leap_seconds, double dut1);
676676

677677
int tdb2tt(double tdb_jd, double *tt_jd, double *secdiff);
678678

src/novas.c

+10-10
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,7 @@ int set_planet_calc_hp(novas_planet_calculator_hp f) {
356356
*
357357
* @sa calc_planet_pos()
358358
* @sa calc_star_pos()
359-
* @sa ut1_to_tt()
359+
* @sa get_ut1_to_tt()
360360
*
361361
*
362362
* @author Attila Kovacs
@@ -445,7 +445,7 @@ int calc_frame_pos(const object *source, const astro_frame *frame, enum novas_ac
445445
* is invalid, or an error code <10 if from function place().
446446
*
447447
* @sa calc_frame_pos()
448-
* @sa ut1_to_tt()
448+
* @sa get_ut1_to_tt()
449449
*
450450
* @author Attila Kovacs
451451
* @since 1.0
@@ -748,7 +748,7 @@ short astro_planet(double jd_tt, const object *ss_body, enum novas_accuracy accu
748748
* @sa topo_star()
749749
* @sa virtual_star()
750750
* @sa astro_planet()
751-
* @sa ut1_to_tt()
751+
* @sa get_ut1_to_tt()
752752
*/
753753
short topo_star(double jd_tt, double ut1_to_tt, const cat_entry *star, const on_surface *position, enum novas_accuracy accuracy,
754754
double *ra, double *dec) {
@@ -791,7 +791,7 @@ short topo_star(double jd_tt, double ut1_to_tt, const cat_entry *star, const on_
791791
* @sa topo_star()
792792
* @sa virtual_star()
793793
* @sa astro_planet()
794-
* @sa ut1_to_tt()
794+
* @sa get_ut1_to_tt()
795795
*/
796796
short local_star(double jd_tt, double ut1_to_tt, const cat_entry *star, const on_surface *position, enum novas_accuracy accuracy,
797797
double *ra, double *dec) {
@@ -833,7 +833,7 @@ short local_star(double jd_tt, double ut1_to_tt, const cat_entry *star, const on
833833
* @sa topo_planet()
834834
* @sa virtual_planet()
835835
* @sa astro_star()
836-
* @sa ut1_to_tt()
836+
* @sa get_ut1_to_tt()
837837
*/
838838
short topo_planet(double jd_tt, const object *ss_body, double ut1_to_tt, const on_surface *position, enum novas_accuracy accuracy,
839839
double *ra, double *dec, double *dis) {
@@ -875,7 +875,7 @@ short topo_planet(double jd_tt, const object *ss_body, double ut1_to_tt, const o
875875
* @sa topo_planet()
876876
* @sa virtual_planet()
877877
* @sa app_star()
878-
* @sa ut1_to_tt()
878+
* @sa get_ut1_to_tt()
879879
*/
880880
short local_planet(double jd_tt, const object *ss_body, double ut1_to_tt, const on_surface *position, enum novas_accuracy accuracy,
881881
double *ra, double *dec, double *dis) {
@@ -1023,7 +1023,7 @@ short mean_star(double jd_tt, double ra, double dec, enum novas_accuracy accurac
10231023
* 80--90 errro is 80 + error from cio_location(), 90--100 error is 90 + error from cio_basis().
10241024
*
10251025
* @sa cel_pole()
1026-
* @sa ut1_to_tt()
1026+
* @sa get_ut1_to_tt()
10271027
*/
10281028
short place(double jd_tt, const object *cel_object, const observer *location, double ut1_to_tt, enum novas_reference_system coord_sys,
10291029
enum novas_accuracy accuracy, sky_pos *output) {
@@ -2390,7 +2390,7 @@ int e_tilt(double jd_tdb, enum novas_accuracy accuracy, double *mobl, double *to
23902390
* @return 0 if successful, or else 1 if 'type' is invalid.
23912391
*
23922392
*
2393-
* @sa ut1_to_tt()
2393+
* @sa get_ut1_to_tt()
23942394
*/
23952395
short cel_pole(double tjd, enum novas_pole_offset_type type, double dpole1, double dpole2) {
23962396
double dx, dy, t, mean_ob, sin_e, x, dz, dp1[3], dp2[3], dp3[3];
@@ -3902,14 +3902,14 @@ int starvectors(const cat_entry *star, double *pos, double *vel) {
39023902
* @param leap_seconds [s] Leap seconds at gthe time of observations
39033903
* @param dut1 [s] UT1 - UTC time difference [-0.5:0.5]
39043904
* @return [s] The TT - UT1 time difference that is suitable for used with all
3905-
* calls in this library that require a <code>ut12tt</code> argument.
3905+
* calls in this library that require a <code>ut1_to_tt</code> argument.
39063906
*
39073907
* @sa cel_pole()
39083908
*
39093909
* @since 1.0
39103910
* @author Attila Kovacs
39113911
*/
3912-
double ut1_to_tt(int leap_seconds, double dut1) {
3912+
double get_ut1_to_tt(int leap_seconds, double dut1) {
39133913
return NOVAS_TAI_TO_TT + leap_seconds + dut1;
39143914
}
39153915

test/gmon.out

-60.1 KB
Binary file not shown.

0 commit comments

Comments
 (0)