minor revision

ezyrb/database.py

@@ -67,11 +67,15 @@ def __getitem__(self, val):
                         self.scaler_parameters, self.scaler_snapshots)
 
     def __len__(self):
+        """
+        This method returns the number of snapshots
+        """
         return len(self._snapshots)
 
     def add(self, parameters, snapshots):
         """
-        TO DOC
+        Add (by row) new sets of snapshots and paramters to the original
+        database
         """
         if len(parameters) != len(snapshots):
             raise RuntimeError('Different number of parameters and snapshots.')

ezyrb/pod.py

@@ -1,16 +1,14 @@
-
 """
 Module for Proper Orthogonal Decomposition (POD) via default svd
 """
 
-from reduction import Reduction
-
 import numpy as np
 
+from .reduction import Reduction
+
+
 class POD(Reduction):
     def __init__(self, method='svd', **kwargs):
-        """
-        """
         available_methods = {
             'svd': (self._svd, {
                 'rank': -1

ezyrb/reducedordermodel.py

@@ -35,6 +35,8 @@ def predict(self, mu):
 
     def test_error(self, test, norm=np.linalg.norm):
         """
+        Compute the mean norm of the relative error vector of a predicted
+        test snapshot
         """
         predicted_test = self.predict(test.parameters)
         return np.mean(norm(predicted_test - test.snapshots, axis=1)/norm(test.snapshots, axis=1))