Updated Sphinx Docs

blaylockbk · Aug 20, 2021 · 5c914a7 · 5c914a7
1 parent f0346ca
commit 5c914a7
Show file tree

Hide file tree

Showing 12 changed files with 32 additions and 20 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/nbsphinx/user_guide/notebooks/DEMO_rgb_recipes.ipynb b/docs/_build/doctrees/nbsphinx/user_guide/notebooks/DEMO_rgb_recipes.ipynb
@@ -160,7 +160,7 @@
     "import cartopy.crs as ccrs\n",
     "import matplotlib.pyplot as plt\n",
     "\n",
-    "# Function from Carpenter_Workshop: \n",
+    "# Function from Carpenter_Workshop: https://github.com/blaylockbk/Carpenter_Workshop\n",
     "from toolbox.cartopy_tools import common_features"
    ]
   },

diff --git a/docs/_build/doctrees/user_guide/notebooks/DEMO_rgb_recipes.doctree b/docs/_build/doctrees/user_guide/notebooks/DEMO_rgb_recipes.doctree
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -45,9 +45,14 @@ Download Data
 
 The following example downloads GOES 16 ABI multichannel file on the fixed grid for the CONUS domain and reads it with xarray for the latest image and an image nearest a specific time.
 
+- `📖 Download latest <https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/DEMO_download_goes_nearesttime.html>`_
+- `📖 Download nearest time <https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/DEMO_download_goes_latest.html>`_
+- `📖 Download time series <https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/DEMO_download_goes_timerange.html>`_
+
+
 .. code-block:: python
 
-   from goes2go.data import goes_latest, goes_nearesttime
+   from goes2go.data import goes_latest, goes_nearesttime, goes_timeseries
 
    # Get latest data
    G1 = goes_latest(satellite='G16', product='ABI')
@@ -60,7 +65,6 @@ RGB Recipes for ABI
 Generate RGB arrays for different RGB products. Check out the following notebook for a demonstration:
 
 - `📖 RGB Recipes Docs <https://blaylockbk.github.io/goes2go/_build/html/reference_guide/index.html#rgb-recipes>`_
-- `📓 Example Notebook <https://github.com/blaylockbk/goes2go/blob/master/notebooks/DEMO_rgb_recipies.ipynb>`_
 
 .. figure:: _static/TrueColor.png
    :class: img-fluid
@@ -74,7 +78,7 @@ Advanced Baseline Imager (ABI)
 """"""""""""""""""""""""""""""
 GOES-West is centered over -137 W and GOES-East is centered over -75 W. When GOES was being tested, it was in a "central" position, outlined in the dashed black line. Below is the ABI field of view for the full disk:
 
-- `📓 ABI field of view notebook <https://github.com/blaylockbk/goes2go/blob/master/notebooks/field-of-view_ABI.ipynb>`_
+- `📓 ABI field of view notebook <https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/field-of-view_ABI.html>`_
 
 .. figure:: _static/ABI_field-of-view.png
    :class: img-fluid
@@ -91,8 +95,8 @@ Geostationary Lightning Mapper (GLM)
 """"""""""""""""""""""""""""""""""""
 The GLM field of view is slightly smaller and limited by a bounding box. The field of view can be estimated.
 
-- `📓 GLM field of view notebook <https://github.com/blaylockbk/goes2go/blob/master/notebooks/field-of-view_GLM.ipynb>`_
-- `📓 More details on actual edges <https://github.com/blaylockbk/goes2go/blob/master/notebooks/field-of-view_GLM_Edges.ipynb>`_
+- `📓 GLM field of view notebook <https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/field-of-view_GLM.html>`_
+- `📓 More details on actual edges <https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/field-of-view_GLM_Edges.html>`_
 
 .. figure:: _static/GLM_field-of-view.png
    :class: img-fluid

diff --git a/docs/_build/html/_sources/user_guide/notebooks/DEMO_rgb_recipes.ipynb.txt b/docs/_build/html/_sources/user_guide/notebooks/DEMO_rgb_recipes.ipynb.txt
@@ -160,7 +160,7 @@
     "import cartopy.crs as ccrs\n",
     "import matplotlib.pyplot as plt\n",
     "\n",
-    "# Function from Carpenter_Workshop: \n",
+    "# Function from Carpenter_Workshop: https://github.com/blaylockbk/Carpenter_Workshop\n",
     "from toolbox.cartopy_tools import common_features"
    ]
   },

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -272,7 +272,12 @@ <h2>Capabilities<a class="headerlink" href="#capabilities" title="Permalink to t
 <div class="section" id="download-data">
 <h3>Download Data<a class="headerlink" href="#download-data" title="Permalink to this headline">¶</a></h3>
 <p>The following example downloads GOES 16 ABI multichannel file on the fixed grid for the CONUS domain and reads it with xarray for the latest image and an image nearest a specific time.</p>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">goes2go.data</span> <span class="kn">import</span> <span class="n">goes_latest</span><span class="p">,</span> <span class="n">goes_nearesttime</span>
+<ul class="simple">
+<li><p><a class="reference external" href="https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/DEMO_download_goes_nearesttime.html">📖 Download latest</a></p></li>
+<li><p><a class="reference external" href="https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/DEMO_download_goes_latest.html">📖 Download nearest time</a></p></li>
+<li><p><a class="reference external" href="https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/DEMO_download_goes_timerange.html">📖 Download time series</a></p></li>
+</ul>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">goes2go.data</span> <span class="kn">import</span> <span class="n">goes_latest</span><span class="p">,</span> <span class="n">goes_nearesttime</span><span class="p">,</span> <span class="n">goes_timeseries</span>
 
 <span class="c1"># Get latest data</span>
 <span class="n">G1</span> <span class="o">=</span> <span class="n">goes_latest</span><span class="p">(</span><span class="n">satellite</span><span class="o">=</span><span class="s1">&#39;G16&#39;</span><span class="p">,</span> <span class="n">product</span><span class="o">=</span><span class="s1">&#39;ABI&#39;</span><span class="p">)</span>
@@ -287,7 +292,6 @@ <h3>RGB Recipes for ABI<a class="headerlink" href="#rgb-recipes-for-abi" title="
 <p>Generate RGB arrays for different RGB products. Check out the following notebook for a demonstration:</p>
 <ul class="simple">
 <li><p><a class="reference external" href="https://blaylockbk.github.io/goes2go/_build/html/reference_guide/index.html#rgb-recipes">📖 RGB Recipes Docs</a></p></li>
-<li><p><a class="reference external" href="https://github.com/blaylockbk/goes2go/blob/master/notebooks/DEMO_rgb_recipies.ipynb">📓 Example Notebook</a></p></li>
 </ul>
 <div class="figure align-default">
 <img alt="_images/TrueColor.png" class="img-fluid" src="_images/TrueColor.png" />
@@ -300,7 +304,7 @@ <h3>Field of View<a class="headerlink" href="#field-of-view" title="Permalink to
 <h4>Advanced Baseline Imager (ABI)<a class="headerlink" href="#advanced-baseline-imager-abi" title="Permalink to this headline">¶</a></h4>
 <p>GOES-West is centered over -137 W and GOES-East is centered over -75 W. When GOES was being tested, it was in a “central” position, outlined in the dashed black line. Below is the ABI field of view for the full disk:</p>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/blaylockbk/goes2go/blob/master/notebooks/field-of-view_ABI.ipynb">📓 ABI field of view notebook</a></p></li>
+<li><p><a class="reference external" href="https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/field-of-view_ABI.html">📓 ABI field of view notebook</a></p></li>
 </ul>
 <div class="figure align-default">
 <img alt="_images/ABI_field-of-view.png" class="img-fluid" src="_images/ABI_field-of-view.png" />
@@ -317,8 +321,8 @@ <h4>Advanced Baseline Imager (ABI)<a class="headerlink" href="#advanced-baseline
 <h4>Geostationary Lightning Mapper (GLM)<a class="headerlink" href="#geostationary-lightning-mapper-glm" title="Permalink to this headline">¶</a></h4>
 <p>The GLM field of view is slightly smaller and limited by a bounding box. The field of view can be estimated.</p>
 <ul class="simple">
-<li><p><a class="reference external" href="https://github.com/blaylockbk/goes2go/blob/master/notebooks/field-of-view_GLM.ipynb">📓 GLM field of view notebook</a></p></li>
-<li><p><a class="reference external" href="https://github.com/blaylockbk/goes2go/blob/master/notebooks/field-of-view_GLM_Edges.ipynb">📓 More details on actual edges</a></p></li>
+<li><p><a class="reference external" href="https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/field-of-view_GLM.html">📓 GLM field of view notebook</a></p></li>
+<li><p><a class="reference external" href="https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/field-of-view_GLM_Edges.html">📓 More details on actual edges</a></p></li>
 </ul>
 <div class="figure align-default" id="id3">
 <img alt="_images/GLM_field-of-view.png" class="img-fluid" src="_images/GLM_field-of-view.png" />

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/_build/html/user_guide/notebooks/DEMO_rgb_recipes.html b/docs/_build/html/user_guide/notebooks/DEMO_rgb_recipes.html
@@ -650,7 +650,7 @@ <h2>All available RGB recipes<a class="headerlink" href="#All-available-RGB-reci
 <span class="kn">import</span> <span class="nn">cartopy.crs</span> <span class="k">as</span> <span class="nn">ccrs</span>
 <span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
 
-<span class="c1"># Function from Carpenter_Workshop:</span>
+<span class="c1"># Function from Carpenter_Workshop: https://github.com/blaylockbk/Carpenter_Workshop</span>
 <span class="kn">from</span> <span class="nn">toolbox.cartopy_tools</span> <span class="kn">import</span> <span class="n">common_features</span>
 </pre></div>
 </div>

diff --git a/docs/_build/html/user_guide/notebooks/DEMO_rgb_recipes.ipynb b/docs/_build/html/user_guide/notebooks/DEMO_rgb_recipes.ipynb
@@ -160,7 +160,7 @@
     "import cartopy.crs as ccrs\n",
     "import matplotlib.pyplot as plt\n",
     "\n",
-    "# Function from Carpenter_Workshop: \n",
+    "# Function from Carpenter_Workshop: https://github.com/blaylockbk/Carpenter_Workshop\n",
     "from toolbox.cartopy_tools import common_features"
    ]
   },

diff --git a/docs/index.rst b/docs/index.rst
@@ -45,9 +45,14 @@ Download Data
 
 The following example downloads GOES 16 ABI multichannel file on the fixed grid for the CONUS domain and reads it with xarray for the latest image and an image nearest a specific time.
 
+- `📖 Download latest <https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/DEMO_download_goes_nearesttime.html>`_
+- `📖 Download nearest time <https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/DEMO_download_goes_latest.html>`_
+- `📖 Download time series <https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/DEMO_download_goes_timerange.html>`_
+
+
 .. code-block:: python
 
-   from goes2go.data import goes_latest, goes_nearesttime
+   from goes2go.data import goes_latest, goes_nearesttime, goes_timeseries
 
    # Get latest data
    G1 = goes_latest(satellite='G16', product='ABI')
@@ -60,7 +65,6 @@ RGB Recipes for ABI
 Generate RGB arrays for different RGB products. Check out the following notebook for a demonstration:
 
 - `📖 RGB Recipes Docs <https://blaylockbk.github.io/goes2go/_build/html/reference_guide/index.html#rgb-recipes>`_
-- `📓 Example Notebook <https://github.com/blaylockbk/goes2go/blob/master/notebooks/DEMO_rgb_recipies.ipynb>`_
 
 .. figure:: _static/TrueColor.png
    :class: img-fluid
@@ -74,7 +78,7 @@ Advanced Baseline Imager (ABI)
 """"""""""""""""""""""""""""""
 GOES-West is centered over -137 W and GOES-East is centered over -75 W. When GOES was being tested, it was in a "central" position, outlined in the dashed black line. Below is the ABI field of view for the full disk:
 
-- `📓 ABI field of view notebook <https://github.com/blaylockbk/goes2go/blob/master/notebooks/field-of-view_ABI.ipynb>`_
+- `📓 ABI field of view notebook <https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/field-of-view_ABI.html>`_
 
 .. figure:: _static/ABI_field-of-view.png
    :class: img-fluid
@@ -91,8 +95,8 @@ Geostationary Lightning Mapper (GLM)
 """"""""""""""""""""""""""""""""""""
 The GLM field of view is slightly smaller and limited by a bounding box. The field of view can be estimated.
 
-- `📓 GLM field of view notebook <https://github.com/blaylockbk/goes2go/blob/master/notebooks/field-of-view_GLM.ipynb>`_
-- `📓 More details on actual edges <https://github.com/blaylockbk/goes2go/blob/master/notebooks/field-of-view_GLM_Edges.ipynb>`_
+- `📓 GLM field of view notebook <https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/field-of-view_GLM.html>`_
+- `📓 More details on actual edges <https://blaylockbk.github.io/goes2go/_build/html/user_guide/notebooks/field-of-view_GLM_Edges.html>`_
 
 .. figure:: _static/GLM_field-of-view.png
    :class: img-fluid