[automated site update]

apidoc/html/index.html

@@ -133,6 +133,7 @@ <h2><a class="anchor" id="autotoc_md28"></a>
 <li><a class="el" href="index.html#precision">Notes on precision</a></li>
 <li><a class="el" href="index.html#supernovas-features">SuperNOVAS specific features</a></li>
 <li><a class="el" href="index.html#solarsystem">External Solar-system ephemeris data or services</a></li>
+<li><a class="el" href="index.html#debug-support">Runtime Debug support</a></li>
 <li><a class="el" href="index.html#release-schedule">Release schedule</a></li>
 </ul>
 <hr  />
@@ -599,8 +600,24 @@ <h3><a class="anchor" id="autotoc_md67"></a>
 <p>For Solar-system objects other than the major planets, you may also provide your own <code><a class="el" href="solarsystem_8h.html#abb70fdad016c3a2ea45990eaa16b9245">readeph()</a></code> implementation. (In this case you will want to set <code>DEFAULT_READEPH</code> in <code>config.mk</code> to specify your source code for that function before building the SuperNOVAS library, or else disable that option entirely (e.g. by commenting or removing it), and link your application explicitly with your <code><a class="el" href="solarsystem_8h.html#abb70fdad016c3a2ea45990eaa16b9245">readeph()</a></code> implementation.</p>
 <p>The downside of this approach is that your SuperNOVAS library will not be usable without invariably providing a <code><a class="el" href="solsys-ephem_8c.html#a5e2d599b1dc7a0e87bfd29dbd6413398">solarsystem()</a></code> / <code><a class="el" href="solsys-ephem_8c.html#a0243c2489c22860de898115aed8ffc87">solarsystem_hp()</a></code> and/or <code><a class="el" href="solarsystem_8h.html#abb70fdad016c3a2ea45990eaa16b9245">readeph()</a></code> implementations for <em>every</em> application that you will want to use SuperNOVAS with. This is why the runtime configuration of the ephemeris provider functions is the best and most generic way to add your preferred implementations while also providing some minimum default implementations for <em>other users</em> of the library, who may not need <em>your</em> ephemeris service, or have no need for planet data beyond the approximate positions for the Earth and Sun.</p>
 <hr  />
-<p><a class="anchor" id="release-schedule"></a> </p>
+<p><a class="anchor" id="debug-support"></a> </p>
 <h2><a class="anchor" id="autotoc_md69"></a>
+Runtime debug support</h2>
+<p>You can enable or disable debugging output to <code>stderr</code> with <code><a class="el" href="novas_8c.html#a5f35633b872751df4dacd2fb2cbe4ac3">novas_debug(enum novas_debug_mode)</a></code>, where the argument is one of the defined constants from <code><a class="el" href="novas_8h.html">novas.h</a></code>:</p>
+<table class="markdownTable">
+<tr class="markdownTableHead">
+<th class="markdownTableHeadNone"><code>novas_debug_mode</code> value   </th><th class="markdownTableHeadNone">Description    </th></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyNone"><code>NOVAS_DEBUG_OFF</code>   </td><td class="markdownTableBodyNone">No debugging output (<em>default</em>)    </td></tr>
+<tr class="markdownTableRowEven">
+<td class="markdownTableBodyNone"><code>NOVAS_DEBUG_ON</code>   </td><td class="markdownTableBodyNone">Prints error messages and traces to <code>stderr</code>    </td></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyNone"><code>NOVAS_DEBUG_EXTRA</code>   </td><td class="markdownTableBodyNone">Same as above but with stricter error checking   </td></tr>
+</table>
+<p>The main difference between <code>NOVAS_DEBUG_ON</code> and <code>NOVAS_DEBUG_EXTRA</code> is that the latter will treat minor issues as errors also, while the former may ignore them. For example, <code><a class="el" href="novas_8c.html#a263de1618d80fcc737984951fa97c5a3">place()</a></code> will return normally by default if it cannot calculate gravitational bending around massive planets in full accuracy mode. It is unlikely that this omission would significantly alter the result in most cases, except for some very specific ones when observing in a direction close to a major planet. Thus, with <code>NOVAS_DEBUG_ON</code>, <code><a class="el" href="novas_8c.html#a263de1618d80fcc737984951fa97c5a3">place()</a></code> go about as usual even if the Jupiter's position is not known. However, <code>NOVAS_DEBUG_EXTRA</code> will not give it a free pass, and will make <code><a class="el" href="novas_8c.html#a263de1618d80fcc737984951fa97c5a3">place()</a></code> return an error (and print the trace) if it cannot properly account for gravitational bending around the major planets as it is expected to.</p>
+<hr  />
+<p><a class="anchor" id="release-schedule"></a> </p>
+<h2><a class="anchor" id="autotoc_md71"></a>
 Release schedule</h2>
 <p>A predictable release schedule and process can help manage expectations and reduce stress on adopters and developers alike.</p>
 <p>Releases of the library shall follow a quarterly release schedule. You may expect upcoming releases to be published around <b>February 1</b>, <b>May 1</b>, <b>August 1</b>, and/or <b>November 1</b> each year, on an as-needed basis. That means that if there are outstanding bugs, or new pull requests (PRs), you may expect a release that addresses these in the upcoming quarter. The dates are placeholders only, with no guarantee that a new release will actually be available every quarter. If nothing of note comes up, a potential release date may pass without a release being published.</p>

apidoc/html/navtreedata.js

@@ -67,7 +67,8 @@ var NAVTREE =
         ] ],
         [ "3. Explicit linking of custom ephemeris functions", "index.html#autotoc_md67", null ]
       ] ],
-      [ "Release schedule", "index.html#autotoc_md69", null ],
+      [ "Runtime debug support", "index.html#autotoc_md69", null ],
+      [ "Release schedule", "index.html#autotoc_md71", null ],
       [ "[Unreleased]", "md_CHANGELOG.html#autotoc_md1", [
         [ "Fixed", "md_CHANGELOG.html#autotoc_md2", null ],
         [ "Changed", "md_CHANGELOG.html#autotoc_md3", null ]
@@ -130,9 +131,9 @@ var NAVTREE =
 var NAVTREEINDEX =
 [
 "annotated.html",
-"novas_8c.html#aead87744eeb3029ce7d5ffb1801ee652",
-"novas_8h.html#ace5e59ce1564bf6c61946c290bb05367a84da44f7510d8c99353b1b1c6bb4faf8",
-"super_8c.html#ae68d01655c4b37b5a3e1422f0062f94c"
+"novas_8c.html#aea0e1028baf14d16d9de800e36a17086",
+"novas_8h.html#ace5e59ce1564bf6c61946c290bb05367a6833dbc8bfb3b8ba2cdd7a2da0b82353",
+"super_8c.html#adb48b2acaf76cc3a1e3a1412cc42c232"
 ];
 
 var SYNCONMSG = 'click to disable panel synchronisation';

apidoc/html/navtreeindex0.js

@@ -46,8 +46,8 @@ var NAVTREEINDEX0 =
 "frames_8c.html#ae84debf8ab4d3b16feaaefdcb0ebbd08":[5,0,1,1,4],
 "functions.html":[4,2,0],
 "functions_vars.html":[4,2,1],
-"globals.html":[5,1,0,0],
 "globals.html":[5,1,0],
+"globals.html":[5,1,0,0],
 "globals_b.html":[5,1,0,1],
 "globals_c.html":[5,1,0,2],
 "globals_d.html":[5,1,0,3],
@@ -56,8 +56,8 @@ var NAVTREEINDEX0 =
 "globals_enum.html":[5,1,4],
 "globals_eval.html":[5,1,5],
 "globals_f.html":[5,1,0,5],
-"globals_func.html":[5,1,1],
 "globals_func.html":[5,1,1,0],
+"globals_func.html":[5,1,1],
 "globals_func_b.html":[5,1,1,1],
 "globals_func_c.html":[5,1,1,2],
 "globals_func_d.html":[5,1,1,3],
@@ -129,23 +129,24 @@ var NAVTREEINDEX0 =
 "index.html#autotoc_md66":[8,1,1],
 "index.html#autotoc_md67":[8,2],
 "index.html#autotoc_md69":[9],
+"index.html#autotoc_md71":[10],
 "md_CHANGELOG.html":[0],
-"md_CHANGELOG.html#autotoc_md1":[0,10],
-"md_CHANGELOG.html#autotoc_md10":[0,12,1],
-"md_CHANGELOG.html#autotoc_md11":[0,12,2],
-"md_CHANGELOG.html#autotoc_md12":[0,13],
-"md_CHANGELOG.html#autotoc_md13":[0,13,0],
-"md_CHANGELOG.html#autotoc_md14":[0,13,1],
-"md_CHANGELOG.html#autotoc_md15":[0,13,2],
-"md_CHANGELOG.html#autotoc_md16":[0,13,3],
-"md_CHANGELOG.html#autotoc_md2":[0,10,0],
-"md_CHANGELOG.html#autotoc_md3":[0,10,1],
-"md_CHANGELOG.html#autotoc_md4":[0,11],
-"md_CHANGELOG.html#autotoc_md5":[0,11,0],
-"md_CHANGELOG.html#autotoc_md6":[0,11,1],
-"md_CHANGELOG.html#autotoc_md7":[0,11,2],
-"md_CHANGELOG.html#autotoc_md8":[0,12],
-"md_CHANGELOG.html#autotoc_md9":[0,12,0],
+"md_CHANGELOG.html#autotoc_md1":[0,11],
+"md_CHANGELOG.html#autotoc_md10":[0,13,1],
+"md_CHANGELOG.html#autotoc_md11":[0,13,2],
+"md_CHANGELOG.html#autotoc_md12":[0,14],
+"md_CHANGELOG.html#autotoc_md13":[0,14,0],
+"md_CHANGELOG.html#autotoc_md14":[0,14,1],
+"md_CHANGELOG.html#autotoc_md15":[0,14,2],
+"md_CHANGELOG.html#autotoc_md16":[0,14,3],
+"md_CHANGELOG.html#autotoc_md2":[0,11,0],
+"md_CHANGELOG.html#autotoc_md3":[0,11,1],
+"md_CHANGELOG.html#autotoc_md4":[0,12],
+"md_CHANGELOG.html#autotoc_md5":[0,12,0],
+"md_CHANGELOG.html#autotoc_md6":[0,12,1],
+"md_CHANGELOG.html#autotoc_md7":[0,12,2],
+"md_CHANGELOG.html#autotoc_md8":[0,13],
+"md_CHANGELOG.html#autotoc_md9":[0,13,0],
 "md_CONTRIBUTING.html":[1],
 "md_LEGACY.html":[2],
 "md_LEGACY.html#autotoc_md19":[2,0],
@@ -248,6 +249,5 @@ var NAVTREEINDEX0 =
 "novas_8c.html#ad2b933ce2f58e8b04bbe76ffbff99eb0":[5,0,1,2,98],
 "novas_8c.html#ad799864f637c483fb49491bde5a93e25":[5,0,1,2,15],
 "novas_8c.html#add7a260017fad0d59c943a0a8d935fcf":[5,0,1,2,18],
-"novas_8c.html#ade8207981b6f840d1f0a79dd0c72beb2":[5,0,1,2,66],
-"novas_8c.html#aea0e1028baf14d16d9de800e36a17086":[5,0,1,2,35]
+"novas_8c.html#ade8207981b6f840d1f0a79dd0c72beb2":[5,0,1,2,66]
 };

apidoc/html/navtreeindex1.js

@@ -1,5 +1,6 @@
 var NAVTREEINDEX1 =
 {
+"novas_8c.html#aea0e1028baf14d16d9de800e36a17086":[5,0,1,2,35],
 "novas_8c.html#aead87744eeb3029ce7d5ffb1801ee652":[5,0,1,2,94],
 "novas_8c.html#aed179ad664f4ff023deb540140f3c2ef":[5,0,1,2,71],
 "novas_8c.html#aeea4b5085c7267714492fae6108fb975":[5,0,1,2,29],
@@ -248,6 +249,5 @@ var NAVTREEINDEX1 =
 "novas_8h.html#acd47f30801a6676afb5e0614eaefa569":[5,0,0,0,228],
 "novas_8h.html#ace5e59ce1564bf6c61946c290bb05367":[5,0,0,0,84],
 "novas_8h.html#ace5e59ce1564bf6c61946c290bb05367a197e40a273d8132592b60efe3f87a065":[5,0,0,0,84,0],
-"novas_8h.html#ace5e59ce1564bf6c61946c290bb05367a1b1e38f90bc3bc3c9f1c04aa2c959444":[5,0,0,0,84,4],
-"novas_8h.html#ace5e59ce1564bf6c61946c290bb05367a6833dbc8bfb3b8ba2cdd7a2da0b82353":[5,0,0,0,84,1]
+"novas_8h.html#ace5e59ce1564bf6c61946c290bb05367a1b1e38f90bc3bc3c9f1c04aa2c959444":[5,0,0,0,84,4]
 };

apidoc/html/navtreeindex2.js

@@ -1,5 +1,6 @@
 var NAVTREEINDEX2 =
 {
+"novas_8h.html#ace5e59ce1564bf6c61946c290bb05367a6833dbc8bfb3b8ba2cdd7a2da0b82353":[5,0,0,0,84,1],
 "novas_8h.html#ace5e59ce1564bf6c61946c290bb05367a84da44f7510d8c99353b1b1c6bb4faf8":[5,0,0,0,84,3],
 "novas_8h.html#ace5e59ce1564bf6c61946c290bb05367a882f5d97444df44485d360ce298843b1":[5,0,0,0,84,2],
 "novas_8h.html#acf86ce700b3d3509ebba13e5f16a4327":[5,0,0,0,205],
@@ -248,6 +249,5 @@ var NAVTREEINDEX2 =
 "super_8c.html#ab7611704bab9ce717744a8b5575c5378":[5,0,1,10,7],
 "super_8c.html#ab9b7a622486f2904615ceed1ba94cd8f":[5,0,1,10,16],
 "super_8c.html#acbcd90c9111cc5580a5c2bac404f7f00":[5,0,1,10,20],
-"super_8c.html#ad290005b13558de3927e455775b32e0f":[5,0,1,10,10],
-"super_8c.html#adb48b2acaf76cc3a1e3a1412cc42c232":[5,0,1,10,25]
+"super_8c.html#ad290005b13558de3927e455775b32e0f":[5,0,1,10,10]
 };

apidoc/html/navtreeindex3.js

@@ -1,5 +1,6 @@
 var NAVTREEINDEX3 =
 {
+"super_8c.html#adb48b2acaf76cc3a1e3a1412cc42c232":[5,0,1,10,25],
 "super_8c.html#ae68d01655c4b37b5a3e1422f0062f94c":[5,0,1,10,9],
 "super_8c.html#aebad3c9b51f62cb7b31a686b5ec890a9":[5,0,1,10,19],
 "super_8c.html#af4cce5aa6c74794a0b89176037305181":[5,0,1,10,5],

apidoc/html/search/all_7.js

@@ -6,18 +6,19 @@ var searchData=
   ['data_20or_20services_3',['External Solar-system ephemeris data or services',['../index.html#autotoc_md62',1,'']]],
   ['data_20service_20integration_4',['1. Universal ephemeris data / service integration',['../index.html#autotoc_md63',1,'']]],
   ['de405_5fau_5',['DE405_AU',['../novas_8h.html#af303bf91582509624aa40c6a87eb95ac',1,'novas.h']]],
-  ['dec_6',['dec',['../structsky__pos.html#ac4ae7989694321b540abb75c30eec690',1,'sky_pos::dec'],['../structcat__entry.html#ac4ae7989694321b540abb75c30eec690',1,'cat_entry::dec']]],
-  ['declination_7',['A. True apparent R.A. and declination',['../md_LEGACY.html#autotoc_md25',1,'']]],
-  ['default_5fcio_5flocator_5ffile_8',['DEFAULT_CIO_LOCATOR_FILE',['../novas_8h.html#a4caf1f6e33a208827eb99df7e387d6d1',1,'novas.h']]],
-  ['default_5fgrav_5fbodies_5ffull_5faccuracy_9',['DEFAULT_GRAV_BODIES_FULL_ACCURACY',['../novas_8h.html#a4cb74da554b236c835302480688cfaac',1,'novas.h']]],
-  ['default_5fgrav_5fbodies_5freduced_5faccuracy_10',['DEFAULT_GRAV_BODIES_REDUCED_ACCURACY',['../novas_8h.html#aec64bf67d5a03b2b4fb2583e5918f1de',1,'novas.h']]],
-  ['deg2rad_11',['DEG2RAD',['../novas_8h.html#af7e8592d0a634bd3642e9fd508ea8022',1,'novas.h']]],
-  ['deprecated_12',['Deprecated',['../md_CHANGELOG.html#autotoc_md16',1,'']]],
-  ['deprecated_20list_13',['Deprecated List',['../deprecated.html',1,'']]],
-  ['deps0_14',['deps0',['../structnovas__frame.html#afb1bb47af5a00647759b897f72a68b58',1,'novas_frame']]],
-  ['dis_15',['dis',['../structsky__pos.html#aeedff25e8c80502a891e8af33d35b3c0',1,'sky_pos']]],
-  ['dpsi0_16',['dpsi0',['../structnovas__frame.html#a4445e3f8a201b14a5a7068c87507de72',1,'novas_frame']]],
-  ['dut1_17',['dut1',['../structnovas__timespec.html#a281e93817d681ec4a6cea2601a15c566',1,'novas_timespec']]],
-  ['dx_18',['dx',['../structnovas__frame.html#a229d11aff11a7482259d1296b9b70b8a',1,'novas_frame']]],
-  ['dy_19',['dy',['../structnovas__frame.html#a9deb6f886b19d50e714d890c3c268efc',1,'novas_frame']]]
+  ['debug_20support_6',['Runtime debug support',['../index.html#autotoc_md69',1,'']]],
+  ['dec_7',['dec',['../structsky__pos.html#ac4ae7989694321b540abb75c30eec690',1,'sky_pos::dec'],['../structcat__entry.html#ac4ae7989694321b540abb75c30eec690',1,'cat_entry::dec']]],
+  ['declination_8',['A. True apparent R.A. and declination',['../md_LEGACY.html#autotoc_md25',1,'']]],
+  ['default_5fcio_5flocator_5ffile_9',['DEFAULT_CIO_LOCATOR_FILE',['../novas_8h.html#a4caf1f6e33a208827eb99df7e387d6d1',1,'novas.h']]],
+  ['default_5fgrav_5fbodies_5ffull_5faccuracy_10',['DEFAULT_GRAV_BODIES_FULL_ACCURACY',['../novas_8h.html#a4cb74da554b236c835302480688cfaac',1,'novas.h']]],
+  ['default_5fgrav_5fbodies_5freduced_5faccuracy_11',['DEFAULT_GRAV_BODIES_REDUCED_ACCURACY',['../novas_8h.html#aec64bf67d5a03b2b4fb2583e5918f1de',1,'novas.h']]],
+  ['deg2rad_12',['DEG2RAD',['../novas_8h.html#af7e8592d0a634bd3642e9fd508ea8022',1,'novas.h']]],
+  ['deprecated_13',['Deprecated',['../md_CHANGELOG.html#autotoc_md16',1,'']]],
+  ['deprecated_20list_14',['Deprecated List',['../deprecated.html',1,'']]],
+  ['deps0_15',['deps0',['../structnovas__frame.html#afb1bb47af5a00647759b897f72a68b58',1,'novas_frame']]],
+  ['dis_16',['dis',['../structsky__pos.html#aeedff25e8c80502a891e8af33d35b3c0',1,'sky_pos']]],
+  ['dpsi0_17',['dpsi0',['../structnovas__frame.html#a4445e3f8a201b14a5a7068c87507de72',1,'novas_frame']]],
+  ['dut1_18',['dut1',['../structnovas__timespec.html#a281e93817d681ec4a6cea2601a15c566',1,'novas_timespec']]],
+  ['dx_19',['dx',['../structnovas__frame.html#a229d11aff11a7482259d1296b9b70b8a',1,'novas_frame']]],
+  ['dy_20',['dy',['../structnovas__frame.html#a9deb6f886b19d50e714d890c3c268efc',1,'novas_frame']]]
 ];

apidoc/html/toc.xml

@@ -39,7 +39,8 @@
       </topic>
       <topic label="3. Explicit linking of custom ephemeris functions" href="index.html#autotoc_md67"/>
     </topic>
-    <topic label="Release schedule" href="index.html#autotoc_md69"/>
+    <topic label="Runtime debug support" href="index.html#autotoc_md69"/>
+    <topic label="Release schedule" href="index.html#autotoc_md71"/>
   </topic>
   <topic label="Changelog" href="md_CHANGELOG.html">
     <topic label="[Unreleased]" href="md_CHANGELOG.html#autotoc_md1">

apidoc/supernovas.tag

@@ -4438,6 +4438,7 @@
     <docanchor file="index.html">universal-ephemerides</docanchor>
     <docanchor file="index.html">builtin-ephem-readers</docanchor>
     <docanchor file="index.html">explicit-ephem-linking</docanchor>
+    <docanchor file="index.html">debug-support</docanchor>
     <docanchor file="index.html">release-schedule</docanchor>
   </compound>
 </tagfile>