commit updated docs build

Author: aschleg

docs/build/doctrees/api.doctree

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: e6577a22705df8af6f23fbc632f09835
+config: dcd4018dc8aa2025c0012393ea8eb72e
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/doctrees/environment.pickle

@@ -414,7 +414,6 @@ NASA Image and Video Library
         # Get the manifest for the NASA media asset 'as11-40-5874'
         media_asset_manifest(nasa_id='as11-40-5874')
 
-
 .. method:: media_asset_metadata(nasa_id)
 
     Retrieves the specified media asset's metadata.
@@ -469,9 +468,11 @@ and `Center for Near-Earth Object Studies <https://cneos.jpl.nasa.gov/>`_ APIs.
     .. code-block:: python
 
         # Get all close-approach object data in the year 2019 with a maximum approach distance of 0.01AU.
-        >>> nasapy.close_approach(date_min='2019-01-01', date_max='2019-12-31', dist_max=0.01)
+        nasapy.close_approach(date_min='2019-01-01', date_max='2019-12-31', dist_max=0.01)
         # Get close-approach data for asteroid 433 Eros within 0.2AU from the years 1900 to 2100.
-        >>> nasapy.close_approach(des='433', date_min='1900-01-01', date_max='2100-01-01', dist_max=0.2)
+        nasapy.close_approach(des='433', date_min='1900-01-01', date_max='2100-01-01', dist_max=0.2)
+        # Return close-approach data from the beginning of 2000 to the beginning of 2020 as a pandas DataFrame.
+        nasapy.close_approach(date_min='2000-01-01', date_max='2020-01-01', return_df=True)
 
     Each close-approach record is a list containing the following fields in the corresponding order:
 
@@ -520,11 +521,13 @@ and `Center for Near-Earth Object Studies <https://cneos.jpl.nasa.gov/>`_ APIs.
     .. code-block:: python
 
         # Get all available data in reverse chronological order
-        >>> n = nasapy.fireballs()
+        nasapy.fireballs()
         # Return the earlieset record
-        >>> nasapy.fireballs(limit=1)
+        nasapy.fireballs(limit=1)
         # Get data from the beginning of 2019
-        >>> nasapy.fireballs(date_min='2019-01-01')
+        nasapy.fireballs(date_min='2019-01-01')
+        # Return fireball data from the beginning of the millennium to the beginning of 2020 as a pandas DataFrame.
+        nasapy.fireballs(date_min='2000-01-01', date_max='2020-01-01', return_df=True)
 
 .. method:: mission_design([des=None][, spk=None][, sstr=None][, orbit_class=False][, mjd0=None][, span=None][, tof_min=None][, tof_max=None][, step=None])
 
@@ -599,6 +602,8 @@ and `Center for Near-Earth Object Studies <https://cneos.jpl.nasa.gov/>`_ APIs.
 
         # Get all available summary data.
         scout()
+        # Return all summary data as a pandas DataFrame.
+        scout(return_df=True)
         # Return data and plot files for a specific object by its temporary designation. Note the object may no longer
         # exist in the current database
         scout(tdes='P20UvyK')

docs/build/doctrees/versions.doctree

@@ -4,6 +4,23 @@
 Version History
 ===============
 
+Version 0.2.2
+-------------
+
+- An optional :code:`return_df` parameter has been implemented in the listed functions below. When set as :code:`True`,
+  the resulting JSON data will be coerced into a pandas DataFrame to allow easier and more straightforward data
+  analysis for those interested. Please see the individual function documentation for more information and
+  examples.
+
+  * :code:`fireballs`
+  * :code:`close_approach`
+  * :code:`nhats`
+  * :code:`sentry`
+  * :code:`scout`
+
+- General bug fixes
+  * The :code:`sentry` function should now operate correctly when passing a :code:`des` or :code:`spk` parameter.
+
 Version 0.2.1
 -------------
 

docs/build/html/.buildinfo

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.2.1',
+    VERSION: '0.2.2',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',

docs/build/html/_sources/api.rst.txt

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>API Reference &mdash; nasapy 0.2.1 documentation</title>
+  <title>API Reference &mdash; nasapy 0.2.2 documentation</title>
 
 
 
@@ -918,9 +918,11 @@ <h3>Solar System Dynamics (SSD) and Center for Near-Earth Object Studies (CNEOS)
 </tbody>
 </table>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Get all close-approach object data in the year 2019 with a maximum approach distance of 0.01AU.</span>
-<span class="o">&gt;&gt;&gt;</span> <span class="n">nasapy</span><span class="o">.</span><span class="n">close_approach</span><span class="p">(</span><span class="n">date_min</span><span class="o">=</span><span class="s1">&#39;2019-01-01&#39;</span><span class="p">,</span> <span class="n">date_max</span><span class="o">=</span><span class="s1">&#39;2019-12-31&#39;</span><span class="p">,</span> <span class="n">dist_max</span><span class="o">=</span><span class="mf">0.01</span><span class="p">)</span>
+<span class="n">nasapy</span><span class="o">.</span><span class="n">close_approach</span><span class="p">(</span><span class="n">date_min</span><span class="o">=</span><span class="s1">&#39;2019-01-01&#39;</span><span class="p">,</span> <span class="n">date_max</span><span class="o">=</span><span class="s1">&#39;2019-12-31&#39;</span><span class="p">,</span> <span class="n">dist_max</span><span class="o">=</span><span class="mf">0.01</span><span class="p">)</span>
 <span class="c1"># Get close-approach data for asteroid 433 Eros within 0.2AU from the years 1900 to 2100.</span>
-<span class="o">&gt;&gt;&gt;</span> <span class="n">nasapy</span><span class="o">.</span><span class="n">close_approach</span><span class="p">(</span><span class="n">des</span><span class="o">=</span><span class="s1">&#39;433&#39;</span><span class="p">,</span> <span class="n">date_min</span><span class="o">=</span><span class="s1">&#39;1900-01-01&#39;</span><span class="p">,</span> <span class="n">date_max</span><span class="o">=</span><span class="s1">&#39;2100-01-01&#39;</span><span class="p">,</span> <span class="n">dist_max</span><span class="o">=</span><span class="mf">0.2</span><span class="p">)</span>
+<span class="n">nasapy</span><span class="o">.</span><span class="n">close_approach</span><span class="p">(</span><span class="n">des</span><span class="o">=</span><span class="s1">&#39;433&#39;</span><span class="p">,</span> <span class="n">date_min</span><span class="o">=</span><span class="s1">&#39;1900-01-01&#39;</span><span class="p">,</span> <span class="n">date_max</span><span class="o">=</span><span class="s1">&#39;2100-01-01&#39;</span><span class="p">,</span> <span class="n">dist_max</span><span class="o">=</span><span class="mf">0.2</span><span class="p">)</span>
+<span class="c1"># Return close-approach data from the beginning of 2000 to the beginning of 2020 as a pandas DataFrame.</span>
+<span class="n">nasapy</span><span class="o">.</span><span class="n">close_approach</span><span class="p">(</span><span class="n">date_min</span><span class="o">=</span><span class="s1">&#39;2000-01-01&#39;</span><span class="p">,</span> <span class="n">date_max</span><span class="o">=</span><span class="s1">&#39;2020-01-01&#39;</span><span class="p">,</span> <span class="n">return_df</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
 </pre></div>
 </div>
 <p>Each close-approach record is a list containing the following fields in the corresponding order:</p>
@@ -983,11 +985,13 @@ <h3>Solar System Dynamics (SSD) and Center for Near-Earth Object Studies (CNEOS)
 </tbody>
 </table>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Get all available data in reverse chronological order</span>
-<span class="o">&gt;&gt;&gt;</span> <span class="n">n</span> <span class="o">=</span> <span class="n">nasapy</span><span class="o">.</span><span class="n">fireballs</span><span class="p">()</span>
+<span class="n">nasapy</span><span class="o">.</span><span class="n">fireballs</span><span class="p">()</span>
 <span class="c1"># Return the earlieset record</span>
-<span class="o">&gt;&gt;&gt;</span> <span class="n">nasapy</span><span class="o">.</span><span class="n">fireballs</span><span class="p">(</span><span class="n">limit</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
+<span class="n">nasapy</span><span class="o">.</span><span class="n">fireballs</span><span class="p">(</span><span class="n">limit</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
 <span class="c1"># Get data from the beginning of 2019</span>
-<span class="o">&gt;&gt;&gt;</span> <span class="n">nasapy</span><span class="o">.</span><span class="n">fireballs</span><span class="p">(</span><span class="n">date_min</span><span class="o">=</span><span class="s1">&#39;2019-01-01&#39;</span><span class="p">)</span>
+<span class="n">nasapy</span><span class="o">.</span><span class="n">fireballs</span><span class="p">(</span><span class="n">date_min</span><span class="o">=</span><span class="s1">&#39;2019-01-01&#39;</span><span class="p">)</span>
+<span class="c1"># Return fireball data from the beginning of the millennium to the beginning of 2020 as a pandas DataFrame.</span>
+<span class="n">nasapy</span><span class="o">.</span><span class="n">fireballs</span><span class="p">(</span><span class="n">date_min</span><span class="o">=</span><span class="s1">&#39;2000-01-01&#39;</span><span class="p">,</span> <span class="n">date_max</span><span class="o">=</span><span class="s1">&#39;2020-01-01&#39;</span><span class="p">,</span> <span class="n">return_df</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
 </pre></div>
 </div>
 </dd></dl>
@@ -1098,6 +1102,8 @@ <h3>Solar System Dynamics (SSD) and Center for Near-Earth Object Studies (CNEOS)
 </table>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Get all available summary data.</span>
 <span class="n">scout</span><span class="p">()</span>
+<span class="c1"># Return all summary data as a pandas DataFrame.</span>
+<span class="n">scout</span><span class="p">(</span><span class="n">return_df</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
 <span class="c1"># Return data and plot files for a specific object by its temporary designation. Note the object may no longer</span>
 <span class="c1"># exist in the current database</span>
 <span class="n">scout</span><span class="p">(</span><span class="n">tdes</span><span class="o">=</span><span class="s1">&#39;P20UvyK&#39;</span><span class="p">)</span>

docs/build/html/_sources/versions.rst.txt

@@ -9,7 +9,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Index &mdash; nasapy 0.2.1 documentation</title>
+  <title>Index &mdash; nasapy 0.2.2 documentation</title>
 
 
 

docs/build/html/_static/documentation_options.js

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Nasapy Documentation &mdash; nasapy 0.2.1 documentation</title>
+  <title>Nasapy Documentation &mdash; nasapy 0.2.2 documentation</title>