updates, doc build, new notebook

aschleg · Jan 10, 2020 · 4175cb2 · 4175cb2
1 parent b622d54
commit 4175cb2
Show file tree

Hide file tree

Showing 12 changed files with 486 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,4 +6,5 @@ dist/
 /build/
 nasapy.egg-info/
 *.pyc
-*.DS_Store
+*.DS_Store
+*.ipynb_checkpoints
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Version History
 
+## Version 0.2.6
+
+- `sentry` function now returns a summary object when `return_df=True` and a `des` or `spk` parameter are not specified.
+
 ## Version 0.2.5
 
 - `sentry` function now returns results as expected when not returning a pandas DataFrame.

diff --git a/README.md b/README.md
@@ -252,6 +252,56 @@ fireballs(date_min='2019-01-01')
 fireballs(date_min='2000-01-01', date_max='2020-01-01', return_df=True)
 ~~~
 
+#### Jet Propulsion Laboratory/Solar System Dynamics small body mission design suite API
+
+~~~ python
+# Search for mission design data for SPK-ID 2000433
+r = mission_design(spk=2000433)
+# Print the object data from the returned dictionary object.
+r['object']
+~~~
+
+#### Get Data on Near-Earth Object Human Space Flight Accessible Targets
+
+~~~ python
+# Get all available summary data for NHATS objects.
+n = nhats()
+# Get summary data as a pandas DataFrame
+n = nhats(return_df=True)
+# Get the results from a 'standard' search on the NHATS webpage.
+nhats(delta_v=6, duration=360, stay=8, magnitude=26, launch='2020-2045', orbit_condition_code=7)
+# Return data for a specific object by its designation
+nhats(des=99942)
+~~~
+
+#### Get Data from NASA's Center for Near-Earth Object Studies (CNEOS) Scout system
+
+~~~ python
+# 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')
+# Get ephemeris data for a specific object at the current time with a Field of View diameter of 5 arc-minutes
+# with a limiting V-magnitude of 23.1.
+scout(tdes='P20UvyK', fov_diam=5, fov_vmag=23.1)
+~~~
+
+#### Get Data from the Center for Near Earth Object Studies (CNEOS) Sentry system
+
+~~~ python
+# Get summary data for available sentry objects.
+sentry()
+# Get summary data as a pandas DataFrame
+sentry(return_df=True)
+# Get data for a specific Sentry object by its designation.
+sentry(des=99942)
+# Get data for objects removed from the Sentry system.
+sentry(removed=1)
+~~~
+
 Other function examples
 
 #### Getting the Julian and Modified Julian Date

diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/versions.doctree b/docs/build/doctrees/versions.doctree
diff --git a/docs/build/html/_sources/versions.rst.txt b/docs/build/html/_sources/versions.rst.txt
@@ -4,6 +4,11 @@
 Version History
 ===============
 
+Version 0.2.6
+-------------
+
+- :code:`sentry` function now returns a summary object when :code:`return_df=True` and a :code:`des` or :code:`spk` parameter are not specified.
+
 Version 0.2.5
 -------------
 

diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
diff --git a/docs/build/html/versions.html b/docs/build/html/versions.html
@@ -88,6 +88,7 @@
               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Version History</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#version-0-2-6">Version 0.2.6</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-0-2-5">Version 0.2.5</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-0-2-4">Version 0.2.4</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-0-2-3">Version 0.2.3</a></li>
@@ -162,6 +163,12 @@
 
   <div class="section" id="version-history">
 <span id="versions"></span><h1>Version History<a class="headerlink" href="#version-history" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="version-0-2-6">
+<h2>Version 0.2.6<a class="headerlink" href="#version-0-2-6" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li><p><code class="code docutils literal notranslate"><span class="pre">sentry</span></code> function now returns a summary object when <code class="code docutils literal notranslate"><span class="pre">return_df=True</span></code> and a <code class="code docutils literal notranslate"><span class="pre">des</span></code> or <code class="code docutils literal notranslate"><span class="pre">spk</span></code> parameter are not specified.</p></li>
+</ul>
+</div>
 <div class="section" id="version-0-2-5">
 <h2>Version 0.2.5<a class="headerlink" href="#version-0-2-5" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">

diff --git a/docs/source/versions.rst b/docs/source/versions.rst
@@ -4,6 +4,11 @@
 Version History
 ===============
 
+Version 0.2.6
+-------------
+
+- :code:`sentry` function now returns a summary object when :code:`return_df=True` and a :code:`des` or :code:`spk` parameter are not specified.
+
 Version 0.2.5
 -------------
 

diff --git a/notebooks/Analyzing the Next Decade of Earth Close-Approaching Objects with nasapy.ipynb b/notebooks/Analyzing the Next Decade of Earth Close-Approaching Objects with nasapy.ipynb
diff --git a/notebooks/Plot Earth Fireball Impacts with nasapy, pandas and folium.ipynb b/notebooks/Plot Earth Fireball Impacts with nasapy, pandas and folium.ipynb
@@ -17,7 +17,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [

diff --git a/setup.py b/setup.py
@@ -4,7 +4,7 @@
 
 setup(
     name='nasapy',
-    version='0.2.5',
+    version='0.2.6',
     author='Aaron Schlegel',
     author_email='aaron@aaronschlegel.me',
     description='Python wrapper for the NASA API',