AddDocs

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

@@ -7,6 +7,8 @@ Climate API
 Utility
 #######
 
+Variable lists.
+
 .. function:: climate_api.get_vars3D()
 
 	Returns (Dictionary<string,int>): 3D atmospheric variables accessible with the KWP climate API. (Key = variable name, Value = variable index)
@@ -18,6 +20,7 @@ Utility
 
 Wind
 ####
+Retrieve atmospheric wind data
 
 .. function:: climate_api.uwind(latitude, longitude, altitude, ut)
 
@@ -55,6 +58,8 @@ Wind
 Ambient Conditions
 ##################
 
+Retrieve column (3D) atmospheric variables
+
 .. function:: climate_api.pressure(latitude, longitude, altitude, ut)
 
 	Parameters 
@@ -113,6 +118,8 @@ Ambient Conditions
 Surface Conditions
 ##################
 
+Retrieve surface (2D) atmospheric variables
+
 .. function:: climate_api.OLR(latitude, longitude, ut)
 
 	Parameters 
@@ -177,6 +184,8 @@ Surface Conditions
 Derivatives
 ###########
 
+Derive variables from climate API calls above.
+
 .. function:: climate_api.density(pressure, temperature)
 
 	Parameters 
@@ -213,12 +222,22 @@ Derivatives
 
 	Returns (string): cardinal wind direction. Direction in which the wind is coming from (e.g. NE or SW)
 
+.. function:: climate_api.cloud_top_temps(olr)
+
+	Parameters 
+
+		* olr (double) - outgoing longwave radiation (W/m^2)
+
+	Returns (string): cloud top temperatures (K). Cloud top temperature. If skies are clear this is an estimate of the land/sea surface temperature.
+
 Weather API
 -----------
 
 Utility
 #######
 
+List of available launch sites and atmospheric variables
+
 	lsites (List<string>)
 		* list of available launch sites (three letter abbreviations)
 
@@ -260,6 +279,8 @@ Utility
 Wind
 ####
 
+Retrieve atmospheric wind data
+
 .. function:: weather_api.uwind(altitude, ut)
 
 	Parameters 
@@ -290,6 +311,8 @@ Wind
 Ambient Conditions
 ##################
 
+Retrieve column (3D) atmospheric variables
+
 .. function:: weather_api.pressure(altitude, ut)
 
 	Parameters 
@@ -338,6 +361,8 @@ Ambient Conditions
 Surface Conditions
 ##################
 
+Retrieve surface (2D) atmospheric variables
+
 .. function:: weather_api.OLR(ut)
 
 	Parameters 
@@ -389,6 +414,8 @@ Surface Conditions
 Derivatives
 ###########
 
+Derive variables from weather API calls above.
+
 .. function:: weather_api.density(pressure, temperature)
 
 	Parameters 
@@ -425,4 +452,11 @@ Derivatives
 
 	Returns (string): cardinal wind direction. Direction in which the wind is coming from (e.g. NE or SW)
 
+.. function:: weather_api.cloud_top_temps(olr)
+
+	Parameters 
+
+		* olr (double) - outgoing longwave radiation (W/m^2)
+
+	Returns (string): cloud top temperatures (K). Cloud top temperature. If skies are clear this is an estimate of the land/sea surface temperature.
 

docs/_build/html/api.html

@@ -47,6 +47,7 @@ <h1>API Documentation<a class="headerlink" href="#api-documentation" title="Perm
 <h2>Climate API<a class="headerlink" href="#climate-api" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="utility">
 <h3>Utility<a class="headerlink" href="#utility" title="Permalink to this headline">¶</a></h3>
+<p>Variable lists.</p>
 <dl class="py function">
 <dt id="climate_api.get_vars3D">
 <code class="sig-prename descclassname">climate_api.</code><code class="sig-name descname">get_vars3D</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#climate_api.get_vars3D" title="Permalink to this definition">¶</a></dt>
@@ -62,6 +63,7 @@ <h3>Utility<a class="headerlink" href="#utility" title="Permalink to this headli
 </div>
 <div class="section" id="wind">
 <h3>Wind<a class="headerlink" href="#wind" title="Permalink to this headline">¶</a></h3>
+<p>Retrieve atmospheric wind data</p>
 <dl class="py function">
 <dt id="climate_api.uwind">
 <code class="sig-prename descclassname">climate_api.</code><code class="sig-name descname">uwind</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">latitude</span></em>, <em class="sig-param"><span class="n">longitude</span></em>, <em class="sig-param"><span class="n">altitude</span></em>, <em class="sig-param"><span class="n">ut</span></em><span class="sig-paren">)</span><a class="headerlink" href="#climate_api.uwind" title="Permalink to this definition">¶</a></dt>
@@ -110,6 +112,7 @@ <h3>Wind<a class="headerlink" href="#wind" title="Permalink to this headline">¶
 </div>
 <div class="section" id="ambient-conditions">
 <h3>Ambient Conditions<a class="headerlink" href="#ambient-conditions" title="Permalink to this headline">¶</a></h3>
+<p>Retrieve column (3D) atmospheric variables</p>
 <dl class="py function">
 <dt id="climate_api.pressure">
 <code class="sig-prename descclassname">climate_api.</code><code class="sig-name descname">pressure</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">latitude</span></em>, <em class="sig-param"><span class="n">longitude</span></em>, <em class="sig-param"><span class="n">altitude</span></em>, <em class="sig-param"><span class="n">ut</span></em><span class="sig-paren">)</span><a class="headerlink" href="#climate_api.pressure" title="Permalink to this definition">¶</a></dt>
@@ -188,6 +191,7 @@ <h3>Ambient Conditions<a class="headerlink" href="#ambient-conditions" title="Pe
 </div>
 <div class="section" id="surface-conditions">
 <h3>Surface Conditions<a class="headerlink" href="#surface-conditions" title="Permalink to this headline">¶</a></h3>
+<p>Retrieve surface (2D) atmospheric variables</p>
 <dl class="py function">
 <dt id="climate_api.OLR">
 <code class="sig-prename descclassname">climate_api.</code><code class="sig-name descname">OLR</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">latitude</span></em>, <em class="sig-param"><span class="n">longitude</span></em>, <em class="sig-param"><span class="n">ut</span></em><span class="sig-paren">)</span><a class="headerlink" href="#climate_api.OLR" title="Permalink to this definition">¶</a></dt>
@@ -275,6 +279,7 @@ <h3>Surface Conditions<a class="headerlink" href="#surface-conditions" title="Pe
 </div>
 <div class="section" id="derivatives">
 <h3>Derivatives<a class="headerlink" href="#derivatives" title="Permalink to this headline">¶</a></h3>
+<p>Derive variables from climate API calls above.</p>
 <dl class="py function">
 <dt id="climate_api.density">
 <code class="sig-prename descclassname">climate_api.</code><code class="sig-name descname">density</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">pressure</span></em>, <em class="sig-param"><span class="n">temperature</span></em><span class="sig-paren">)</span><a class="headerlink" href="#climate_api.density" title="Permalink to this definition">¶</a></dt>
@@ -327,12 +332,25 @@ <h3>Derivatives<a class="headerlink" href="#derivatives" title="Permalink to thi
 <p>Returns (string): cardinal wind direction. Direction in which the wind is coming from (e.g. NE or SW)</p>
 </dd></dl>
 
+<dl class="py function">
+<dt id="climate_api.cloud_top_temps">
+<code class="sig-prename descclassname">climate_api.</code><code class="sig-name descname">cloud_top_temps</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">olr</span></em><span class="sig-paren">)</span><a class="headerlink" href="#climate_api.cloud_top_temps" title="Permalink to this definition">¶</a></dt>
+<dd><p>Parameters</p>
+<blockquote>
+<div><ul class="simple">
+<li><p>olr (double) - outgoing longwave radiation (W/m^2)</p></li>
+</ul>
+</div></blockquote>
+<p>Returns (string): cloud top temperatures (K). Cloud top temperature. If skies are clear this is an estimate of the land/sea surface temperature.</p>
+</dd></dl>
+
 </div>
 </div>
 <div class="section" id="weather-api">
 <h2>Weather API<a class="headerlink" href="#weather-api" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="id1">
 <h3>Utility<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
+<p>List of available launch sites and atmospheric variables</p>
 <blockquote>
 <div><dl class="simple">
 <dt>lsites (List&lt;string&gt;)</dt><dd><ul class="simple">
@@ -394,6 +412,7 @@ <h3>Utility<a class="headerlink" href="#id1" title="Permalink to this headline">
 </div>
 <div class="section" id="id2">
 <h3>Wind<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
+<p>Retrieve atmospheric wind data</p>
 <dl class="py function">
 <dt id="weather_api.uwind">
 <code class="sig-prename descclassname">weather_api.</code><code class="sig-name descname">uwind</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">altitude</span></em>, <em class="sig-param"><span class="n">ut</span></em><span class="sig-paren">)</span><a class="headerlink" href="#weather_api.uwind" title="Permalink to this definition">¶</a></dt>
@@ -436,6 +455,7 @@ <h3>Wind<a class="headerlink" href="#id2" title="Permalink to this headline">¶<
 </div>
 <div class="section" id="id3">
 <h3>Ambient Conditions<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
+<p>Retrieve column (3D) atmospheric variables</p>
 <dl class="py function">
 <dt id="weather_api.pressure">
 <code class="sig-prename descclassname">weather_api.</code><code class="sig-name descname">pressure</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">altitude</span></em>, <em class="sig-param"><span class="n">ut</span></em><span class="sig-paren">)</span><a class="headerlink" href="#weather_api.pressure" title="Permalink to this definition">¶</a></dt>
@@ -504,6 +524,7 @@ <h3>Ambient Conditions<a class="headerlink" href="#id3" title="Permalink to this
 </div>
 <div class="section" id="id4">
 <h3>Surface Conditions<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
+<p>Retrieve surface (2D) atmospheric variables</p>
 <dl class="py function">
 <dt id="weather_api.OLR">
 <code class="sig-prename descclassname">weather_api.</code><code class="sig-name descname">OLR</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">ut</span></em><span class="sig-paren">)</span><a class="headerlink" href="#weather_api.OLR" title="Permalink to this definition">¶</a></dt>
@@ -579,6 +600,7 @@ <h3>Surface Conditions<a class="headerlink" href="#id4" title="Permalink to this
 </div>
 <div class="section" id="id5">
 <h3>Derivatives<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
+<p>Derive variables from weather API calls above.</p>
 <dl class="py function">
 <dt id="weather_api.density">
 <code class="sig-prename descclassname">weather_api.</code><code class="sig-name descname">density</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">pressure</span></em>, <em class="sig-param"><span class="n">temperature</span></em><span class="sig-paren">)</span><a class="headerlink" href="#weather_api.density" title="Permalink to this definition">¶</a></dt>
@@ -631,6 +653,18 @@ <h3>Derivatives<a class="headerlink" href="#id5" title="Permalink to this headli
 <p>Returns (string): cardinal wind direction. Direction in which the wind is coming from (e.g. NE or SW)</p>
 </dd></dl>
 
+<dl class="py function">
+<dt id="weather_api.cloud_top_temps">
+<code class="sig-prename descclassname">weather_api.</code><code class="sig-name descname">cloud_top_temps</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">olr</span></em><span class="sig-paren">)</span><a class="headerlink" href="#weather_api.cloud_top_temps" title="Permalink to this definition">¶</a></dt>
+<dd><p>Parameters</p>
+<blockquote>
+<div><ul class="simple">
+<li><p>olr (double) - outgoing longwave radiation (W/m^2)</p></li>
+</ul>
+</div></blockquote>
+<p>Returns (string): cloud top temperatures (K). Cloud top temperature. If skies are clear this is an estimate of the land/sea surface temperature.</p>
+</dd></dl>
+
 </div>
 </div>
 </div>

docs/_build/html/genindex.html

@@ -50,6 +50,8 @@ <h2 id="B">B</h2>
 
       <ul>
         <li><a href="api.html#climate_api.cloud_cover">climate_api.cloud_cover()</a>
+</li>
+        <li><a href="api.html#climate_api.cloud_top_temps">climate_api.cloud_top_temps()</a>
 </li>
         <li><a href="api.html#climate_api.density">climate_api.density()</a>
 </li>
@@ -90,6 +92,8 @@ <h2 id="B">B</h2>
         <li><a href="api.html#climate_api.zwind">climate_api.zwind()</a>
 </li>
         <li><a href="api.html#weather_api.cloud_cover">weather_api.cloud_cover()</a>
+</li>
+        <li><a href="api.html#weather_api.cloud_top_temps">weather_api.cloud_top_temps()</a>
 </li>
         <li><a href="api.html#weather_api.density">weather_api.density()</a>
 </li>
@@ -145,6 +149,13 @@ <h2 id="C">C</h2>
 
       <ul>
         <li><a href="api.html#climate_api.cloud_cover">built-in function</a>
+</li>
+      </ul></li>
+      <li>
+    climate_api.cloud_top_temps()
+
+      <ul>
+        <li><a href="api.html#climate_api.cloud_top_temps">built-in function</a>
 </li>
       </ul></li>
       <li>
@@ -293,6 +304,13 @@ <h2 id="W">W</h2>
 
       <ul>
         <li><a href="api.html#weather_api.cloud_cover">built-in function</a>
+</li>
+      </ul></li>
+      <li>
+    weather_api.cloud_top_temps()
+
+      <ul>
+        <li><a href="api.html#weather_api.cloud_top_temps">built-in function</a>
 </li>
       </ul></li>
       <li>