diff --git a/docs/_build/doctrees/api.doctree b/docs/_build/doctrees/api.doctree index 2cd5a12..99eddac 100644 Binary files a/docs/_build/doctrees/api.doctree and b/docs/_build/doctrees/api.doctree differ diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle index 4e4700f..10a2ef0 100644 Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ diff --git a/docs/_build/html/_sources/api.rst.txt b/docs/_build/html/_sources/api.rst.txt index bee8f73..599047d 100644 --- a/docs/_build/html/_sources/api.rst.txt +++ b/docs/_build/html/_sources/api.rst.txt @@ -7,6 +7,8 @@ Climate API Utility ####### +Variable lists. + .. function:: climate_api.get_vars3D() Returns (Dictionary): 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) * 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. diff --git a/docs/_build/html/api.html b/docs/_build/html/api.html index f324fa6..d5d1018 100644 --- a/docs/_build/html/api.html +++ b/docs/_build/html/api.html @@ -47,6 +47,7 @@

API Documentation

Utility

+

Variable lists.

climate_api.get_vars3D()
@@ -62,6 +63,7 @@

Utility

Wind

+

Retrieve atmospheric wind data

climate_api.uwind(latitude, longitude, altitude, ut)
@@ -110,6 +112,7 @@

Wind

Ambient Conditions

+

Retrieve column (3D) atmospheric variables

climate_api.pressure(latitude, longitude, altitude, ut)
@@ -188,6 +191,7 @@

Ambient Conditions

Surface Conditions

+

Retrieve surface (2D) atmospheric variables

climate_api.OLR(latitude, longitude, ut)
@@ -275,6 +279,7 @@

Surface Conditions

Derivatives

+

Derive variables from climate API calls above.

climate_api.density(pressure, temperature)
@@ -327,12 +332,25 @@

Derivatives +
+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>)
    @@ -394,6 +412,7 @@

    Utility

Wind

+

Retrieve atmospheric wind data

weather_api.uwind(altitude, ut)
@@ -436,6 +455,7 @@

Wind¶<

Ambient Conditions

+

Retrieve column (3D) atmospheric variables

weather_api.pressure(altitude, ut)
@@ -504,6 +524,7 @@

Ambient Conditions

Surface Conditions

+

Retrieve surface (2D) atmospheric variables

weather_api.OLR(ut)
@@ -579,6 +600,7 @@

Surface Conditions

Derivatives

+

Derive variables from weather API calls above.

weather_api.density(pressure, temperature)
@@ -631,6 +653,18 @@

Derivatives +
+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.

+

+

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html index b065928..fca45ea 100644 --- a/docs/_build/html/genindex.html +++ b/docs/_build/html/genindex.html @@ -50,6 +50,8 @@

B