ARISTOTLE: add to level 2 interface the possibility to choose among different workflows

openquake/hazardlib/shakemap/parsers.py

@@ -43,6 +43,7 @@
 from openquake.baselib.node import node_from_xml
 from openquake.hazardlib import nrml, sourceconverter
 from openquake.hazardlib.source.rupture import get_multiplanar, is_matrix
+from openquake.hazardlib.scalerel import get_available_magnitude_scalerel
 
 NOT_FOUND = 'No file with extension \'.%s\' file found'
 US_GOV = 'https://earthquake.usgs.gov'
@@ -71,6 +72,7 @@
 }
 REQUIRED_IMTS = {'PGA', 'PSA03', 'PSA10'}
 
+
 @dataclass
 class User:
     level: int = 0
@@ -257,6 +259,8 @@ def utc_to_local_time(utc_timestamp, lon, lat):
     utc_time = utc_zone.localize(utc_time)
     local_zone = pytz.timezone(timezone_str)
     local_timestamp = utc_time.astimezone(local_zone)
+    # NOTE: we may keep microseconds and change the regex validating the format
+    local_timestamp = local_timestamp.replace(microsecond=0)
     return local_timestamp
 
 
@@ -402,18 +406,19 @@ def usgs_to_ecd_format(stations, exclude_imts=()):
     return df_seismic_non_null
 
 
-def _get_preferred_shakemap(shakemaps):
-    preferred_weights = [shakemap['preferredWeight'] for shakemap in shakemaps]
+def _get_preferred_item(items):
+    # items can be for instance shakemaps, moment tensors or finite faults
+    preferred_weights = [item['preferredWeight'] for item in items]
     preferred_idxs = [idx for idx, val in enumerate(preferred_weights)
                       if val == max(preferred_weights)]
-    preferred_shakemaps = [shakemaps[idx] for idx in preferred_idxs]
-    if len(preferred_shakemaps) > 1:
-        update_times = [shakemap['updateTime'] for shakemap in preferred_shakemaps]
+    preferred_items = [items[idx] for idx in preferred_idxs]
+    if len(preferred_items) > 1:
+        update_times = [item['updateTime'] for item in preferred_items]
         latest_idx = update_times.index(max(update_times))
-        shakemap = preferred_shakemaps[latest_idx]
+        item = preferred_items[latest_idx]
     else:
-        shakemap = preferred_shakemaps[0]
-    return shakemap
+        item = preferred_items[0]
+    return item
 
 
 def download_station_data_file(usgs_id, contents, user):
@@ -472,16 +477,17 @@ def load_rupdic_from_finite_fault(usgs_id, mag, products):
     """
     Extract the finite fault properties from products.
     NB: if the finite-fault list contains multiple elements we take the
-    first one.
+    preferred one.
     """
     logging.info('Getting finite-fault properties')
-    try:
-        ff = products['finite-fault']
-    except KeyError:
+    if 'finite-fault' not in products:
+        # e.g. us6000phrk
         # FIXME: not tested
-        raise MissingLink('There is no finite-fault info for %s' % usgs_id)
-    if isinstance(ff, list):
-        ff = ff[0]
+        err_msg = f'There is no finite-fault info for {usgs_id}'
+        err = {"status": "failed", "error_msg": err_msg}
+        return None, err
+    ffs = products['finite-fault']
+    ff = _get_preferred_item(ffs)
     p = ff['properties']
     lon = float(p['longitude'])
     lat = float(p['latitude'])
@@ -494,7 +500,40 @@ def load_rupdic_from_finite_fault(usgs_id, mag, products):
               'require_dip_strike': True,
               'pga_map_png': None, 'mmi_map_png': None,
               'usgs_id': usgs_id, 'rupture_file': None}
-    return rupdic
+    return rupdic, None
+
+
+def load_rupdic_from_origin(usgs_id, products):
+    """
+    Extract the origin properties from products.
+    NB: if the origin list contains multiple elements we take the
+    preferred one.
+    """
+    # TODO: we may try to unify this with the very similar load_rupdic_from_finite_fault
+    logging.info('Getting origin properties')
+    if 'origin' not in products:
+        # FIXME: not tested
+        err_msg = f'There is no origin info for {usgs_id}'
+        err = {"status": "failed", "error_msg": err_msg}
+        return None, err
+    origins = products['origin']
+    origin = _get_preferred_item(origins)
+    p = origin['properties']
+    mag = float(p['magnitude'])
+    lon = float(p['longitude'])
+    lat = float(p['latitude'])
+    dep = float(p['depth'])
+    rake = 0.
+    utc_time = p['eventtime']
+    local_time = utc_to_local_time(utc_time, lon, lat)
+    time_event = local_time_to_time_event(local_time)
+    rupdic = {'lon': lon, 'lat': lat, 'dep': dep,
+              'mag': mag, 'rake': rake,
+              'local_timestamp': str(local_time), 'time_event': time_event,
+              'require_dip_strike': True,
+              'pga_map_png': None, 'mmi_map_png': None,
+              'usgs_id': usgs_id, 'rupture_file': None}
+    return rupdic, None
 
 
 # NB: not used right now
@@ -638,7 +677,7 @@ def _contents_properties_shakemap(usgs_id, user, use_shakemap, monitor):
     properties = js['properties']
 
     # NB: currently we cannot find a case with missing shakemap
-    shakemap = _get_preferred_shakemap(properties['products']['shakemap'])
+    shakemap = _get_preferred_item(properties['products']['shakemap'])
     contents = shakemap['contents']
 
     if (user.level == 1 or use_shakemap) and 'download/grid.xml' in contents:
@@ -657,15 +696,36 @@ def _contents_properties_shakemap(usgs_id, user, use_shakemap, monitor):
     return contents, properties, shakemap_array, err
 
 
-def get_rup_dic(usgs_id, user=User(), use_shakemap=False,
-                rupture_file=None, station_data_file=None,
-                monitor=performance.Monitor()):
+def _get_nodal_planes(properties):
+    err = None
+    if 'moment-tensor' not in properties['products']:
+        err = 'Unable to retrieve information about the nodal solution'
+        return None, err
+    moment_tensor = _get_preferred_item(properties['products']['moment-tensor'])
+    props = moment_tensor['properties']
+    nodal_planes = {}
+    for key, value in props.items():
+        if key.startswith('nodal-plane-'):
+            parts = key.split('-')
+            plane = f'NP{parts[2]}'
+            attr = parts[3]  # Get the attribute (i.e. 'dip', 'rake' or 'strike')
+            if plane not in nodal_planes:
+                nodal_planes[plane] = {}
+            nodal_planes[plane][attr] = float(value)
+    return nodal_planes, err
+
+
+def get_rup_dic(dic, user=User(), approach='use_shakemap_from_usgs',
+                use_shakemap=False, rupture_file=None,
+                station_data_file=None, monitor=performance.Monitor()):
     """
     If the rupture_file is None, download a rupture from the USGS site given
     the ShakeMap ID, else build the rupture locally with the given usgs_id.
 
-    :param usgs_id: ShakeMap ID
+    :param dic: dictionary with ShakeMap ID and other parameters
     :param user: User instance
+    :param approach: the workflow selected by the user
+        (default: 'use_shakemap_from_usgs')
     :param use_shakemap: download the ShakeMap only if True
     :param rupture_file: None
     :param station_data_file: None
@@ -674,6 +734,15 @@ def get_rup_dic(usgs_id, user=User(), use_shakemap=False,
     rupdic = {}
     rup_data = {}
     err = {}
+    usgs_id = dic['usgs_id']
+    if approach == 'provide_rup_params':
+        rupdic = dic.copy()
+        rupdic.update(rupture_file=rupture_file,
+                      station_data_file=station_data_file,
+                      require_dip_strike=True)
+        rup = None
+        return rup, rupdic, err
+
     if rupture_file and rupture_file.endswith('.xml'):
         [rup_node] = nrml.read(os.path.join(user.testdir, rupture_file)
                                if user.testdir else rupture_file)
@@ -704,18 +773,30 @@ def get_rup_dic(usgs_id, user=User(), use_shakemap=False,
         usgs_id, user, use_shakemap, monitor)
     if err:
         return None, None, err
-
-    if 'download/rupture.json' not in contents:
+    if approach in ['use_pnt_rup_from_usgs', 'build_rup_from_usgs']:
+        rupdic, err = load_rupdic_from_origin(usgs_id, properties['products'])
+        if err:
+            return None, None, err
+    elif ('download/rupture.json' not in contents
+          or approach == 'use_finite_rup_from_usgs'):
         # happens for us6000f65h in parsers_test
-        rupdic = load_rupdic_from_finite_fault(
+        rupdic, err = load_rupdic_from_finite_fault(
             usgs_id, properties['mag'], properties['products'])
-    if not rupdic:
+        if err:
+            return None, None, err
+
+    if approach == 'build_rup_from_usgs':
+        rupdic['nodal_planes'], err = _get_nodal_planes(properties)
+        rupdic['msrs'] = list(get_available_magnitude_scalerel())
+        if err:
+            return None, rupdic, err
+
+    if not rupdic or approach == 'use_finite_rup_from_usgs':
         if not rup_data:
             with monitor('Downloading rupture json'):
                 rup_data, rupture_file = download_rupture_data(
                     usgs_id, contents, user)
         rupdic = convert_rup_data(rup_data, usgs_id, rupture_file, shakemap)
-
     if user.level == 2 and not station_data_file:
         with monitor('Downloading stations'):
             rupdic['station_data_file'], rupdic['station_data_issue'] = (

openquake/hazardlib/shakemap/validate.py

@@ -129,6 +129,8 @@ def get_oqparams(self, usgs_id, mosaic_models, trts, use_shakemap):
     'station_data_file_from_usgs': 'Station data from USGS',
     'station_data_file': 'Station data CSV',
     'maximum_distance_stations': 'Maximum distance of stations (km)',
+    'nodal_plane': 'Nodal plane',
+    'msr': 'Magnitude scaling relationship',
 }
 
 ARISTOTLE_FORM_PLACEHOLDERS = {
@@ -154,6 +156,8 @@ def get_oqparams(self, usgs_id, mosaic_models, trts, use_shakemap):
     'station_data_file_from_usgs': '',
     'station_data_file': 'Station data CSV',
     'maximum_distance_stations': 'float ≥ 0',
+    'nodal_plane': '',
+    'msr': '',
 }
 
 validators = {
@@ -256,14 +260,15 @@ def aristotle_validate(POST, user, rupture_file=None, station_data_file=None,
     if err:
         return None, dic, params, err
 
-    # NOTE: in level 1 interface there is no checkbox and the ShakeMap has to be used.
-    #       in level 2 interface the checkbox is unchecked by default
+    # NOTE: in level 1 interface the ShakeMap has to be used.
+    #       in level 2 interface it depends from the selected approach
     use_shakemap = user.level == 1
     if 'use_shakemap' in POST:
         use_shakemap = POST['use_shakemap'] == 'true'
+    approach = POST['approach']
 
     rup, rupdic, err = get_rup_dic(
-        dic['usgs_id'], user, use_shakemap, rupture_file, station_data_file, monitor)
+        dic, user, approach, use_shakemap, rupture_file, station_data_file, monitor)
     if err:
         return None, None, None, err
     # round floats

openquake/hazardlib/tests/shakemap/parsers_test.py

@@ -36,18 +36,25 @@ def setUp(cls):
     def test_1(self):
         # wrong usgs_id
         _rup, _rupdic, err = get_rup_dic(
-            'usp0001cc', User(level=2, testdir=''), use_shakemap=True)
+            {'usgs_id': 'usp0001cc'}, User(level=2, testdir=''),
+            'use_shakemap_from_usgs', use_shakemap=True)
         self.assertIn('Unable to download from https://earthquake.usgs.gov/fdsnws/'
                       'event/1/query?eventid=usp0001cc&', err['error_msg'])
 
     def test_2(self):
-        _rup, dic, _err = get_rup_dic('usp0001ccb', user=user, use_shakemap=True)
+        _rup, dic, _err = get_rup_dic(
+            {'usgs_id': 'usp0001ccb'}, user=user, approach='use_shakemap_from_usgs',
+            use_shakemap=True)
         self.assertIsNotNone(dic['shakemap_array'])
-        _rup, dic, _err = get_rup_dic('usp0001ccb', user=user, use_shakemap=False)
+        _rup, dic, _err = get_rup_dic(
+            {'usgs_id': 'usp0001ccb'}, user=user, approach='use_shakemap_from_usgs',
+            use_shakemap=False)
         self.assertIsNone(dic['shakemap_array'])
 
     def test_3(self):
-        _rup, dic, _err = get_rup_dic('us6000f65h', user=user, use_shakemap=True)
+        _rup, dic, _err = get_rup_dic(
+            {'usgs_id': 'us6000f65h'}, user=user, approach='use_shakemap_from_usgs',
+            use_shakemap=True)
         self.assertEqual(dic['lon'], -73.475)
         self.assertEqual(dic['lat'], 18.408)
         self.assertEqual(dic['dep'], 10.0)
@@ -65,22 +72,28 @@ def test_3(self):
 
     def test_4(self):
         # point_rup
-        _rup, dic, _err = get_rup_dic('us6000jllz', user=user, use_shakemap=True)
+        _rup, dic, _err = get_rup_dic(
+            {'usgs_id': 'us6000jllz'}, user=user, approach='use_shakemap_from_usgs',
+            use_shakemap=True)
         self.assertEqual(dic['lon'], 37.0143)
         self.assertEqual(dic['lat'], 37.2256)
         self.assertEqual(dic['dep'], 10.)
         self.assertEqual(dic['require_dip_strike'], True)
 
     def test_5(self):
         # 12 vertices instead of 4 in rupture.json
-        rup, dic, _err = get_rup_dic('us20002926', user=user, use_shakemap=True)
+        rup, dic, _err = get_rup_dic(
+            {'usgs_id': 'us20002926'}, user=user, approach='use_shakemap_from_usgs',
+            use_shakemap=True)
         self.assertIsNone(rup)
         self.assertEqual(dic['require_dip_strike'], True)
         self.assertEqual(dic['rupture_issue'],
                          'Unable to convert the rupture from the USGS format')
 
     def test_6(self):
-        rup, dic, _err = get_rup_dic('usp0001ccb', user=user, use_shakemap=True)
+        rup, dic, _err = get_rup_dic(
+            {'usgs_id': 'usp0001ccb'}, user=user, approach='use_shakemap_from_usgs',
+            use_shakemap=True)
         self.assertEqual(rup.mag, 6.7)
         self.assertEqual(dic['require_dip_strike'], False)
         self.assertEqual(dic['station_data_issue'],

openquake/hazardlib/tests/shakemap/validate_test.py

@@ -46,14 +46,14 @@ def setUp(cls):
 
     def test_1(self):
         # no rupture, yes stations
-        POST = {'usgs_id': 'us6000jllz'}
+        POST = {'usgs_id': 'us6000jllz', 'approach': 'use_shakemap_from_usgs'}
         _rup, rupdic, _params, err = aristotle_validate(POST, user)
         self.assertEqual(rupdic['require_dip_strike'], True)
         self.assertIn('stations', rupdic['station_data_file'])
         self.assertEqual(err, {})
 
     def test_2(self):
-        POST = {'usgs_id': 'us7000n05d'}
+        POST = {'usgs_id': 'us7000n05d', 'approach': 'use_shakemap_from_usgs'}
         _rup, rupdic, _params, err = aristotle_validate(POST, user)
         self.assertEqual(rupdic['rupture_from_usgs'], False)
         self.assertEqual(rupdic['require_dip_strike'], True)
@@ -81,7 +81,8 @@ def test_3(self):
             'time_event': 'day',
             'trt': 'active shallow crust normal',
             'truncation_level': '3',
-            'usgs_id': 'FromFile'}
+            'usgs_id': 'FromFile',
+            'approach': 'provide_rup'}
 
         for stations in (None, 'stationlist_seismic.csv'):
             _rup, rupdic, params, err = aristotle_validate(
@@ -126,7 +127,7 @@ def test_3(self):
 
     def test_4(self):
         # for us7000n7n8 the stations.json does not contain stations
-        POST = {'usgs_id': 'us7000n7n8'}
+        POST = {'usgs_id': 'us7000n7n8', 'approach': 'use_shakemap_from_usgs'}
         _rup, rupdic, _oqparams, err = aristotle_validate(POST, user)
         self.assertEqual(rupdic['require_dip_strike'], False)
         self.assertEqual(rupdic['mag'], 7.0)

openquake/hazardlib/valid.py

@@ -1507,4 +1507,3 @@ def fragmentno(src):
         return -1
     fragment = fragments[1].split('!')[0]  # strip !b16
     return int(fragment)
-

openquake/server/static/css/engine.css

@@ -462,3 +462,16 @@ table#aristotle-losses th td {
 .hidden_except_submit label {
   display: none;
 }
+
+.hidden {
+    display: none;
+}
+
+#aristotle_approach {
+  display: block;  /* each label in its own row */
+  margin-bottom: 20px; /* Space between radio options */
+}
+
+input[type="radio"] {
+  margin-right: 5px; /* Space between radio button and label text */
+}