Update RequestParams; add plot images to docs

Author: camirmas

Usage.ipynb

@@ -16,6 +16,8 @@ def boxplot(data, fields=None, labels=None, **box_kwargs):
     """
     Draws boxplots of wind speeds.
 
+    .. image:: ../docs/boxplot.jpg
+
     Args:
       data (DataFrame): wind data
       fields (:obj:`list` of :obj:`str`, optional): a list of columns to include from the
@@ -67,6 +69,8 @@ def plot_windrose(data, speed=None, direction=None, **wr_kwargs):
     """
     Generates a windrose plot from the given data.
 
+    .. image:: ../docs/windrose.png
+
     Args:
       data (DataFrame): Wind data
       speed (str, optional): Wind speed column name. If not provided, it will be inferred
@@ -114,6 +118,8 @@ def pdf(data, speed=None, hist_kwargs=None, plot_kwargs=None):
     """
     Generates a Weibull probability density plot from the given data.
 
+    .. image:: ../docs/pdf.jpg
+
     Args:
       data (DataFrame): Wind data
       speed (str, optional): Wind speed column name. If not provided, it will be inferred
@@ -211,6 +217,8 @@ def plot_diurnal_stats(data, speed=None):
     """
     Plots basic relevant diurnal wind speed statistics for the given data.
 
+    .. image:: ../docs/diurnal.jpg
+
     Args:
       data (DataFrame): Wind data
       speed (str, optional): Wind speed column name. If not provided, it will be inferred
@@ -231,8 +239,8 @@ def plot_diurnal_stats(data, speed=None):
     for i, label in enumerate(stats_df):
         ax.plot(stats_df[label], label=label, marker=markers[i])
 
-    ax.set_xlabel('Hour')
-    ax.set_ylabel('Wind Speed (m/s)')
+    ax.set_xlabel('Hour', fontsize='large')
+    ax.set_ylabel('Wind Speed (m/s)', fontsize='large')
     ax.set_xticks(np.arange(0, 23, 2))
     ax.legend()
 

albatross/analysis.py

@@ -118,7 +118,7 @@ def __init__(self):
     def get_fields(cls):
         """
         Returns a list of fields that can be used as parameters.
-        
+
         Returns:
           list: A list of valid parameters:
 
@@ -147,10 +147,10 @@ def get_fields(cls):
 
         return height + other
 
-    def register(self, field, height=None):
+    def register(self, field, heights=None):
         """
         Registers a new request field.
-        
+
         Args:
           field (str): A field name. Must be a valid field name (see `RequestParams.get_fields`)
           height (int): A height (m). Must fall into the following ranges (inclusive):
@@ -168,13 +168,16 @@ def register(self, field, height=None):
         assert field in self._HEIGHT_FIELDS or field in self._OTHER_FIELDS, msg
 
         if field in self._HEIGHT_FIELDS:
-            assert height is not None, '"height" is required for this field.'
-            assert isinstance(height, int), '"height" must be an integer.'
+            assert heights is not None, '"heights" required for this field.'
+            assert isinstance(heights, list), '"heights" must be a list.'
+            msg = '"heights" elements must be integers.'
+            assert all([isinstance(h, int) for h in heights]), msg
             height_range = self._HEIGHT_FIELDS[field]['height_range']
-            msg = f'"height" must be in {height_range}.'
-            assert height in height_range, msg
 
-            field_name = self._HEIGHT_FIELDS[field]['field']
-            self.params.append(f'{field_name}_{height}m')
+            for height in heights:
+                msg = f'"height" must be in {height_range}.'
+                assert height in height_range, msg
+                field_name = self._HEIGHT_FIELDS[field]['field']
+                self.params.append(f'{field_name}_{height}m')
         else:
             self.params.append(self._OTHER_FIELDS[field])

albatross/classes.py

@@ -58,19 +58,26 @@ def test_RequestParams_register_invalid_field():
     with pytest.raises(AssertionError) as e:
         rp.register('wind_speed')
 
-    msg = '"height" is required for this field.'
+    msg = '"heights" required for this field.'
+    assert str(e.value) == msg
+
+    # invalid heights
+    with pytest.raises(AssertionError) as e:
+        rp.register('wind_speed', heights='12')
+
+    msg = '"heights" must be a list.'
     assert str(e.value) == msg
 
     # invalid height
     with pytest.raises(AssertionError) as e:
-        rp.register('wind_speed', height='12')
+        rp.register('wind_speed', heights=['12'])
 
-    msg = '"height" must be an integer.'
+    msg = '"heights" elements must be integers.'
     assert str(e.value) == msg
 
     # height out of range
     with pytest.raises(AssertionError) as e:
-        rp.register('wind_speed', height=0)
+        rp.register('wind_speed', heights=[0])
 
     msg = '"height" must be in range(10, 201).'
     assert str(e.value) == msg
@@ -82,12 +89,12 @@ def test_RequestParams_register():
     """Test `register`."""
     rp = RequestParams()
 
-    rp.register('wind_speed', height=10)
+    rp.register('wind_speed', heights=[10, 20, 30])
 
-    assert len(rp.params) == 1
-    assert rp.params[0] == 'windspeed_10m'
+    assert len(rp.params) == 3
+    assert rp.params[:3] == ['windspeed_10m', 'windspeed_20m', 'windspeed_30m']
 
     rp.register('inverse_monin_obukhov_length')
 
-    assert len(rp.params) == 2
-    assert rp.params[1] == 'inversemoninobukhovlength_2m'
+    assert len(rp.params) == 4
+    assert rp.params[3] == 'inversemoninobukhovlength_2m'