New option --detailed for print_families

Author: claudiodsf

CHANGELOG.md

@@ -22,6 +22,8 @@ to the latest version.
   files without asking
 - New option `--freq_band` for trace plotting commands, to override the
   frequency band specified in the config file
+- New option `--detailed` for `print_families`, to print more detailed
+  information about each family, including the list of events
 - Config option `waveform_data_path` renamed to `sds_data_path`
 - New config option `event_data_path` to specify the path to a local directory
   with waveform files organized per event

requake/config/parse_arguments.py

@@ -309,13 +309,18 @@ def parse_arguments(progname='requake'):
     )
     # ---
     # --- print_families
-    subparser.add_parser(
+    printfamilies = subparser.add_parser(
         'print_families',
         parents=[
             longerthan, shorterthan, minevents, family_numbers, print_format
         ],
         help='print families to screen'
     )
+    printfamilies.add_argument(
+        '-d', '--detailed', action='store_true',
+        help='print detailed information for each family, including a list '
+             'of events'
+    )
     # ---
     # --- plot_families
     plotfamilies = subparser.add_parser(

requake/families/print_families.py

@@ -11,37 +11,49 @@
 """
 import logging
 import numpy as np
-from ..config import generic_printer, rq_exit
+from ..config import config, generic_printer, rq_exit
 from .families import FamilyNotFoundError, read_selected_families
 logger = logging.getLogger(__name__.rsplit('.', maxsplit=1)[-1])
 
 
-def print_families():
+def _print_family_details(family, duration_units, duration_multiplier):
     """
-    Print families to screen.
+    Print details of a family to screen.
+
+    :param family: Family to print.
+    :type family: requake.families.Family
+    :param duration_units: Units for duration.
+    :type duration_units: str
+    :param duration_multiplier: Multiplier for duration.
+    :type duration_multiplier: float
     """
-    try:
-        families = read_selected_families()
-    except (FileNotFoundError, FamilyNotFoundError) as msg:
-        logger.error(msg)
-        rq_exit(1)
+    print(f'Family: {family.number}')
+    print(f'Number of events: {len(family)}')
+    print(f'Longitude: {family.lon:.4f}')
+    print(f'Latitude: {family.lat:.4f}')
+    print(f'Depth: {family.depth:.3f} km')
+    print(f'Start time: {family.starttime}')
+    print(f'End time: {family.endtime}')
+    duration = family.duration * duration_multiplier
+    print(f'Duration: {duration:.2f} {duration_units}')
+    print(f'Slip rate: {family.slip_rate:.1f} cm/y')
+    print(f'Magnitude range: {family.magmin:.1f} - {family.magmax:.1f}')
+    print('Events:')
+    for event in family:
+        print(f'  {event}')
 
-    # determine duration units
-    average_duration = np.mean([f.duration for f in families])
-    avg_duration_in_days = average_duration * 365
-    if 30 < avg_duration_in_days < 365:
-        duration_multiplier = 12
-        duration_units = 'mons'
-    elif 1 < avg_duration_in_days < 30:
-        duration_multiplier = 365
-        duration_units = 'days'
-    elif 1/24 < avg_duration_in_days < 1:
-        duration_multiplier = 365 * 24
-        duration_units = 'hours'
-    else:
-        duration_multiplier = 365 * 24 * 60
-        duration_units = 'mins'
 
+def _print_family_list(families, duration_units, duration_multiplier):
+    """
+    Print a list of families to screen.
+
+    :param families: Families to print.
+    :type families: list of requake.families.Family
+    :param duration_units: Units for duration.
+    :type duration_units: str
+    :param duration_multiplier: Multiplier for duration.
+    :type duration_multiplier: float
+    """
     headers_fmt = [
         ('family', None),
         ('nevents', None),
@@ -72,3 +84,37 @@ def print_families():
         ]
         rows.append(row)
     generic_printer(rows, headers_fmt)
+
+
+def print_families():
+    """
+    Print families to screen.
+    """
+    try:
+        families = read_selected_families()
+    except (FileNotFoundError, FamilyNotFoundError) as msg:
+        logger.error(msg)
+        rq_exit(1)
+
+    # determine duration units
+    average_duration = np.mean([f.duration for f in families])
+    avg_duration_in_days = average_duration * 365
+    if 30 < avg_duration_in_days < 365:
+        duration_multiplier = 12
+        duration_units = 'mons'
+    elif 1 < avg_duration_in_days < 30:
+        duration_multiplier = 365
+        duration_units = 'days'
+    elif 1/24 < avg_duration_in_days < 1:
+        duration_multiplier = 365 * 24
+        duration_units = 'hours'
+    else:
+        duration_multiplier = 365 * 24 * 60
+        duration_units = 'mins'
+
+    if config.args.detailed:
+        for family in families:
+            _print_family_details(family, duration_units, duration_multiplier)
+            print()
+    else:
+        _print_family_list(families, duration_units, duration_multiplier)