fixing comments snippets

Author: rizac

egsim/api/data/client/snippets/get_egsim_predictions.py

@@ -36,17 +36,17 @@ def get_egsim_predictions(
 
     A [pandas DataFrame](https://pandas.pydata.org/docs/user_guide/dsintro.html#dataframe)
     
-    Each row denotes a scenario (i.e., a combination of a given Rupture and Site) and
-    each column the scenario configured or computed properties. More specifically, except
-    the first column (denoting a unique scenario identifier, incremental and starting
-    from 0), each column denotes:
+    Each row denotes a scenario (i.e., a combination of a given Rupture and Site)
+    labelled by a unique integer id, incremental and starting from 0 (*), and each column
+    denotes:
 
-    - a computed prediction if the first chunk of ts name is an intensity measure type
-      (e.g. "PGA median BindiEtAl2014Rjb"): in this case, the second chunk is the metric 
-      type (e.g. "median") and the third the predicting model ("BindiEtAl2014Rjb")
+    - a computed prediction if the first chunk of the column name is an intensity
+      measure type (e.g. "PGA median BindiEtAl2014Rjb"): in this case, the second chunk
+      is the metric type (e.g. "median") and the third the predicting model
+      ("BindiEtAl2014Rjb")
     
-    - the scenario configured properties if the first chunk is the text "input" (e.g.,
-      "input distance_measure rrup"): in this case, the second
+    - a scenario input property if the first chunk of the column name is the text "input"
+      (e.g., "input distance_measure rrup"): in this case, the second
       chunk is the configuration data type ("distance_measure", "intensity_measure",
       "rupture_parameter", "site_parameter" or "uncategorized") and the third is the
       configuration data name ("rrup")

egsim/api/data/client/snippets/get_egsim_residuals.py

@@ -51,24 +51,23 @@ def get_egsim_residuals(
 
     A [pandas DataFrame](https://pandas.pydata.org/docs/user_guide/dsintro.html#dataframe)
     
-    If ranking is True, then each row denotes a model (reported in the first column)
-    and each column a measure of fit (reported in the first row).
+    If ranking is True, then each row denotes a model (labelled by the unique model name)
+    and each column a measure of fit.
     
-    If ranking is False, then each row denotes a flatfile record and each column the
-    record configured or computed properties. More specifically, except the first
-    column (denoting the record id, i.e. the position in the original flatfile,
-    starting from 0), each column denotes:
+    If ranking is False, then each row denotes a flatfile record, labelled by a unique
+    integer id (the record position in the original flatfile, starting from 0), and
+    each column denotes:
     
-    - a computed residual or prediction, if the first chunk of ts name is an intensity
-      measure type (e.g. "PGA total_residual BindiEtAl2014Rjb"): in this case, the
-      second chunk is the metric type ("total_residual") and the third the predicting
+    - a computed residual or prediction if the first chunk of the column name is an
+      intensity measure type (e.g. "PGA total_residual BindiEtAl2014Rjb"): in this case,
+      the second chunk is the metric type ("total_residual") and the third the predicting
       model ("BindiEtAl2014Rjb")
     
-    - the flatfile data relative to the computed prediction if the first chunk
-      is the text "input"  (e.g., "input distance_measure rrup"): in this case, the
-      second chunk is the flatfile data type ("distance_measure", "intensity_measure",
-      "rupture_parameter", "site_parameter" or "uncategorized") and the third the
-      data name ("rrup")
+    - a record input property (copied from the original flatfile) if the first chunk
+      of the column name is the text "input"  (e.g., "input distance_measure rrup"): in
+      this case, the second chunk is the flatfile data type ("distance_measure",
+      "intensity_measure", "rupture_parameter", "site_parameter" or "uncategorized") and
+      the third the data name ("rrup")
     """
     # request parameters:
     parameters = {

egsim/smtk/validation.py

@@ -106,16 +106,12 @@ def validate_imt_sa_limits(model: GMPE, imts: dict[str, IMT]) -> dict[str, IMT]:
         are valid for the given model
     """
     model_sa_p_lim = get_sa_limits(model)
-    if model_sa_p_lim is None:
-        return imts
-    imt_periods = {i: sa_period(v) for i, v in imts.items()}
-    if all(_ is None for _ in imt_periods.values()):
-        return imts
-    imt_new = {}
-    for imt_n, sa_p in imt_periods.items():
-        if sa_p is None or model_sa_p_lim[0] <= sa_p <= model_sa_p_lim[1]:
-            imt_new[imt_n] = imts[imt_n]
-    return imt_new
+    return {
+        i: v for i, v in imts.items()
+        if model_sa_p_lim is None
+        or sa_period(v) is None
+        or model_sa_p_lim[0] <= sa_period(v) <= model_sa_p_lim[1]
+    }
 
 
 # Custom Exceptions: