Skip to content

Commit

Permalink
Move doc to SuperNOVAS.home repo
Browse files Browse the repository at this point in the history
  • Loading branch information
attipaci committed Feb 2, 2024
1 parent ee271f6 commit 2fd922e
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 15 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The primary goals of SuperNOVAS is to improve on the stock NOVAS C library by:
- Fixing [outstanding issues](#fixed-issues)
- Improving the ease of use by using `enum`s instead of integer constants, which also allows for some checking
of use during compilations (such as using the incorrect `enum` type).
- Improving [API documentation](https://smithsonian.github.io/supernovas.github.io/apidoc/html/) with
- Improving [API documentation](https://smithsonian.github.io/SuperNOVAS.home/apidoc/html/) with
[Doxygen](https://www.doxygen.nl/) to provide browsable cross-referenced API docs.
- Streamlining calculations where possible
- Adding `const` modifier to prototype arguments where appropriate
Expand Down Expand Up @@ -74,9 +74,9 @@ Outside contributions are very welcome. See how you can contribute

Here are some links to SupeNOVAS related content online:

- [API Documentation](https://smithsonian.github.io/supernovas.github.io/apidoc/html/)
- [API Documentation](https://smithsonian.github.io/SuperNOVAS.home/apidoc/html/)
- [Project site](https://github.com/Smithsonian/SuperNOVAS/) on GitHUB.
- [SuperNOVAS page](https://smithsonian.github.io/supernovas.github.io) page on github.io.
- [SuperNOVAS page](https://smithsonian.github.io/SuperNOVAS.home) page on github.io.
- [How to Contribute](https://github.com/Smithsonian/SuperNOVAS/CONTRIBUTING.md) guide
- The [NOVAS](https://aa.usno.navy.mil/software/novas_info) home page at the US Naval Observatory.
- The [NOVAS C](https://aa.usno.navy.mil/software/novasc_intro) library page.
Expand Down Expand Up @@ -135,7 +135,7 @@ practical considerations before that level of accuracy is reached.
small irregular variations in the orientation of the rotational axis and the rotation period, which are referred to
as the polar wobble. The [IERS Bulletins](https://www.iers.org/IERS/EN/Publications/Bulletins/bulletins.html)
provide up-to-date measurements, historical data and and near-term projections for the polar offsets and the
UT1-UTC time difference and leap-seconds. In SuperNOVAS you can use `cel_pole()` and `ut1_to_tt()` functions to
UT1-UTC time difference and leap-seconds. In SuperNOVAS you can use `cel_pole()` and `get_ut1_to_tt()` functions to
apply / use the published values from these to improve the astrometic precision of calls such as `calc_pos()`, or
`topo_star()`. Without setting and using the polar offset parameters, positions for Earth-based observations will
be accurate at the arcsecond level only.
Expand Down
2 changes: 1 addition & 1 deletion include/novas.h
Original file line number Diff line number Diff line change
Expand Up @@ -672,7 +672,7 @@ int radec2vector(double ra, double dec, double dist, double *vector);

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

double ut1_to_tt(int leap_seconds, double dut1);
double get_ut12tt(int leap_seconds, double dut1);

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

Expand Down
20 changes: 10 additions & 10 deletions src/novas.c
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@ int set_planet_calc_hp(novas_planet_calculator_hp f) {
*
* @sa calc_planet_pos()
* @sa calc_star_pos()
* @sa ut1_to_tt()
* @sa get_ut1_to_tt()
*
*
* @author Attila Kovacs
Expand Down Expand Up @@ -445,7 +445,7 @@ int calc_frame_pos(const object *source, const astro_frame *frame, enum novas_ac
* is invalid, or an error code <10 if from function place().
*
* @sa calc_frame_pos()
* @sa ut1_to_tt()
* @sa get_ut1_to_tt()
*
* @author Attila Kovacs
* @since 1.0
Expand Down Expand Up @@ -748,7 +748,7 @@ short astro_planet(double jd_tt, const object *ss_body, enum novas_accuracy accu
* @sa topo_star()
* @sa virtual_star()
* @sa astro_planet()
* @sa ut1_to_tt()
* @sa get_ut1_to_tt()
*/
short topo_star(double jd_tt, double ut1_to_tt, const cat_entry *star, const on_surface *position, enum novas_accuracy accuracy,
double *ra, double *dec) {
Expand Down Expand Up @@ -791,7 +791,7 @@ short topo_star(double jd_tt, double ut1_to_tt, const cat_entry *star, const on_
* @sa topo_star()
* @sa virtual_star()
* @sa astro_planet()
* @sa ut1_to_tt()
* @sa get_ut1_to_tt()
*/
short local_star(double jd_tt, double ut1_to_tt, const cat_entry *star, const on_surface *position, enum novas_accuracy accuracy,
double *ra, double *dec) {
Expand Down Expand Up @@ -833,7 +833,7 @@ short local_star(double jd_tt, double ut1_to_tt, const cat_entry *star, const on
* @sa topo_planet()
* @sa virtual_planet()
* @sa astro_star()
* @sa ut1_to_tt()
* @sa get_ut1_to_tt()
*/
short topo_planet(double jd_tt, const object *ss_body, double ut1_to_tt, const on_surface *position, enum novas_accuracy accuracy,
double *ra, double *dec, double *dis) {
Expand Down Expand Up @@ -875,7 +875,7 @@ short topo_planet(double jd_tt, const object *ss_body, double ut1_to_tt, const o
* @sa topo_planet()
* @sa virtual_planet()
* @sa app_star()
* @sa ut1_to_tt()
* @sa get_ut1_to_tt()
*/
short local_planet(double jd_tt, const object *ss_body, double ut1_to_tt, const on_surface *position, enum novas_accuracy accuracy,
double *ra, double *dec, double *dis) {
Expand Down Expand Up @@ -1023,7 +1023,7 @@ short mean_star(double jd_tt, double ra, double dec, enum novas_accuracy accurac
* 80--90 errro is 80 + error from cio_location(), 90--100 error is 90 + error from cio_basis().
*
* @sa cel_pole()
* @sa ut1_to_tt()
* @sa get_ut1_to_tt()
*/
short place(double jd_tt, const object *cel_object, const observer *location, double ut1_to_tt, enum novas_reference_system coord_sys,
enum novas_accuracy accuracy, sky_pos *output) {
Expand Down Expand Up @@ -2390,7 +2390,7 @@ int e_tilt(double jd_tdb, enum novas_accuracy accuracy, double *mobl, double *to
* @return 0 if successful, or else 1 if 'type' is invalid.
*
*
* @sa ut1_to_tt()
* @sa get_ut1_to_tt()
*/
short cel_pole(double tjd, enum novas_pole_offset_type type, double dpole1, double dpole2) {
double dx, dy, t, mean_ob, sin_e, x, dz, dp1[3], dp2[3], dp3[3];
Expand Down Expand Up @@ -3902,14 +3902,14 @@ int starvectors(const cat_entry *star, double *pos, double *vel) {
* @param leap_seconds [s] Leap seconds at gthe time of observations
* @param dut1 [s] UT1 - UTC time difference [-0.5:0.5]
* @return [s] The TT - UT1 time difference that is suitable for used with all
* calls in this library that require a <code>ut12tt</code> argument.
* calls in this library that require a <code>ut1_to_tt</code> argument.
*
* @sa cel_pole()
*
* @since 1.0
* @author Attila Kovacs
*/
double ut1_to_tt(int leap_seconds, double dut1) {
double get_ut1_to_tt(int leap_seconds, double dut1) {
return NOVAS_TAI_TO_TT + leap_seconds + dut1;
}

Expand Down
Binary file removed test/gmon.out
Binary file not shown.

0 comments on commit 2fd922e

Please sign in to comment.